​

workspace

orc workspace inspects the selected Workspace and saves a link for the current directory or a default for future commands. It does not create Workspaces or change their server-side settings.

See orc workspaces for API operations. Selecting a Workspace locally does not grant access to it.

Inspect the selected Workspace and its source.

Returns the selected id and its source. When unconfigured, returns id: null, source: none, and guidance for selecting a Workspace.

Saves a Workspace ID in .orchestor/workspace.json in the current directory. If ID is omitted, uses the currently resolved Workspace. No available target is a validation error. Returns workspaceId and path.

Removes .orchestor/workspace.json from the current directory. Returns a result even if the file did not exist; unlinked indicates whether it existed. Does not remove the global default Workspace.

Saves the required ID as local configuration defaultWorkspace. Returns defaultWorkspace and configPath. A directory link or environment variable takes precedence over this default.

List workspaces

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

Type: string. Optional.

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

Type: string. Optional.

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.

Type: string. Optional.

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

Type: string. Optional.

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.

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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"}')

Type: string. Optional.

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.

Type: string. Optional.

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.

Type: string. Optional.

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.

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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)

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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)

Type: string. Optional.

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

Type: string. Optional.

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.

Type: string. Optional.

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.

Type: string. Optional.

Link the current directory.

Set the default Workspace.

Remove the directory link.

Selection uses --workspace, ORCHESTOR_WORKSPACE_ID, .orchestor/workspace.json in the current directory, then global defaultWorkspace. If the target is unexpected, check current output source and higher-priority settings.

link and use save local selection. The server checks authentication and membership when an operation is performed.

The following global options can be used with orc workspace:

For details and examples, see global options.