Skip to content
Try for free
On this page

Commands

Workspaces

Read workspace access and manage reviewed fork, push, and pull operations.

sim workspaces is also spelled sim workspace.

These commands accept the global options.

Workspace access

List workspaces

Code
sim workspaces list [options]

Options

OptionRequiredDescription
--sort-by <value>NoField used to sort the result. Do not rely on case-insensitive ordering when sorting by name. Defaults to "createdAt". Accepted values: name, createdAt, updatedAt.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listWorkspaces.

Get workspace

Code
sim workspaces get

API request and response schemas: getWorkspace.

List workspace members

Code
sim workspaces members [options]

Options

OptionRequiredDescription
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listWorkspaceMembers.

Create workspace invitations

OAuth login or personal API key required.

Code
sim workspaces invitations create [options]

Options

OptionRequiredDescription
--emails <value...>YesEmail 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>NoWorkspace permission to grant. Existing workspace access is preserved. Defaults to "read". Accepted values: admin, write, read.
--membership <value>NoOrganization 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. Defaults to "member". Accepted values: member, admin, external.

API request and response schemas: createWorkspaceInvitations.

Get workspace permission config

OAuth login or personal API key required.

Code
sim workspaces permission-config

API request and response schemas: getWorkspacePermissionConfig.

Access requests

Discover workspace access requests

OAuth login or personal API key required.

Code
sim workspaces access-requests discover [options]

Options

OptionRequiredDescription
--search <value>NoCase-insensitive substring match against the access item label.
--target-kind <value>NoCategory of access to discover. Accepted values: feature, integration, provider, model, tool, knowledge_connector, file_share_auth, chat_deploy_auth, usage_limit.
--state <value>NoFilter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: allowed, requestable, unavailable.
--sort-by <value>NoField used to sort the result. Defaults to "label". Accepted values: label.
--sort-order <value>NoSort direction. Defaults to "asc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.

API request and response schemas: discoverWorkspaceAccessRequests.

Create workspace access request

OAuth login or personal API key required.

Code
sim workspaces access-requests create [options]

Options

OptionRequiredDescription
--target <json|@file>YesTarget 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>NoWhy the acting user needs this access. Defaults to "".

API request and response schemas: createWorkspaceAccessRequest.

List my workspace access requests

OAuth login or personal API key required.

Code
sim workspaces access-requests mine [options]

Options

OptionRequiredDescription
--status <value>NoFilter by request status; omit to include all statuses. Accepted values: pending, fulfilled, declined, cancelled, closed.
--sort-by <value>NoField used to sort the result. Defaults to "createdAt". Accepted values: createdAt, targetLabel.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.

API request and response schemas: listMyWorkspaceAccessRequests.

Cancel workspace access request

OAuth login or personal API key required.

Code
sim workspaces access-requests cancel <requestId>

Arguments

ArgumentRequiredDescription
requestIdYesAccess request identifier.

API request and response schemas: cancelWorkspaceAccessRequest.

Forks and lineage

Get workspace fork availability

OAuth login or personal API key required.

Code
sim workspaces fork-availability

API request and response schemas: getWorkspaceForkAvailability.

List workspace fork resources

OAuth login or personal API key required.

Code
sim workspaces fork-resources [options]

Options

OptionRequiredDescription
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.
--kind <value>YesKind of source resource to list for copy selection. Accepted values: files, tables, knowledgeBases, customTools, skills, mcpServers, workflowMcpServers.
--sort-by <value>NoSupported stable sort key for this collection. Defaults to "id". Accepted values: id.
--sort-order <value>NoSort direction. Defaults to "asc". Accepted values: asc.

API request and response schemas: listWorkspaceForkResources.

Preview workspace fork

OAuth login or personal API key required.

Code
sim workspaces fork-preview [options]

Options

OptionRequiredDescription
--name <value>NoDisplay name of the workflow or workspace.
--copy <json|@file>NoExplicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: previewWorkspaceFork.

Fork workspace

OAuth login or personal API key required.

Code
sim workspaces fork [options]

Options

OptionRequiredDescription
--name <value>NoDisplay name of the workflow or workspace.
--copy <json|@file>NoExplicit 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>YesStable client request ID. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
--preview-fingerprint <value>YesFingerprint returned by a preview with the same choices. A changed plan returns 409; preview again. The example hash is illustrative; use the actual preview value.
--waitNoWait for the committed operation to finish; missing configuration and failure exit nonzero.
--wait-timeout <seconds>NoMaximum operation wait in seconds (default 3600; 0 waits indefinitely).

API request and response schemas: forkWorkspace.

Get workspace fork lineage

OAuth login or personal API key required.

Code
sim workspaces lineage

API request and response schemas: getWorkspaceForkLineage.

List workspace fork children

OAuth login or personal API key required.

Code
sim workspaces children [options]

Options

OptionRequiredDescription
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.
--sort-by <value>NoSupported stable sort key for this collection. Defaults to "createdAt". Accepted values: createdAt.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: desc.

API request and response schemas: listWorkspaceForkChildren.

Mappings

Get workspace fork mappings

OAuth login or personal API key required.

