CLI を使い始める

​
projects

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

​
コマンド一覧

  • orc projects list — List projects
  • orc projects create — Create project
  • orc projects get — Get project
  • orc projects update — Update project
  • orc projects restore — Restore an archived project
  • orc projects archive — Archive project
  • orc projects rollup get — Get Project progress rollup

​
orc projects list

List projects

​
構文

orc projects list [flags]

​
フラグ

フラグ型必須説明
--workspace-idstringいいえFilter by workspace ID (for multi-workspace users).
--include-archivedstringいいえInclude archived projects in the response.; enum: true|false
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

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

​
互換エイリアス

  • orc project list

​
ヘルプ

orc projects list --help

​
orc projects create

Create project

​
構文

orc projects 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.
--project-keystringいいえ(required) URL-safe project identifier (must be unique within workspace).
--namestringいいえ(required) Display name.
--descriptionstringいいえOptional description.
--workspace-idstringいいえWorkspace to create the project in (defaults to current).
--initiative-idstringいいえOptional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)
--milestonestringいいえBody field: milestone; (JSON object, e.g. '{"custom_id":"x"}')
--display-ordernumberいいえSort order in project lists.
--color-tokenstringいいえVisual identity color token (Q2.CQ shared design tokens).; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red
--identity-kindstringいいえWhich kind of visual identity this project uses.; enum: color|initial|icon|emoji|image
--icon-tokenstringいいえIcon token reference (when identity_kind=icon).; (use "null" or "reset" to clear); max 64 chars
--emojistringいいえEmoji glyph (when identity_kind=emoji).; (use "null" or "reset" to clear); max 32 chars
--image-file-idstringいいえReference to uploaded image file (when identity_kind=image).; (use "null" or "reset" to clear)

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

​
互換エイリアス

  • orc project create

​
ヘルプ

orc projects create --help

​
orc projects get

Get project

​
構文

orc projects get <key> [flags]

​
引数

引数必須説明
keyはいProject key (URL-safe identifier).

​
フラグ

フラグ型必須説明
--workspace-idstringいいえWorkspace context for the project key (required for organization-scoped credentials).

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

​
互換エイリアス

  • orc project get

​
ヘルプ

orc projects get --help

​
orc projects update

Update project

​
構文

orc projects update <key> [flags]

​
引数

引数必須説明
keyはいProject key (URL-safe identifier).

​
フラグ

フラグ型必須説明
--workspace-idstringいいえWorkspace context override (rare; defaults to current).
--namestringいいえProject display name.
--descriptionstringいいえProject description.
--display-ordernumberいいえSort order in project lists.
--visibilitystringいいえworkspace — visible to all workspace members. private — visible only to project members.; enum: workspace|private
--color-tokenstringいいえVisual identity color token (Q2.CQ).; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red
--identity-kindstringいいえWhich kind of visual identity this project uses.; enum: color|initial|icon|emoji|image
--icon-tokenstringいいえBody field: icon_token; (use "null" or "reset" to clear); max 64 chars
--emojistringいいえBody field: emoji; (use "null" or "reset" to clear); max 32 chars
--image-file-idstringいいえBody field: image_file_id; (use "null" or "reset" to clear)
--initiative-idstringいいえOptional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)
--milestonestringいいえBody field: milestone; (JSON object, e.g. '{"custom_id":"x"}')

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

​
互換エイリアス

  • orc project update

​
ヘルプ

orc projects update --help

​
orc projects restore

Restore an archived project

​
構文

orc projects restore <key> [flags]

​
引数

引数必須説明
keyはいProject key (URL-safe identifier).

​
フラグ

フラグ型必須説明
--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.

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

​
ヘルプ

orc projects restore --help

​
orc projects archive

Archive project

​
構文

orc projects archive <key> [flags]

​
引数

引数必須説明
keyはいProject key (URL-safe identifier).

​
フラグ

フラグ型必須説明
--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.
--workspace-idstringいいえWorkspace containing the project to archive (required for organization-scoped credentials).

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

​
互換エイリアス

  • orc project archive

​
ヘルプ

orc projects archive --help

​
orc projects rollup get

Get Project progress rollup

​
構文

orc projects rollup get <id> [flags]

​
引数

引数必須説明
idはいProject ID or existing Project key.

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

​
ヘルプ

orc projects rollup get --help