​

workspace

orc workspace は、CLIで選択中のWorkspaceを確認し、現在のディレクトリへのリンクや将来のコマンドで使う既定Workspaceを保存するコマンドです。Workspaceの作成やサーバー上の変更は行いません。

API操作は orc workspaces を参照してください。ローカルで対象を選んでも、そのWorkspaceへのアクセス権が追加されるわけではありません。

選択中のWorkspaceと選択元を確認します。

選択したWorkspaceの id と選択元 source を返します。未選択の場合は id: null、source: none と選択方法の案内を返します。

Workspace IDを現在のディレクトリの .orchestor/workspace.json に保存します。IDを省略すると現在解決されるWorkspaceを使います。対象がない場合は検証エラーです。保存結果は workspaceId と path です。

現在のディレクトリの .orchestor/workspace.json を削除します。ファイルがなかった場合も結果を返し、unlinked は実際にファイルがあったかを示します。グローバルの既定Workspaceは削除しません。

必須のIDをローカル設定の defaultWorkspace として保存します。結果は defaultWorkspace と configPath です。現在のディレクトリのリンクや環境変数があれば、その指定が既定値より優先されます。

List workspaces

Include archived workspaces in the response.; enum: true|false

型: string。任意。

Include brand, monitoring configuration, and production prompt entitlement summaries for accessible workspaces.; enum: true|false

型: string。任意。

Create workspace

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) Workspace display name after trimming surrounding whitespace. Must contain 1 to 120 characters.; max 120 chars

型: string。任意。

Preferred workspace URL slug. Omit or send an empty string to derive it from name. The server normalizes to lowercase letters, digits and hyphens and resolves conflicts within the organization.

型: string。任意。

Workspace type. Omission creates a team workspace.; enum: personal|team

型: string。任意。

Optional client-facing label. Surrounding whitespace is removed; omitted, null or empty values store no label.; (use "null" or "reset" to clear)

型: string。任意。

Commercial workspace purpose, defaulting to client in the extended flow. Supplying this field selects extended creation. pitch requires an agency organization and consumes monthly and active pitch quotas.; enum: client|pitch

型: string。任意。

Creation stopping point. A supplied owned brand is initialized active in every mode; no separate brand activation is required. Brand readiness does not start measurement. empty skips setup generation and measurement; brand is optional. suggestions generates review candidates without starting measurement. measure generates and measures. Omission uses measure if any extended setup field is present; otherwise creation is empty. Pitch quotas and seven-day expiry begin at creation in every mode.; enum: empty|suggestions|measure

型: string。任意。

Managed brand to initialize. Required for suggestions and measure. Optional for empty; when provided, both name and domain are required. Supplying brand without setup_mode starts the measure flow.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Two-letter default observation country code. Trimmed and uppercased. Defaults to JP in the extended flow. Supplying this field selects extended creation even without setup_mode.

型: string。任意。

Default observation language code, optionally with a regional suffix. Trimmed and lowercased, for example ja or en-us. Defaults to ja in the extended flow. Supplying this field selects extended creation even without setup_mode.

型: string。任意。

Get workspace

Update workspace

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Set this workspace as the organization default. Must be true and the only field in the body. Requires a human organization owner or admin; machine credentials cannot perform this change.; enum: true

型: string。任意。

Replacement workspace display name. Omit to retain the current value.; max 120 chars

型: string。任意。

Replacement preferred slug. Normalized and made unique within the organization. Omit to retain the current slug.

型: string。任意。

Replacement client-facing label. Omit to retain it; null or an empty string clears it. Nonempty strings are trimmed.; (use "null" or "reset" to clear)

型: string。任意。

Workspace visual identity color. Omit to retain the current token.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: string。任意。

Workspace visual identity rendering mode. Omit to retain the current mode. Set the corresponding icon, emoji or image value separately when needed.; enum: color|initial|icon|emoji|image

型: string。任意。

Icon identifier used by icon identity mode. Omit to retain it; null or an empty string clears it. Does not change identity_kind.; (use "null" or "reset" to clear); max 64 chars

型: string。任意。

Emoji value used by emoji identity mode. Omit to retain it; null or an empty string clears it. Does not change identity_kind.; (use "null" or "reset" to clear); max 32 chars

型: string。任意。

File ID used by image identity mode. Omit to retain it; null or an empty string clears it. Does not change identity_kind.; (use "null" or "reset" to clear)

型: string。任意。

Set client to convert an unarchived pitch workspace. Submit only purpose and optional dry_run. The conversion is irreversible. A request to convert to pitch is rejected.; enum: client|pitch

型: string。任意。

Archive workspace

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Restore workspace

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

現在のディレクトリへリンクします。

既定Workspaceを設定します。

ディレクトリのリンクを解除します。

対象は --workspace、ORCHESTOR_WORKSPACE_ID、現在のディレクトリの .orchestor/workspace.json、グローバル設定の defaultWorkspace の順に選びます。期待と異なる場合は current の source と、優先される指定を確認してください。

link と use はローカル選択の保存です。認証や所属はサーバーへの操作時に確認されます。

orc workspace では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。