CLI を使い始める

initiatives

@orchestor-inc/cli のコマンドリファレンスです。

コマンド一覧

  • orc initiatives list — List workspace initiatives
  • orc initiatives create — Create a workspace initiative
  • orc initiatives get — Get an initiative
  • orc initiatives update — Update an initiative
  • orc initiatives delete — Soft-delete an Initiative
  • orc initiatives rollup get — Get initiative progress rollup
  • orc initiatives projects list — List Initiative Projects
  • orc initiatives projects create — Add a Project to an Initiative
  • orc initiatives projects update — Reorder an Initiative Project
  • orc initiatives projects delete — Remove a Project from an Initiative
  • orc initiatives activity list — List Initiative activity
  • orc initiatives comments list — List Initiative comments
  • orc initiatives comments create — Comment on an Initiative
  • orc initiatives favorites enable — Favorite an Initiative
  • orc initiatives favorites disable — Unfavorite an Initiative
  • orc initiatives restore — Restore an Initiative
  • orc initiatives subscriptions enable — Subscribe to an Initiative
  • orc initiatives subscriptions disable — Unsubscribe from an Initiative
  • orc initiatives updates list — List Initiative Updates
  • orc initiatives updates create — Post an Initiative Update
  • orc initiatives batch update — Batch update Initiatives

orc initiatives list

List workspace initiatives

構文

orc initiatives list [flags]

フラグ

フラグ型必須説明
--tabstringいいえenum: active|planned|all
--statusstringいいえenum: proposed|planned|active|completed|canceled
--sortstringいいえenum: created_at|target_date|manual
--orderstringいいえenum: asc|desc
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives list --help

orc initiatives create

Create a workspace initiative

構文

orc initiatives create [flags]

フラグ

フラグ型必須説明
--idempotency-keystringいいえUnique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier.
--colorstringいいえBody field: color; max 100 chars
--descriptionstringいいえBody field: description; max 2000 chars
--iconstringいいえBody field: icon; max 100 chars
--labelsstringいいえBody field: labels; csv
--namestringいいえ(required) Body field: name; max 200 chars
--owner-idstringいいえBody field: owner_id
--prioritystringいいえBody field: priority; enum: urgent|high|medium|low|
--statusstringいいえBody field: status; enum: proposed|planned|active|completed|canceled
--target-datestringいいえBody field: target_date
--target-precisionstringいいえBody field: target_precision; enum: day|month|quarter|half_year|year|

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives create --help

orc initiatives get

Get an initiative

構文

orc initiatives get <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives get --help

orc initiatives update

Update an initiative

構文

orc initiatives update <id> [flags]

引数

引数必須説明
idはいInitiative ID.

フラグ

フラグ型必須説明
--colorstringいいえBody field: color; max 100 chars
--descriptionstringいいえBody field: description; max 2000 chars
--iconstringいいえBody field: icon; max 100 chars
--labelsstringいいえBody field: labels; csv
--namestringいいえBody field: name; max 200 chars
--owner-idstringいいえBody field: owner_id
--prioritystringいいえBody field: priority; enum: urgent|high|medium|low|
--rankstringいいえBody field: rank; max 100 chars
--statusstringいいえBody field: status; enum: proposed|planned|active|completed|canceled
--target-datestringいいえBody field: target_date
--target-precisionstringいいえBody field: target_precision; enum: day|month|quarter|half_year|year|
--versionnumberいいえ(required) Body field: version

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives update --help

orc initiatives delete

Soft-delete an Initiative

構文

orc initiatives delete <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative delete

ヘルプ

orc initiatives delete --help

orc initiatives rollup get

Get initiative progress rollup

構文

orc initiatives rollup get <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives rollup get --help

orc initiatives projects list

List Initiative Projects

構文

orc initiatives projects list <id> [flags]

引数

引数必須説明
idはいInitiative ID.

フラグ

フラグ型必須説明
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives projects list --help

orc initiatives projects create

Add a Project to an Initiative

構文

orc initiatives projects create <id> [flags]

引数

引数必須説明
idはいInitiative ID.

フラグ

フラグ型必須説明
--project-idstringいいえ(required) Body field: project_id
--ranknumberいいえBody field: rank

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiatives projects add

ヘルプ

orc initiatives projects create --help

orc initiatives projects update

Reorder an Initiative Project

構文

orc initiatives projects update <id> <project-id> [flags]

引数

引数必須説明
idはいInitiative ID.
project-idはいProject ID.

フラグ

フラグ型必須説明
--ranknumberいいえ(required) Body field: rank

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiatives projects reorder

ヘルプ

orc initiatives projects update --help

orc initiatives projects delete

Remove a Project from an Initiative

構文

orc initiatives projects delete <id> <project-id> [flags]

引数

引数必須説明
idはいInitiative ID.
project-idはいProject ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiatives projects remove

ヘルプ

orc initiatives projects delete --help

orc initiatives activity list

List Initiative activity

構文

orc initiatives activity list <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative activity

ヘルプ

orc initiatives activity list --help

orc initiatives comments list

List Initiative comments

構文

orc initiatives comments list <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative comments

ヘルプ

orc initiatives comments list --help

orc initiatives comments create

Comment on an Initiative

構文

orc initiatives comments create <id> [flags]

引数

引数必須説明
idはいInitiative ID.

フラグ

フラグ型必須説明
--bodystringいいえ(required) Body field: body; max 10000 chars
--parent-idstringいいえBody field: parent_id; max 500 chars

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative comment

ヘルプ

orc initiatives comments create --help

orc initiatives favorites enable

Favorite an Initiative

構文

orc initiatives favorites enable <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative favorite

ヘルプ

orc initiatives favorites enable --help

orc initiatives favorites disable

Unfavorite an Initiative

構文

orc initiatives favorites disable <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative unfavorite

ヘルプ

orc initiatives favorites disable --help

orc initiatives restore

Restore an Initiative

構文

orc initiatives restore <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative restore

ヘルプ

orc initiatives restore --help

orc initiatives subscriptions enable

Subscribe to an Initiative

構文

orc initiatives subscriptions enable <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative subscribe

ヘルプ

orc initiatives subscriptions enable --help

orc initiatives subscriptions disable

Unsubscribe from an Initiative

構文

orc initiatives subscriptions disable <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative unsubscribe

ヘルプ

orc initiatives subscriptions disable --help

orc initiatives updates list

List Initiative Updates

構文

orc initiatives updates list <id> [flags]

引数

引数必須説明
idはいInitiative ID.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative updates

ヘルプ

orc initiatives updates list --help

orc initiatives updates create

Post an Initiative Update

構文

orc initiatives updates create <id> [flags]

引数

引数必須説明
idはいInitiative ID.

フラグ

フラグ型必須説明
--bodystringいいえ(required) Body field: body; max 10000 chars
--healthstringいいえ(required) Body field: health; enum: on_track|at_risk|off_track

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc initiative update

ヘルプ

orc initiatives updates create --help

orc initiatives batch update

Batch update Initiatives

構文

orc initiatives batch update [flags]

フラグ

フラグ型必須説明
--idempotency-keystringいいえUnique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier.
--itemsstringいいえ(required) Body field: items; JSON array of objects (use --stdin for large resources)

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc initiatives batch update --help