studio workspaces is also spelled studio workspace.
Every command below also accepts the global options.
Fork workspace
studio workspaces fork [options]Fork Workspace (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Display name of the workflow or workspace. |
--copy <json|@file> | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). |
--request-id <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | Yes | Fingerprint of the reviewed preview and its choices. |
--wait | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. |
--wait-timeout <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
Get workspace
studio workspaces getGet workspace fork availability
studio workspaces fork-availabilityGet Workspace Fork Availability (OAuth login or personal API key required)
Get workspace fork lineage
studio workspaces lineageGet Workspace Fork Lineage (OAuth login or personal API key required)
Get workspace fork mappings
studio workspaces mappings get [options]Get Workspace Fork Mappings (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--direction <value> | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: id. |
--sort-order <value> | No | Sort direction. Accepted values: asc. |
Update workspace fork mappings
studio workspaces mappings update [options]Update Workspace Fork Mappings (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--direction <value> | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull. |
--mappings <json|@file> | Yes | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
Get workspace operation
studio workspaces operations get <operationId>Arguments
| Argument | Required | Description |
|---|---|---|
operationId | Yes | Durable operation identifier to use for polling. |
List workspace operations
studio workspaces operations list [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--request-id <value> | No | Stable client request ID for reconciliation and identical retries. |
Wait for copy and deployment readiness; exit 3 for configuration, 1 for failure, or 4 for timeout
studio workspaces operations wait <operationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
operationId | Yes | Operation ID returned by import, fork, push, or pull |
Options
| Option | Required | Description |
|---|---|---|
--wait-timeout <seconds> | No | Maximum total wait (default 3600; 0 waits indefinitely). |
List workspace fork children
studio workspaces children [options]List Workspace Fork Children (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: createdAt. |
--sort-order <value> | No | Sort direction. Accepted values: desc. |
List workspace fork resources
studio workspaces fork-resources [options]List Workspace Fork Resources (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--kind <value> | Yes | Resource or operation kind. Accepted values: files, tables, knowledgeBases, customTools, skills, mcpServers, workflowMcpServers. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: id. |
--sort-order <value> | No | Sort direction. Accepted values: asc. |
List workspace members
studio workspaces members [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
List workspaces
studio workspaces list [options]Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
Preview workspace fork
studio workspaces fork-preview [options]Preview Workspace Fork (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Display name of the workflow or workspace. |
--copy <json|@file> | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). |
Preview workspace pull
studio workspaces pull-preview [options]Preview Workspace Pull (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). |
--trigger-mappings <json|@file> | No | Public trigger path choices from preview.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). |
Preview workspace push
studio workspaces push-preview [options]Preview Workspace Push (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). |
--trigger-mappings <json|@file> | No | Public trigger path choices from preview.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). |
Pull workspace
studio workspaces pull [options]Pull Workspace (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). |
--trigger-mappings <json|@file> | No | Public trigger path choices from preview.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). |
--request-id <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | Yes | Fingerprint of the reviewed preview and its choices. |
--wait | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. |
--wait-timeout <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
-y, --yes | Yes | Confirm this operation. |
Push workspace
studio workspaces push [options]Push Workspace (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). |
--trigger-mappings <json|@file> | No | Public trigger path choices from preview.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). |
--request-id <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | Yes | Fingerprint of the reviewed preview and its choices. |
--wait | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. |
--wait-timeout <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
-y, --yes | Yes | Confirm this operation. |
Rollback workspace fork
studio workspaces fork-rollback [options]Rollback Workspace Fork (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
-y, --yes | Yes | Confirm this operation. |
Unlink workspace fork
studio workspaces unlink [options]Unlink Workspace Fork (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
-y, --yes | Yes | Confirm this operation. |
Update workspace fork exclusions
studio workspaces sync-exclusions [options]Update Workspace Fork Exclusions (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | Yes | Workflow identifiers in the current workspace. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--fork-sync-excluded <true|false> | Yes | Whether the named workflows should be skipped as sync sources and targets. Accepted values: true, false. |