Workspaces

sim workspaces is also spelled sim workspace.

Every command below also accepts the global options.

Cancel workspace access request

sim workspaces access-requests cancel <requestId>

Cancel Workspace Access Request (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Create workspace access request

sim workspaces access-requests create [options]

Create Workspace Access Request (OAuth login or personal API key required)

Options

Option	Required	Description
`--target <json\|@file>`	Yes	Target returned by Discover Workspace Access Requests or Discover Organization Access Requests. The target must currently be requestable. (JSON, or @path / @- to read a file or stdin).
`--reason <value>`	No	Why the acting user needs this access.

Discover workspace access requests

sim workspaces access-requests discover [options]

Discover Workspace Access Requests (OAuth login or personal API key required)

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the access item label.
`--target-kind <value>`	No	Category of access to discover. Accepted values: `feature`, `integration`, `provider`, `model`, `tool`, `knowledge_connector`, `file_share_auth`, `chat_deploy_auth`, `usage_limit`.
`--state <value>`	No	Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: `allowed`, `requestable`, `unavailable`.
`--sort-by <value>`	No	Field used to sort the result. Accepted values: `label`.
`--sort-order <value>`	No	Sort direction. Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

List my workspace access requests

sim workspaces access-requests mine [options]

List My Workspace Access Requests (OAuth login or personal API key required)

Options

Option	Required	Description
`--status <value>`	No	Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`.
`--sort-by <value>`	No	Field used to sort the result. Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

Create workspace invitations

sim workspaces invitations create [options]

Create Workspace Invitations (OAuth login or personal API key required)

Options

Option	Required	Description
`--emails <value...>`	Yes	Email addresses to invite. Each address is processed separately; inspect failed for unsuccessful recipients. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--permission <value>`	No	Workspace permission to grant. Existing workspace access is preserved. Accepted values: `admin`, `write`, `read`.
`--membership <value>`	No	Organization membership: member or admin uses a seat when billing is enabled. External grants workspace access only and requires an eligible paid account when billing is enabled. Existing members of another organization remain external. Accepted values: `member`, `admin`, `external`.

Fork workspace

sim 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

sim workspaces get

Get workspace fork availability

sim workspaces fork-availability

Get Workspace Fork Availability (OAuth login or personal API key required)

Get workspace fork lineage

sim workspaces lineage

Get Workspace Fork Lineage (OAuth login or personal API key required)

Get workspace fork mappings

sim 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

sim 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

sim workspaces operations get <operationId>

Arguments

Argument	Required	Description
`operationId`	Yes	Durable operation identifier to use for polling.

List workspace operations

sim 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

sim 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).

Get workspace permission config

sim workspaces permission-config

Get Workspace Permission Config (OAuth login or personal API key required)

List workspace fork children

sim 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

sim 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

sim workspaces members [options]

Options

Option	Required	Description
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

List workspaces

sim 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

sim 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

sim 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

sim 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

sim 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

sim 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

sim 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

sim 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

sim 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`.

Workspaces

On this page