Code
sim workspaces mappings get [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--direction <value>YesPush means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.
--sort-by <value>NoSupported stable sort key for this collection. Defaults to "id". Accepted values: id.
--sort-order <value>NoSort direction. Defaults to "asc". Accepted values: asc.

API request and response schemas: getWorkspaceForkMappings.

Update workspace fork mappings

OAuth login or personal API key required.

Code
sim workspaces mappings update [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--direction <value>YesPush means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull.
--mappings <json|@file>YesMapping entries addressed by resource type and sourceId. targetId: null clears a mapping. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: updateWorkspaceForkMappings.

Push and pull

Preview workspace push

OAuth login or personal API key required.

Code
sim workspaces push-preview [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--mappings <json|@file>NoProposed mapping entries addressed by resource type and sourceId. Preview does not save them; apply commits them with the sync. (JSON, or @path / @- to read a file or stdin).
--dependent-values <json|@file>NoDestination-specific choices addressed by source workflow ID, source block ID, and field key. Omission keeps saved overrides; an explicit empty array clears them. (JSON, or @path / @- to read a file or stdin).
--copy-resources <json|@file>NoExplicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin).
--drop-references <json|@file>NoSource-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>NoPublic 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).

API request and response schemas: previewWorkspacePush.

Push workspace

OAuth login or personal API key required.

This replaces target workflows and may archive targets whose sources were deleted.

Code
sim workspaces push [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--mappings <json|@file>NoProposed mapping entries addressed by resource type and sourceId. Preview does not save them; apply commits them with the sync. (JSON, or @path / @- to read a file or stdin).
--dependent-values <json|@file>NoDestination-specific choices addressed by source workflow ID, source block ID, and field key. Omission keeps saved overrides; an explicit empty array clears them. (JSON, or @path / @- to read a file or stdin).
--copy-resources <json|@file>NoExplicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin).
--drop-references <json|@file>NoSource-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>NoPublic 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>YesStable client request ID. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
--preview-fingerprint <value>YesFingerprint returned by a preview with the same choices. A changed plan returns 409; preview again. The example hash is illustrative; use the actual preview value.
--waitNoWait for the committed operation to finish; missing configuration and failure exit nonzero.
--wait-timeout <seconds>NoMaximum operation wait in seconds (default 3600; 0 waits indefinitely).
-y, --yesYesConfirm this operation.

API request and response schemas: pushWorkspace.

Preview workspace pull

OAuth login or personal API key required.

Code
sim workspaces pull-preview [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--mappings <json|@file>NoProposed mapping entries addressed by resource type and sourceId. Preview does not save them; apply commits them with the sync. (JSON, or @path / @- to read a file or stdin).
--dependent-values <json|@file>NoDestination-specific choices addressed by source workflow ID, source block ID, and field key. Omission keeps saved overrides; an explicit empty array clears them. (JSON, or @path / @- to read a file or stdin).
--copy-resources <json|@file>NoExplicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin).
--drop-references <json|@file>NoSource-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>NoPublic 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).

API request and response schemas: previewWorkspacePull.

Pull workspace

OAuth login or personal API key required.

This replaces target workflows and may archive targets whose sources were deleted.

Code
sim workspaces pull [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
--mappings <json|@file>NoProposed mapping entries addressed by resource type and sourceId. Preview does not save them; apply commits them with the sync. (JSON, or @path / @- to read a file or stdin).
--dependent-values <json|@file>NoDestination-specific choices addressed by source workflow ID, source block ID, and field key. Omission keeps saved overrides; an explicit empty array clears them. (JSON, or @path / @- to read a file or stdin).
--copy-resources <json|@file>NoExplicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin).
--drop-references <json|@file>NoSource-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>NoPublic 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>YesStable client request ID. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
--preview-fingerprint <value>YesFingerprint returned by a preview with the same choices. A changed plan returns 409; preview again. The example hash is illustrative; use the actual preview value.
--waitNoWait for the committed operation to finish; missing configuration and failure exit nonzero.
--wait-timeout <seconds>NoMaximum operation wait in seconds (default 3600; 0 waits indefinitely).
-y, --yesYesConfirm this operation.

API request and response schemas: pullWorkspace.

Operation status

List workspace operations

Code
sim workspaces operations list [options]

Options

OptionRequiredDescription
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.
--cursor <value>NoContinue from nextCursor returned by a previous result.
--request-id <value>NoFind an uncertain mutation by the original client request ID; keep the same filter while paging.

API request and response schemas: listWorkspaceOperations.

Get workspace operation

Code
sim workspaces operations get <operationId>

Arguments

ArgumentRequiredDescription
operationIdYesDurable operation identifier to use for polling.

API request and response schemas: getWorkspaceOperation.

Wait for workspace copy and deployment readiness

Code
sim workspaces operations wait <operationId> [options]

Arguments

ArgumentRequiredDescription
operationIdYesOperation ID returned by import, fork, push, or pull

Options

OptionRequiredDescription
--wait-timeout <seconds>NoMaximum total wait (default 3600; 0 waits indefinitely).

Exit codes: 0 completed (including completion with warnings), 1 follow-up work failed, 3 destination configuration is required, 4 timed out. The mutation may already be committed; reconcile using the same operation or request ID rather than repeating it with a new ID.

API request and response schemas: getWorkspaceOperation.

Exclusions and recovery

Update workspace fork exclusions

OAuth login or personal API key required.

Code
sim workspaces sync-exclusions [options]

Options

OptionRequiredDescription
--workflow <value...>YesWorkflow identifiers in the current workspace. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
--fork-sync-excluded <true|false>YesWhether the named workflows should be skipped as sync sources and targets. Accepted values: true, false.

API request and response schemas: updateWorkspaceForkExclusions.

Rollback workspace fork

OAuth login or personal API key required.

This restores the latest sync using its prior deployed versions.

Code
sim workspaces fork-rollback [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
-y, --yesYesConfirm this operation.

API request and response schemas: rollbackWorkspaceFork.

Unlink workspace fork

OAuth login or personal API key required.

This removes the fork relationship and its persisted mappings.

Code
sim workspaces unlink [options]

Options

OptionRequiredDescription
--other-workspace-id <value>YesWorkspace on the other side of the direct fork edge.
-y, --yesYesConfirm this operation.

API request and response schemas: unlinkWorkspaceFork.

Related docs

Was this helpful?
Suggest an edit