Complete reference

Every command on one page, generated from the CLI itself. Start at the overview to browse; this page is for searching and for tools.

Append .mdx to an authored guide or CLI reference page for its raw Markdown — /cli/reference.mdx is this page as plain text. The docs are also published as /llms.txt and /llms-full.txt.

Global options

Place these options before or after the command. Each command uses the settings relevant to its action. Telemetry commands always print text; workflow export prints a portable JSON document, or YAML when selected.

Option	Description
`-P, --profile <name>`	Profile to use (env: SIM_PROFILE).
`--endpoint <url>`	Sim deployment to talk to (env: SIM_ENDPOINT).
`-w, --workspace <id>`	Workspace to target (env: SIM_WORKSPACE).
`--output <format>`	Output format for this command. Accepted values: `table`, `json`, `yaml`, `text`.

Use --help to inspect a command. sim --version prints the CLI version, takes no value, and exits without running a command. Deployment-version commands use their documented arguments or --to-version.

API schema links describe HTTP payloads. See CLI output formats for resource unwrapping, pagination envelopes, and display formats.

Code

sim login [options]

Options

Option	Required	Description
`--method <method>`	No	Credential to obtain: oauth requires OAuth support; api-key creates a permanent key through pairing (auto-selects when omitted). Accepted values: `oauth`, `api-key`.
`--no-browser`	No	Print the approval URL without opening it (either login method).
`--read-only`	No	Ask only for permission to read, never to change anything.
`--callback-port <port>`	No	Pin the local port the browser returns to.
`-y, --yes`	No	Overwrite an existing API-key profile without prompting.

sim logout

Sign out and remove the profile's stored login

Code

sim logout [options]

Options

Option	Required	Description
`--all`	No	Remove the profile entirely, including its settings.

sim whoami

Show the resolved profile, where each setting came from, and whether it works

Code

sim whoami [options]

Options

Option	Required	Description
`--no-verify`	No	Skip the API check and only print the resolved settings.

API request and response schemas: getMeta, getWorkspace.

sim configure

Switch a profile's default workspace, or set its endpoint or output format

Code

sim configure [options]

Options

Option	Required	Description
`--set-endpoint <url>`	No	Sim deployment to talk to.
`--set-workspace <id>`	No	Default workspace for workspace-scoped commands.
`--set-output <format>`	No	Default output format (table \| json \| yaml \| text).
`--unset <key...>`	No	Remove settings (endpoint, workspace, output).

sim update

Update this global CLI installation to the newest release on its channel

Code

sim update [options]

Options

Option	Required	Description
`--package-manager <manager>`	No	Package manager that installed this copy. Accepted values: `npm`, `pnpm`, `bun`, `yarn`.

sim chat

Ask Sim and print the reply

Code

sim chat <message> [options]

Arguments

Argument	Required	Description
`message`	Yes	What to ask Sim

Options

Option	Required	Description
`-c, --conversation <id>`	No	Continue the conversation with this ID.

Each turn prints the reply on stdout and the conversation ID on stderr; pass that ID back with -c to continue the same conversation. With --output json or yaml the reply is not streamed — the finished result is printed as one document, conversation ID included.

Examples

Code

sim chat "What workflows do I have?"
sim chat -c "$CONVERSATION_ID" "Which of those run on a schedule?"
sim --output json chat "Summarize yesterday's failed runs" | jq -r '.content'

sim profiles

List profiles and add a workspace profile that shares a stored login.

Adding a profile reuses the active stored login and selects a default workspace. Supply --workspace when running without an interactive terminal.

Also spelled sim profile.

sim profiles list

List configured profiles

Code

sim profiles list

sim profiles add

Add a workspace profile that shares the active stored login

Code

sim profiles add <name> [options]

Arguments

Argument	Required	Description
`name`	Yes	Name for the new profile

Options

Option	Required	Description
`-w, --workspace <id>`	No	Existing workspace to use; omit for an interactive picker.

API request and response schemas: getWorkspace, listWorkspaces.

sim telemetry

Inspect and change this machine’s anonymous usage-reporting preference.

sim telemetry status

Show usage-reporting status

Code

sim telemetry status

Telemetry commands always print text. DO_NOT_TRACK and SIM_TELEMETRY_DISABLED override the saved preference; a build without a reporting destination remains off. See the usage-data guide for the data collected.

sim telemetry enable

Enable the usage-reporting preference for this machine

Code

sim telemetry enable

sim telemetry disable

Turn usage reporting off for this machine

Code

sim telemetry disable

sim cli

Find a command by describing the task you want to perform.

sim cli search

Find commands for a task

Code

sim cli search <query...>

Arguments

Argument	Required	Description
`query...`	Yes	What you want to do, e.g. "cancel a workflow run"

Ranks the commands this CLI ships, locally; your query is never sent anywhere. Returns the 5 best matches. Run <command> --help on one for its flags.

Examples

Code

sim cli search "cancel a running workflow"
sim cli search list table rows

sim audit-logs

Read organization audit actions and filter by actor, resource, workspace, or time.

Requires an organization Admin or owner, an OAuth login or personal API key, and enabled enterprise audit access for the deployment.

Also spelled sim audit-log.

sim audit-logs get

Get audit log (OAuth login or personal API key required)

Code

sim audit-logs get <auditLogId> [options]

Arguments

Argument	Required	Description
`auditLogId`	Yes	Audit-log entry identifier.

Options

Option	Required	Description
`--organization <value>`	No	Organization whose audit trail to read; defaults to the caller’s organization. A caller that belongs to no organization, or names one it does not belong to, is refused with 403.

API request and response schemas: getAuditLog.

sim audit-logs list

List audit logs (OAuth login or personal API key required)

Code

sim audit-logs list [options]

Options

Option	Required	Description
`--action <value>`	No	Filter by exact action name.
`--resource-type <value>`	No	Filter by resource type. Accepts a comma-separated set; members are trimmed and deduplicated, and member order affects neither the result nor the cursor.
`--resource-id <value>`	No	Filter by exact resource identifier.
`--start-date <value>`	No	Include audit entries created at or after this UTC ISO 8601 timestamp, such as `2026-08-06T00:00:00Z`. Dates without a time, timestamps with an offset instead of `Z`, and year `0000` are rejected.
`--end-date <value>`	No	Include audit entries created at or before this UTC ISO 8601 timestamp, such as `2026-08-06T00:00:00Z`. Dates without a time, timestamps with an offset instead of `Z`, and year `0000` are rejected.
`--include-departed`	No	Include actions by users who have left the organization.
`--no-include-departed`	No	Send --include-departed as false.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--organization <value>`	No	Organization whose audit trail to read; defaults to the caller’s organization. A caller that belongs to no organization, or names one it does not belong to, is refused with 403.
`--actor-email <value>`	No	Filter by actor email address.
`--all-workspaces`	No	Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access).

API request and response schemas: listAuditLogs.

sim billing

Read billing status, credit usage, and storage usage.

sim billing status

Show billing status, credits spent, and storage used (credits and storage require an OAuth login or personal API key)

Code

sim billing status [options]

Options

Option	Required	Description
`--all-workspaces`	No	Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access).

API request and response schemas: getBillingStatus.

sim billing logs

List credit usage events (an OAuth login or personal API key reports only your events; a workspace API key reports every member's in aggregate, unattributed)

Code

sim billing logs [options]

Options

Option	Required	Description
`--source <value>`	No	Filter by usage source; sim-chat combines Sim agent and workspace Chat usage. Accepted values: `workflow`, `wand`, `sim-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`.
`--period <value>`	No	Billing period. Defaults to "30d". Accepted values: `1d`, `7d`, `30d`, `all`, `custom`.
`--start-date <value>`	No	Custom period start (ISO 8601).
`--end-date <value>`	No	Custom period end (ISO 8601).
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--all-workspaces`	No	Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access).

API request and response schemas: listBillingLogs.

sim blocks

Inspect workflow blocks, integration blocks, and triggers available to the workspace.

The catalog reflects the workspace’s allowed integrations, revealed preview blocks, and deployed custom blocks.

sim blocks get

Get block

Code

sim blocks get <blockId>

Arguments

Argument	Required	Description
`blockId`	Yes	Block type identifier. An unversioned base type resolves to the newest visible version. The response echoes the resolved ID.

API request and response schemas: getBlock.

sim blocks list

List blocks

Code

sim blocks list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the block id, name, and description.
`--category <value>`	No	Restrict to one toolbar category. Accepted values: `blocks`, `tools`, `triggers`.
`--capability <value>`	No	Restrict to blocks that can start a workflow — the `triggers` category, blocks declaring `triggerAllowed`, and blocks with trigger-mode fields. Accepted values: `trigger`.
`--source <value>`	No	Restrict to shipped blocks or to this workspace’s deployed custom blocks. Accepted values: `builtin`, `custom`.
`--include-sunset`	No	Include `legacy` and `deprecated` blocks. Off by default: a sunset block keeps executing where it is already placed, but it is not offered for new authoring. Each returned entry carries `sunset.replacedBy`, the block to build with instead.
`--no-include-sunset`	No	Send --include-sunset as false.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "id". Accepted values: `id`, `name`, `category`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listBlocks.

sim chat-deployments

List workflow chat deployments in the workspace.

sim chat-deployments list

List chat deployments

Code

sim chat-deployments list [options]

Options

Option	Required	Description
`--workflow-id <value>`	No	Restrict to deployments of one workflow.
`--is-active`	No	Restrict to active or inactive deployments.
`--no-is-active`	No	Send --is-active as false.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `identifier`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listChatDeployments.

sim connector-types

Discover knowledge connectors and their authentication and source-configuration schemas.

Use --detail full to inspect a connector’s configuration before creating it.

sim connector-types list

List connector types

Code

sim connector-types list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the connector name.
`--detail <value>`	No	Projection of each item. `summary` (the default) carries the identifier, name, description, and auth mode; `full` adds the version, the complete auth settings, the `sourceConfig` field schema, incremental-sync support, and tag definitions. Accepted values: `summary`, `full`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listConnectorTypes.

sim credentials

Discover providers, connect accounts, and manage credential access.

Run sim --output json credentials providers list to inspect the provider’s fields and authentication requirements before creating a service-account credential. OAuth connection commands return a link that a person must open to authorize the connection.

Also spelled sim credential.

sim credentials delete

Disconnect credential (OAuth login or personal API key required)

This disconnects the credential and removes its stored authentication.

Code

sim credentials delete <credentialId> [options]

Arguments

Argument	Required	Description
`credentialId`	Yes	Credential to disconnect.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteCredential.

sim credentials members list

List credential members (OAuth login or personal API key required)

Code

sim credentials members list <credentialId> [options]

Arguments

Argument	Required	Description
`credentialId`	Yes	Credential whose sharing grants are managed.

Options

Option	Required	Description
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "email". Accepted values: `email`, `name`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listCredentialMembers.

sim credentials members remove

Remove credential member (OAuth login or personal API key required)

This revokes the selected user’s explicit credential grant.

Code

sim credentials members remove <credentialId> <userId> [options]

Arguments

Argument	Required	Description
`credentialId`	Yes	Credential whose sharing grants are managed.
`userId`	Yes	User whose explicit grant will be revoked.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removeCredentialMember.

sim credentials members upsert

Upsert credential member (OAuth login or personal API key required)

Code

sim credentials members upsert <credentialId> [options]

Arguments

Argument	Required	Description
`credentialId`	Yes	Credential whose sharing grants are managed.

Options

Option	Required	Description
`--user <value>`	Yes	Existing workspace member to grant or change access for.
`--role <value>`	Yes	Credential role to grant; workspace administrators cannot be demoted. Accepted values: `admin`, `member`.

API request and response schemas: upsertCredentialMember.

sim credentials providers list

List credential providers

Code

sim credentials providers list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the credential provider name.

API request and response schemas: listCredentialProviders.

sim credentials list

List credentials

Code

sim credentials list [options]

Options

Option	Required	Description
`--type <value>`	No	Restrict results to this credential type. Accepted values: `oauth`, `service_account`.
`--provider-id <value>`	No	Restrict results to credentials for this integration provider.
`--search <value>`	No	Case-insensitive substring match against the credential display name.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `displayName`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listCredentials.

sim credentials update

Update credential (OAuth login or personal API key required)

Code

sim credentials update <credentialId> [options]

Arguments

Argument	Required	Description
`credentialId`	Yes	Credential to update.

Options

Option	Required	Description
`--display-name <value>`	No	New name shown for the credential in Sim.
`--description <value>`	No	New credential description. Send null to clear the stored one. (--description null sends the word, not JSON null).
`--service-account-json <value>`	No	Write-only provider service-account JSON configuration, including Oracle Database connection fields.
`--api-token <value>`	No	Write-only provider API token.
`--domain <value>`	No	Provider account domain.
`--atlassian-product <value>`	No	Atlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: `jira`, `confluence`.
`--signing-secret <value>`	No	Write-only webhook signing secret.
`--bot-token <value>`	No	Write-only bot token.
`--client-id <value>`	No	OAuth client identifier.
`--client-secret <value>`	No	Write-only OAuth client secret.
`--certificate-id <value>`	No	Provider certificate mapping identifier.
`--org-id <value>`	No	Provider organization ID.
`--data-center <value>`	No	Provider data center.
`--scope <value>`	No	Provider permissions; preserved on reconnect when omitted.
`--auth-method <value>`	No	Provider authentication method.
`--private-key <value>`	No	Write-only PEM private key.
`--username <value>`	No	Provider run-as username.
`--tenancy-ocid <value>`	No	OCI tenancy OCID.
`--user-ocid <value>`	No	OCI user OCID.
`--fingerprint <value>`	No	OCI API-key fingerprint.
`--private-key-passphrase <value>`	No	Write-only OCI private-key passphrase.
`--region <value>`	No	OCI home region.
`--name <displayName>`	No	Alias for --display-name.

API request and response schemas: updateCredential.

sim credentials create

Create a service-account credential using its discovered provider schema (OAuth login or personal API key required)

Code

sim credentials create <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Service-account provider to create a credential for

Options

Option	Required	Description
`--name <displayName>`	Yes	Name shown for the credential in Sim.
`--credentials <json\|@file>`	Yes	Provider credentials as JSON (or @path / @- to read a file or stdin).
`--description <description>`	No	Optional credential description.
`--id <credentialId>`	No	Client-generated credential ID when provider discovery requires it.

API request and response schemas: createServiceAccountCredential.

sim credentials connect

Create a short-lived link for connecting an OAuth provider (OAuth login or personal API key required)

Code

sim credentials connect <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	OAuth provider to connect

Options

Option	Required	Description
`--name <displayName>`	Yes	Name shown for the new credential in Sim.

API request and response schemas: createCredentialConnection.

sim credentials reconnect

Create a short-lived link for reconnecting an OAuth credential (OAuth login or personal API key required)

Code

sim credentials reconnect <credentialId>

Arguments

Argument	Required	Description
`credentialId`	Yes	Existing OAuth credential to re-authorize

API request and response schemas: createCredentialConnection.

sim custom-tools

Create and manage code-backed tools that agents can call.

Also spelled sim custom-tool.

sim custom-tools create

Create custom tool

Code

sim custom-tools create [options]

Options

Option	Required	Description
`--title <value>`	Yes	Display title, unique within the workspace.
`--schema <json\|@file>`	Yes	OpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin).
`--code <value>`	Yes	Tool implementation executed in the sandboxed function runtime.

API request and response schemas: createCustomTool.

sim custom-tools delete

Delete custom tool

This deletes the custom tool.

Code

sim custom-tools delete <customToolId> [options]

Arguments

Argument	Required	Description
`customToolId`	Yes	Unique custom tool identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteCustomTool.

sim custom-tools get

Get custom tool

Code

sim custom-tools get <customToolId>

Arguments

Argument	Required	Description
`customToolId`	Yes	Unique custom tool identifier.

API request and response schemas: getCustomTool.

sim custom-tools list

List custom tools

Code

sim custom-tools list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the tool title.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `title`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listCustomTools.

sim custom-tools update

Update custom tool

Code

sim custom-tools update <customToolId> [options]

Arguments

Argument	Required	Description
`customToolId`	Yes	Unique custom tool identifier.

Options

Option	Required	Description
`--title <value>`	No	New display title for the tool.
`--schema <json\|@file>`	No	OpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin).
`--code <value>`	No	Replacement tool implementation.

API request and response schemas: updateCustomTool.

sim files

Browse workspace files, read or write content, manage versions, and configure sharing.

Also spelled sim file.

sim files batch-delete

Delete several files at once

This archives the listed files; restore them with files restore.

Code

sim files batch-delete [file-ids...] [options]

Arguments

Argument	Required	Description
`file-ids...`	No	Files to delete, each by identifier or by the VFS path of a live file: `files/<folder>/<name>`. Pass the id when two files in a folder have names that display alike. At most 100 entries may be paths. Same as --file-ids.

Options

Option	Required	Description
`--file-ids <value...>`	No	Files to delete, each by identifier or by the VFS path of a live file: `files/<folder>/<name>`. Pass the id when two files in a folder have names that display alike. At most 100 entries may be paths. (space-separated, or @path / @- with one value per line; @@value for a literal leading @) (required, or pass the values as arguments).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: bulkDeleteFiles.

sim files copy

Copy file items (OAuth login or personal API key required)

Code

sim files copy [options]

Options

Option	Required	Description
`--source <json\|@file>`	Yes	Source owner and selected fileIds or folderIds (JSON, or @path / @- to read a file or stdin).
`--destination <json\|@file>`	Yes	Destination owner and optional folderId (JSON, or @path / @- to read a file or stdin).

sim files create

Create file

Code

sim files create [options]

Options

Option	Required	Description
`--name <value>`	Yes	File name, including its extension. Path separators and dot segments are rejected.
`--content-type <value>`	No	MIME type. When omitted, it is inferred from the file extension.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--content <value>`	No	Initial file content. Omit or send an empty string for a zero-byte file. The complete JSON request is capped at 10 MiB, including encoding and the envelope; the separate decoded-file limit is 50 MiB. For larger payloads, use `sim files upload <path>`. Defaults to "".
`--encoding <value>`	No	Encoding of the content field. Defaults to "utf-8". Accepted values: `utf-8`, `base64`.

API request and response schemas: createFile.

sim files folders create

Create a file folder at a path

Code

sim files folders create <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: createFileFolder.

sim files folders delete

Delete folder

This archives the file folder and, when recursive, everything inside it.

Code

sim files folders delete <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

Options

Option	Required	Description
`--recursive`	No	Archive the folder and its descendants. Defaults to "false".
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteFileFolder.

sim files folders list

List folders

Code

sim files folders list [options]

Also available as sim files folders ls.

Options

Option	Required	Description
`--parent <value>`	No	Direct parent folder path.
`--search <value>`	No	Case-insensitive substring match against the folder name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--scope <value>`	No	Which lifecycle set to list: `active` (default) returns live folders only; `archived` returns folders a recursive delete soft-deleted, which is how a caller finds a path to hand to the folder restore. Authorization is identical for both. Accepted values: `active`, `archived`.
`--recursive <value>`	No	Whether parentPath includes every descendant instead of direct children only. Accepted values: `true`, `1`, `yes`, `on`, `y`, `enabled`, `false`, `0`, `no`, `off`, `n`, `disabled`.
`--depth <value>`	No	Deepest level below parentPath to include when recursive is true.

API request and response schemas: listFileFolders.

sim files folders move

Rename or move a file folder

Code

sim files folders move <path> <destination>

Also available as sim files folders mv.

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional
`destination`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: relocateFileFolder.

sim files folders restore

Restore an archived file folder

Code

sim files folders restore <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: restoreFileFolder.

sim files delete

Delete file

This archives the file.

Code

sim files delete <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier, or the VFS path of a live file: `files/<folder>/<name>`. Pass the id when two files in a folder have names that display alike.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteFile.

sim files versions delete

Permanently delete a previous version of a file

This permanently removes the version from history and schedules deletion of its stored content; storage cleanup may retry in the background.

Code

sim files versions delete <fileId> <version> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.
`version`	Yes	Version number.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteFileVersion.

sim files versions describe

Show the metadata of one version of a file

Code

sim files versions describe <fileId> <version>

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.
`version`	Yes	Version number.

API request and response schemas: getFileVersion.

sim files versions list

List the recorded versions of a file

Code

sim files versions list <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

Options

Option	Required	Description
`--sort-by <value>`	No	Field used to sort the result. Defaults to "version". Accepted values: `version`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". 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.

API request and response schemas: listFileVersions.

sim files versions read

Read the text content of one version of a file as JSON or YAML

Code

sim files versions read <fileId> <version> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.
`version`	Yes	Version number.

Options

Option	Required	Description
`--max-bytes <value>`	No	Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit.
`--offset <value>`	No	First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line.
`--limit <value>`	No	How many lines to return from `offset`. Absent reads to the end.

API request and response schemas: readFileVersionText.

sim files versions revert

Make a previous version of a file current again

Code

sim files versions revert <fileId> <version> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.
`version`	Yes	Version number.

Options

Option	Required	Description
`--expected-current-version <value>`	No	Revert only while this is still the current version; otherwise the request fails with `409`. Omit to revert whatever is current. Collaborative edits and repeated workflow writes that fold into the current version keep its number, so prefer `expectedRevision` to guard content.
`--expected-revision <value>`	No	Revert only while the file still holds the content this revision names, as returned by Get file metadata or an earlier write; otherwise the request fails with `409`. Unlike a version number, it also catches edits that folded into the current version.

API request and response schemas: revertFileVersion.

sim files versions download

Download the content of one version of a file

Code

sim files versions download <fileId> <version> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.
`version`	Yes	Version number.

Options

Option	Required	Description
`-o, --output-file <path>`	No	Write content to a file instead of stdout.
`--force`	No	Overwrite --output-file if it already exists.

API request and response schemas: downloadFileVersion.

sim files edit

Apply one exact or anchor-based edit to a text file

Code

sim files edit <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

Options

Option	Required	Description
`--edit <json\|@file>`	Yes	One edit object: {"mode":"search_replace","search":"old","content":"new","replaceAll":false}, {"mode":"replace_between","beforeAnchor":"start line","afterAnchor":"end line","content":"new"}, {"mode":"insert_after","anchor":"line","content":"new"}, or {"mode":"delete_between","startAnchor":"first line deleted","endAnchor":"ending line kept"}. Anchored modes also accept occurrence starting at 1 (JSON, or @path / @- to read a file or stdin).
`--expected-revision <value>`	No	Revision from Get file metadata or an earlier write; the request is refused with `409` when the content moved on.

API request and response schemas: editFileContent.

sim files describe

Show file metadata and sharing status

Code

sim files describe <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier, or the VFS path of a live file: `files/<folder>/<name>`. Pass the id when two files in a folder have names that display alike.

Options

Option	Required	Description
`--scope <value>`	No	Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file a delete soft-deleted; `archived` also resolves soft-deleted files, so metadata stays readable before the file is restored. Authorization is identical for both. Accepted values: `active`, `archived`.

API request and response schemas: getFile.

Show a file’s share settings

Code

sim files share get <fileId>

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

API request and response schemas: getFileShare.

Enable or disable sharing for a file (OAuth login or personal API key required)

Code

sim files share set <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

Options

Option	Required	Description
`--is-active <true\|false>`	Yes	Whether the share should resolve. Disabling preserves the token and the whole access configuration, so re-enabling restores the share as it was; enabling rewrites the credentials the resulting mode does not use. Accepted values: `true`, `false`.
`--auth-type <value>`	No	How access to the share is gated. The stored mode is kept when omitted. Enabling `public` clears the stored password and empties `allowedEmails`; `password` empties `allowedEmails`; `email` and `sso` clear the stored password. Accepted values: `public`, `password`, `email`, `sso`.
`--password <value>`	No	Password of 15 to 1024 characters for a password-gated share. Kept when omitted; enabling `password` with neither a supplied nor a stored password is a 400. Taken literally, except that a request from the Sim agent resolves a whole-value `{{ENV_VAR}}` reference to that variable before the rules apply.
`--allowed-emails <value...>`	No	Allowed addresses or `@domain` patterns for email and SSO shares. Kept when omitted; enabling `email` or `sso` with an empty resulting list is a 400. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: upsertFileShare.

sim files list

List files

Code

sim files list [options]

Options

Option	Required	Description
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--recursive`	No	Include subfolders in the folder filter. Defaults to true when searching and false otherwise. Ignored without a folder filter.
`--no-recursive`	No	Send --recursive as false.
`--scope <value>`	No	Which lifecycle set to list: `active` (default) for live files, `archived` for files a delete soft-deleted. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`.
`--search <value>`	No	Case-insensitive substring match against the file name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "uploadedAt". Accepted values: `name`, `size`, `uploadedAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listFiles.

sim files move

Move files into another folder

Code

sim files move [options]

Also available as sim files mv.

Options

Option	Required	Description
`--file-ids <value...>`	Yes	File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--to <value>`	No	Destination folder path; omit for root.

API request and response schemas: moveFileItems.

sim files read

Read a file’s text content as JSON or YAML

Code

sim files read <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier, or the file’s VFS path: `files/<folder>/<name>`, or `uploads/<name>` for a Chat upload.

Options

Option	Required	Description
`--max-bytes <value>`	No	Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit.
`--offset <value>`	No	First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line.
`--limit <value>`	No	How many lines to return from `offset`. Absent reads to the end.

API request and response schemas: readFileText.

sim files rename

Rename a file

Code

sim files rename <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier, or the VFS path of a live file: `files/<folder>/<name>`. Pass the id when two files in a folder have names that display alike.

Options

Option	Required	Description
`--name <value>`	Yes	New file name, including its extension.

API request and response schemas: renameFile.

sim files restore

Restore an archived file

Code

sim files restore <fileId>

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

API request and response schemas: restoreFile.

sim files search

Search file content

Code

sim files search [options]

Options

Option	Required	Description
`--query <value>`	Yes	Regular expression, or exact text when `mode` is `exact`.
`--mode <value>`	No	How `query` is read. Defaults to "regex". Accepted values: `exact`, `regex`.
`--max-results <value>`	No	Maximum matching lines to return. Defaults to 50.
`--folder <value...>`	No	Folders to search, by path as shown in the app; omit to search the whole workspace (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--include-subfolders`	No	Whether each folder scope includes nested folders; on by default.
`--no-include-subfolders`	No	Send --include-subfolders as false.

API request and response schemas: searchFileContent.

sim files unzip

Unzip an archive into a new folder beside it

This writes every file in the archive into the workspace.

Code

sim files unzip <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: unzipFile.

sim files set-content

Replace a file’s contents

Code

sim files set-content <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File identifier.

Options

Option	Required	Description
`--content <value>`	Yes	Complete replacement content for the file. The complete JSON request is capped at 10 MiB, including UTF-8 encoding, escaping, base64, and the envelope. The separate decoded-file limit is 50 MiB. Small patches can edit a larger stored text file without sending its full content.
`--encoding <value>`	No	Content encoding. Defaults to "utf-8". Accepted values: `utf-8`, `base64`.
`--expected-revision <value>`	No	Revision from Get file metadata or an earlier write; the request is refused with `409` when the content moved on.

API request and response schemas: updateFileContent.

sim files upload

Upload a file to the workspace

Code

sim files upload <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Local file to upload

Options

Option	Required	Description
`--folder <path>`	No	Folder path as shown in the app; defaults to the root folder.
`--name <name>`	No	Store it under a different name.

API request and response schemas: createFileUpload, createFileUploadPartUrls, completeFileUpload, abortFileUpload.

sim files get

Download a file’s content to stdout or a local file

Code

sim files get <fileId> [options]

Arguments

Argument	Required	Description
`fileId`	Yes	File whose content to read: its id, or its `files/<folder>/<name>` VFS path

Options

Option	Required	Description
`-o, --output-file <path>`	No	Write content to a file instead of stdout.
`--force`	No	Overwrite --output-file if it already exists.

API request and response schemas: downloadFile.

sim files ls

List file resources and child folders together

Code

sim files ls [path] [options]

Arguments

Argument	Required	Description
`path`	No	Folder path to list; defaults to the root folder

Options

Option	Required	Description
`--search <text>`	No	Filter folders and resources by name.
`--limit <n>`	No	Maximum combined items to return (0 for everything). Defaults to `0`.

API request and response schemas: listFiles, listFileFolders.

sim files mkdir

Create a file directory at a path

Code

sim files mkdir <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path to create; the leading / is optional

API request and response schemas: createFileFolder.

sim knowledge

Manage knowledge bases, indexed documents, search, tags, and connector syncs.

Also spelled sim kb.

sim knowledge from-workspace-files create

Index files the workspace already stores (OAuth login or personal API key required)

Code

sim knowledge from-workspace-files create <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--file <value...>`	Yes	Workspace file ID or canonical files/<folder>/<name> path (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: addWorkspaceFilesToKnowledgeBase.

sim knowledge tags save

Declare the tag definitions a knowledge base needs (OAuth login or personal API key required)

Code

sim knowledge tags save <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--definitions <json\|@file>`	Yes	Tag definitions: [{"tagSlot":"tag1","displayName":"category","fieldType":"text"}] (JSON, or @path / @- to read a file or stdin).

API request and response schemas: bulkSaveKnowledgeTagDefinitions.

sim knowledge tags create

Create tag (OAuth login or personal API key required)

Code

sim knowledge tags create <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--display-name <value>`	Yes	Name tag filters and document reads use for this tag.
`--field-type <value>`	No	Value type stored in the slot; it decides which slots are usable and which filter operators apply. Defaults to text, so a number, date, or boolean slot must name its type here. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`.
`--tag-slot <value>`	No	Slot to store the tag in. Omit to take the next free slot for the field type; a slot that does not belong to the field type, or one already in use, is rejected. Accepted values: `tag1`, `tag2`, `tag3`, `tag4`, `tag5`, `tag6`, `tag7`, `number1`, `number2`, `number3`, `number4`, `number5`, `date1`, `date2`, `boolean1`, `boolean2`, `boolean3`.

API request and response schemas: createKnowledgeTag.

sim knowledge tags delete

Delete tag (OAuth login or personal API key required)

This deletes the tag and clears its values on every document and chunk.

Code

sim knowledge tags delete <knowledgeBaseId> <tagId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`tagId`	Yes	Unique tag definition identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeTag.

sim knowledge tags cleanup

Remove tag definitions no document still uses (OAuth login or personal API key required)

This deletes every tag definition no document still uses. Their slots become free for a different field.

Code

sim knowledge tags cleanup <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--unused`	No	Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable.
`--no-unused`	No	Send --unused as false.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeTagDefinitions.

sim knowledge tags next-slot

Show which tag slot a create would take for a field type (OAuth login or personal API key required)

Code

sim knowledge tags next-slot <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--field-type <value>`	Yes	Value type stored in the slot; it decides which slots are usable and which filter operators apply. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`.

API request and response schemas: getNextKnowledgeTagSlot.

sim knowledge tags list

List tags

Code

sim knowledge tags list <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: listKnowledgeTags.

sim knowledge tags usage

Show how many documents and chunks carry each tag (OAuth login or personal API key required)

Code

sim knowledge tags usage <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: listKnowledgeTagUsage.

sim knowledge tags update

Update tag (OAuth login or personal API key required)

Code

sim knowledge tags update <knowledgeBaseId> <tagId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`tagId`	Yes	Unique tag definition identifier.

Options

Option	Required	Description
`--display-name <value>`	No	New tag display name.
`--field-type <value>`	No	New value type for the tag. Accepted values: `text`, `number`, `date`, `boolean`.

API request and response schemas: updateKnowledgeTag.

sim knowledge chunks batch-update

Enable, disable, or delete many chunks at once (OAuth login or personal API key required)

This applies --operation to every named chunk; with --operation delete it deletes them and their embeddings, which cannot be undone.

Code

sim knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--operation <value>`	Yes	What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`.
`--chunk <value...>`	Yes	Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: bulkUpdateKnowledgeChunks.

sim knowledge chunks create

Create chunk (OAuth login or personal API key required)

Code

sim knowledge chunks create <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--content <value>`	Yes	Text embedded before the response. Search includes it when the chunk and document are enabled and the document has completed processing.
`--enabled`	No	Whether the new chunk participates in search. Defaults to true.
`--no-enabled`	No	Send --enabled as false.

API request and response schemas: createKnowledgeChunk.

sim knowledge chunks delete

Delete chunk (OAuth login or personal API key required)

This deletes the chunk and its embedding.

Code

sim knowledge chunks delete <knowledgeBaseId> <documentId> <chunkId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeChunk.

sim knowledge chunks get

Get chunk (OAuth login or personal API key required)

Code

sim knowledge chunks get <knowledgeBaseId> <documentId> <chunkId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

API request and response schemas: getKnowledgeChunk.

sim knowledge chunks list

List chunks (OAuth login or personal API key required)

Code

sim knowledge chunks list <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against chunk content.
`--enabled <value>`	No	Restrict to enabled or disabled chunks. `all` returns both. Defaults to "all". Accepted values: `true`, `false`, `all`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "chunkIndex". Accepted values: `chunkIndex`, `tokenCount`, `enabled`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". 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.

API request and response schemas: listKnowledgeChunks.

sim knowledge chunks update

Update chunk (OAuth login or personal API key required)

Code

sim knowledge chunks update <knowledgeBaseId> <documentId> <chunkId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

Options

Option	Required	Description
`--content <value>`	No	Replacement text. Changing it re-embeds the chunk and re-derives its token and character counts.
`--enabled`	No	Whether the chunk participates in search. Disabling keeps it indexed.
`--no-enabled`	No	Send --enabled as false.

API request and response schemas: updateKnowledgeChunk.

sim knowledge documents batch-update

Enable or disable every matching document (OAuth login or personal API key required)

Code

sim knowledge documents batch-update <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--operation <value>`	Yes	Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`.
`--document <value...>`	No	Documents to update, by identifier. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--select-all`	No	Apply to every document in the knowledge base.
`--enabled-filter <value>`	No	With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`.

API request and response schemas: bulkUpdateKnowledgeDocuments.

sim knowledge documents delete

Delete a document from a knowledge base

This deletes the document and its embeddings.

Code

sim knowledge documents delete <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeDocument.

sim knowledge documents get

Get document

Code

sim knowledge documents get <knowledgeBaseId> <documentId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

API request and response schemas: getKnowledgeDocument.

sim knowledge documents list

List documents

Code

sim knowledge documents list <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--search <value>`	No	Case-insensitive substring match against the document filename.
`--enabled-filter <value>`	No	Filter by whether documents are enabled for search. Defaults to "all". Accepted values: `all`, `enabled`, `disabled`.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `filename`. Defaults to "uploadedAt". Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--tag-filters <value>`	No	A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[{"tagName":"category","operator":"eq","value":"billing"}]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored.

API request and response schemas: listKnowledgeDocuments.

sim knowledge documents update

Update document (OAuth login or personal API key required)

Code

sim knowledge documents update <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--filename <value>`	No	New filename for the document.
`--enabled`	No	Whether the document participates in search. Disabling keeps it indexed.
`--no-enabled`	No	Send --enabled as false.
`--tag1 <value>`	No	New value for tag slot 1.
`--tag2 <value>`	No	New value for tag slot 2.
`--tag3 <value>`	No	New value for tag slot 3.
`--tag4 <value>`	No	New value for tag slot 4.
`--tag5 <value>`	No	New value for tag slot 5.
`--tag6 <value>`	No	New value for tag slot 6.
`--tag7 <value>`	No	New value for tag slot 7.
`--number1 <value>`	No	New value for number tag slot 1.
`--number2 <value>`	No	New value for number tag slot 2.
`--number3 <value>`	No	New value for number tag slot 3.
`--number4 <value>`	No	New value for number tag slot 4.
`--number5 <value>`	No	New value for number tag slot 5.
`--date1 <value>`	No	New value for date tag slot 1, formatted YYYY-MM-DD.
`--date2 <value>`	No	New value for date tag slot 2, formatted YYYY-MM-DD.
`--boolean1`	No	New value for boolean tag slot 1.
`--no-boolean1`	No	Send --boolean1 as false.
`--boolean2`	No	New value for boolean tag slot 2.
`--no-boolean2`	No	Send --boolean2 as false.
`--boolean3`	No	New value for boolean tag slot 3.
`--no-boolean3`	No	Send --boolean3 as false.
`--retry-processing`	No	Requeue a failed or stuck document for processing. Send it alone — no other field may accompany it — and it answers with a queue acknowledgement rather than the document.

API request and response schemas: updateKnowledgeDocument.

sim knowledge documents upload

Upload a document to a knowledge base

Code

sim knowledge documents upload <knowledgeBaseId> <path> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base to upload into
`path`	Yes	Local file to upload

Options

Option	Required	Description
`--name <name>`	No	Store it under a different name.
`--tag <value...>`	No	Document tags, in tag1 through tag7 order.
`--recipe <name>`	No	Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`.
`--lang <code>`	No	Document language tag: hyphen-separated letter and digit subtags, for example en or en-US.

API request and response schemas: createKnowledgeDocumentUpload, createKnowledgeDocumentUploadPartUrls, completeKnowledgeDocumentUpload, abortKnowledgeDocumentUpload.

sim knowledge imports cancel

Stop a running import

Code

sim knowledge imports cancel <importId>

Arguments

Argument	Required	Description
`importId`	Yes	Unique knowledge-base import identifier.

API request and response schemas: cancelKnowledgeImport.

sim knowledge imports get

Get knowledge base import

Code

sim knowledge imports get <importId>

Arguments

Argument	Required	Description
`importId`	Yes	Unique knowledge-base import identifier.

API request and response schemas: getKnowledgeImport.

sim knowledge create

Create knowledge base

Code

sim knowledge create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Human-readable knowledge base name.
`--description <value>`	No	Optional knowledge base description.
`--chunking-config <json\|@file>`	No	Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: createKnowledgeBase.

sim knowledge connectors create

Create knowledge connector (OAuth login or personal API key required)

Code

sim knowledge connectors create <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--connector-type <value>`	Yes	Registered connector type.
`--credential-id <value>`	No	OAuth credential identifier for connector types whose `auth.mode` is `oauth` (see connector types); omit it for `apiKey` connectors.
`--api-key <value>`	No	Write-only API key for connector types whose `auth.mode` is `apiKey` (see connector types), or a personal access token for an OAuth connector that also accepts one, such as GitHub. Send it instead of `credentialId`. Pass a raw key, or a secret reference written as the whole value `{{SECRET_NAME}}`, which the server resolves; `$SECRET_NAME` is not a reference.
`--source-config <json\|@file>`	Yes	Connector-specific source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin).
`--sync-interval-minutes <value>`	No	Scheduled synchronization interval in minutes; zero disables scheduling. Defaults to 1440.

API request and response schemas: createKnowledgeConnector.

sim knowledge connectors delete

Delete knowledge connector (OAuth login or personal API key required)

This deletes the connector; --delete-documents also deletes its synchronized documents.

Code

sim knowledge connectors delete <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--delete-documents`	No	Also permanently delete documents produced by this connector.
`--no-delete-documents`	No	Send --delete-documents as false.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeConnector.

sim knowledge connectors get

Get knowledge connector (OAuth login or personal API key required)

Code

sim knowledge connectors get <knowledgeBaseId> <connectorId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

API request and response schemas: getKnowledgeConnector.

sim knowledge connectors documents list

List knowledge connector documents (OAuth login or personal API key required)

Code

sim knowledge connectors documents list <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--include-excluded`	No	Include documents explicitly excluded by a user.
`--no-include-excluded`	No	Send --include-excluded as false.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listKnowledgeConnectorDocuments.

sim knowledge connectors documents update

Update knowledge connector documents (OAuth login or personal API key required)

Code

sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--operation <value>`	Yes	Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`.
`--document <value...>`	Yes	Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: updateKnowledgeConnectorDocuments.

sim knowledge connectors list

List knowledge connectors (OAuth login or personal API key required)

Code

sim knowledge connectors list <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `connectorType`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeConnectors.

sim knowledge connectors sync

Queue a knowledge connector synchronization (OAuth login or personal API key required)

Code

sim knowledge connectors sync <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--rehydrate`	No	Re-fetch and re-index every existing connector document. Defaults to false.
`--no-rehydrate`	No	Send --rehydrate as false.

API request and response schemas: syncKnowledgeConnector.

sim knowledge connectors update

Update knowledge connector (OAuth login or personal API key required)

Code

sim knowledge connectors update <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--source-config <json\|@file>`	No	Replacement source selection and filtering configuration. Updating a runnable connector queues synchronization; paused connectors remain paused. (JSON, or @path / @- to read a file or stdin).
`--sync-interval-minutes <value>`	No	New scheduled synchronization interval in minutes.
`--status <value>`	No	New connector state. Accepted values: `active`, `paused`.

API request and response schemas: updateKnowledgeConnector.

sim knowledge folders create

Create a knowledge folder at a path

Code

sim knowledge folders create <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: createKnowledgeFolder.

sim knowledge folders delete

Delete folder

This archives the knowledge folder and, when recursive, everything inside it.

Code

sim knowledge folders delete <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

Options

Option	Required	Description
`--recursive`	No	Archive the folder and its descendants. Defaults to "false".
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeFolder.

sim knowledge folders list

List knowledge folders

Code

sim knowledge folders list [options]

Also available as sim knowledge folders ls.

Options

Option	Required	Description
`--parent <value>`	No	Direct parent folder path.
`--search <value>`	No	Case-insensitive substring match against the folder name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listKnowledgeFolders.

sim knowledge folders move

Rename or move a knowledge folder

Code

sim knowledge folders move <path> <destination>

Also available as sim knowledge folders mv.

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional
`destination`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: relocateKnowledgeFolder.

sim knowledge delete

Delete knowledge base

This archives the knowledge base and every document in it; restore with knowledge restore.

Code

sim knowledge delete <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeBase.

sim knowledge get

Get knowledge base

Code

sim knowledge get <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: getKnowledgeBase.

sim knowledge list

List knowledge bases

Code

sim knowledge list [options]

Options

Option	Required	Description
`--scope <value>`	No	Lifecycle scope: active or archived knowledge bases. Use Restore knowledge base to recover archived entries. Folder paths resolve only active folders, so filtering by an archived folder returns no matches. Defaults to "active". Accepted values: `active`, `archived`.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--search <value>`	No	Case-insensitive substring match against the resource name.
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeBases.

sim knowledge restore

Restore an archived knowledge base

Code

sim knowledge restore <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: restoreKnowledgeBase.

sim knowledge search

Search knowledge

Code

sim knowledge search [options]

Options

Option	Required	Description
`--kb <value...>`	Yes	Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--query <value>`	No	Text to search for.
`--top-k <value>`	No	Maximum number of search results to return. Must be a whole number between 1 and 100. Defaults to 10.
`--tag-filters <json\|@file>`	No	Tag filters as [{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin).
`--search-mode <value>`	No	Search algorithm. Accepted values: `vector`, `hybrid`.
`--reranker-enabled`	No	Reorder retrieved chunks with a reranking model before truncating to `topK`. Ignored for tag-only searches. A completed reranking call adds a search unit. If reranking is unavailable, results keep their retrieval order; check `rerankerStatus`.
`--no-reranker-enabled`	No	Send --reranker-enabled as false.
`--reranker-model <value>`	No	Reranking model to use when `rerankerEnabled` is true. Defaults to `rerank-v4.0-fast`. Accepted values: `rerank-v4.0-pro`, `rerank-v4.0-fast`, `rerank-v3.5`.
`--reranker-input-count <value>`	No	How many candidate chunks to retrieve before reranking. Defaults to four times `topK`, capped at 100. A larger pool costs more retrieval work but gives the reranker more to choose from.

API request and response schemas: searchKnowledge.

sim knowledge update

Update knowledge base

Code

sim knowledge update <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--name <value>`	No	New knowledge base name.
`--description <value>`	No	New knowledge base description.
`--chunking-config <json\|@file>`	No	New document chunking configuration. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: updateKnowledgeBase.

sim knowledge mv

Move a knowledge base to a folder

Code

sim knowledge mv <knowledgeBaseId> <folder>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`folder`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: updateKnowledgeBase.

sim knowledge export

Export a knowledge base as a .simkb.zip bundle

Code

sim knowledge export <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base to export

Options

Option	Required	Description
`-o, --output-file <path>`	No	Write the bundle to this path instead of the name the server suggests; pass - to stream it to stdout.
`--force`	No	Overwrite --output-file if it already exists.
`--no-vectors`	No	Leave chunk vectors out of the bundle, so an import re-embeds every chunk.

API request and response schemas: exportKnowledgeBase.

sim knowledge import

Create a knowledge base from an exported .simkb.zip bundle

Code

sim knowledge import <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Bundle archive written by `sim knowledge export`

Options

Option	Required	Description
`--name <name>`	No	Name for the new knowledge base; defaults to the bundle's own name.
`--no-wait`	No	Return once the import is started instead of watching it.

API request and response schemas: createKnowledgeImport, createKnowledgeImportPartUrls, completeKnowledgeImport, cancelKnowledgeImport, getKnowledgeImport.

sim knowledge ls

List knowledge resources and child folders together

Code

sim knowledge ls [path] [options]

Arguments

Argument	Required	Description
`path`	No	Folder path to list; defaults to the root folder

Options

Option	Required	Description
`--search <text>`	No	Filter folders and resources by name.
`--limit <n>`	No	Maximum combined items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeBases, listKnowledgeFolders.

sim knowledge mkdir

Create a knowledge directory at a path

Code

sim knowledge mkdir <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path to create; the leading / is optional

API request and response schemas: createKnowledgeFolder.

sim logs

Read run diagnostics, follow new runs, and summarize failures and latency.

Also spelled sim log.

sim logs get

Show run diagnostics

Code

sim logs get <runId> [options]

Arguments

Argument	Required	Description
`runId`	Yes	Unique workflow run identifier.

Options

Option	Required	Description
`--include-workflow-state`	No	Include the saved workflow snapshot (default: true; Sim’s in-app agent leaves it out unless this flag is passed). Set false to omit block configuration from a log read. Other run fields are unchanged.
`--no-include-workflow-state`	No	Send --include-workflow-state as false.
`--trace`	No	Show expanded trace spans with inputs, outputs, errors, timing, and cost.

API request and response schemas: getLog.

sim logs stats

Summarize run counts, failures and latency over a window

Code

sim logs stats [options]

Options

Option	Required	Description
`--workflow <value...>`	No	Comma-separated workflow identifiers to include. At most 200 entries. An empty entry is rejected. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--folder <value...>`	No	Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--trigger <value...>`	No	Comma-separated trigger types to include. An empty entry is rejected. The vocabulary is open, so an unrecognized member selects no runs; the literal `all` disables this filter. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--level <value>`	No	Severity level to include. Accepted values: `info`, `error`.
`--include-handled-errors`	No	Whether runs with a handled block error are counted as `handledErrorRuns`, and whether `level=error` also selects them. Off by default: counting them scans each run’s stored trace.
`--no-include-handled-errors`	No	Send --include-handled-errors as false.
`--start-date <value>`	No	Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--end-date <value>`	No	Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--segment-count <value>`	No	Number of equal time buckets to divide the window into, from 1 to 500. It is the ceiling on how many buckets a series carries: with `includeEmpty=true` exactly this many are returned, otherwise only the buckets holding at least one run. Buckets are never narrower than one minute, so on a short window the series extends past the end of the window rather than being compressed, and the trailing buckets are empty. Defaults to 72.
`--include-empty <value>`	No	Whether buckets with no runs are included in every series. Off by default, so each series carries only the buckets that hold at least one run; set it to publish exactly `segmentCount` buckets per series, empty ones included. The listed spellings are the whole accepted vocabulary and are case-sensitive; any other value is rejected. Accepted values: `true`, `1`, `yes`, `on`, `y`, `enabled`, `false`, `0`, `no`, `off`, `n`, `disabled`.

API request and response schemas: getLogStats.

sim logs list

List run logs, such as failed or errored runs, by workflow, trigger or time

Code

sim logs list [options]

Options

Option	Required	Description
`--workflow <value...>`	No	Comma-separated workflow identifiers to include. An empty entry is rejected. At most 200 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--trigger <value...>`	No	Comma-separated, lowercase trigger types or webhook provider IDs. Matching is exact and case-sensitive; unknown values select no runs. An empty entry is rejected. The sentinel `all` disables this filter, even when listed with other values. At most 100 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--level <value>`	No	Severity level to include. Accepted values: `info`, `error`.
`--start-date <value>`	No	Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--end-date <value>`	No	Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--min-duration-ms <value>`	No	Minimum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected.
`--max-duration-ms <value>`	No	Maximum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected.
`--min-cost <value>`	No	Minimum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run.
`--max-cost <value>`	No	Maximum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run.
`--model <value>`	No	AI model used during execution.
`--details <value>`	No	Response detail level; full is requested by default to name each run’s workflow. Accepted values: `basic`, `full`.
`--include-trace-spans`	No	Include trace spans in JSON or YAML output (implies full detail).
`--include-final-output`	No	Include final output in JSON or YAML output (implies full detail).
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--include-handled-errors`	No	Whether `level=error` also selects runs that finished at `info` after a block error was recovered by an error path. Off by default: such a run succeeded, so it is an error only to a caller auditing error handling. Every row reports `hasHandledErrors` whether or not this is set. Job runs carry no block trace, so the flag never widens that branch.
`--no-include-handled-errors`	No	Send --include-handled-errors as false.
`--status <value>`	No	Comma-separated execution statuses to include, from `pending` \| `running` \| `paused` \| `redacting` \| `completed` \| `failed` \| `cancelled`. An empty entry is rejected. ANDed with `level`, which reports severity rather than lifecycle.
`--workflow-name <value>`	No	Case-insensitive substring match against the run's workflow name. Runs whose workflow has been deleted match nothing, because the name is no longer joinable.
`--include-job-runs`	No	Include Chat and Sim-agent jobs alongside workflow runs. Jobs use `kind: "job"` and have no workflow or cost ledger. Workflow, folder, model, or status filters exclude jobs. This option is valid only when sorting by `startedAt`.
`--no-include-job-runs`	No	Send --include-job-runs as false.
`--run-id <value>`	No	Exact run identifier to match.
`--sort-by <value>`	No	Field used to sort the result. `durationMs` and `cost` are null until a run settles; those runs sort before recorded values in ascending order and after them in descending order. Only `startedAt` can order Chat and Sim-agent job runs, so any other value is rejected when job runs are included. Defaults to "startedAt". Accepted values: `startedAt`, `durationMs`, `cost`, `status`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--folder <value...>`	No	Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: listLogs.

sim logs follow

Watch runs live as they arrive, printing each new run once

Code

sim logs follow [options]

Options

Option	Required	Description
`--workflow <id>`	No	Only follow runs of this workflow (repeatable).
`--folder <path>`	No	Only follow runs of workflows in this folder (repeatable).
`--trigger <type>`	No	Only follow runs with this trigger type (repeatable).
`--level <level>`	No	Only follow runs at this severity. Accepted values: `info`, `error`.
`--details <level>`	No	Response detail level; full names each run’s workflow. Accepted values: `basic`, `full`. Defaults to `full`.
`-n, --lines <count>`	No	Recent runs to print before watching. Defaults to `10`.
`--interval <seconds>`	No	Seconds between polls. Defaults to `3`.

Each run prints once, when it is first seen, so its status is the status it had at that moment. With --output json every run is a JSON object on its own line (JSONL) rather than a member of an array, because a follow never ends and so can never close one; --output yaml emits a --- separated document stream. Progress and retries go to stderr, leaving stdout a clean stream of rows. Ctrl-C stops the follow.

Examples

Code

sim logs follow --level error
sim logs follow --workflow 00000000-0000-4000-8000-000000000000 -n 0
sim --output json logs follow | jq -r '.runId'

API request and response schemas: listLogs.

sim mcp-servers

Connect external Model Context Protocol (MCP) servers so workflows can use their tools.

To serve Sim workflows to MCP clients instead, use workflow MCP servers.

Also spelled sim mcp-server.

sim mcp-servers create

Create MCP server

Code

sim mcp-servers create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Server display name.
`--description <value>`	No	Optional server description.
`--transport <value>`	No	Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`.
`--url <value>`	Yes	Absolute HTTP or HTTPS endpoint URL without `{{ENV_VAR}}` references. It determines server identity and is immutable: delete and recreate the server to change endpoints.
`--auth-type <value>`	No	Authentication method. On creation, omission without `headers` probes once: an OAuth challenge selects `oauth`, an unauthenticated success selects `none`, and other outcomes fall back to `headers`. An OAuth client ID selects `oauth` when the method is omitted. Set explicitly to use headers with a server advertising OAuth; adding headers later does not change the saved method. Accepted values: `none`, `headers`, `oauth`.
`--headers <json\|@file>`	No	Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).
`--timeout <value>`	No	Per-request timeout in milliseconds. Defaults to 30000 on creation.
`--retries <value>`	No	Number of retries per request. Defaults to 3 on creation.
`--enabled`	No	Whether workflows can use the server's tools. Defaults to true on creation.
`--no-enabled`	No	Send --enabled as false.
`--oauth-client-id <value>`	No	Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.
`--oauth-client-secret <value>`	No	Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null).

API request and response schemas: createMcpServer.

sim mcp-servers delete

Delete MCP server

This removes the MCP server and the tools it provides.

Code

sim mcp-servers delete <mcpServerId> [options]

Arguments

Argument	Required	Description
`mcpServerId`	Yes	Unique MCP server identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteMcpServer.

sim mcp-servers get

Get MCP server

Code

sim mcp-servers get <mcpServerId>

Arguments

Argument	Required	Description
`mcpServerId`	Yes	Unique MCP server identifier.

API request and response schemas: getMcpServer.

sim mcp-servers list

List MCP servers

Code

sim mcp-servers list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the server name.
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listMcpServers.

sim mcp-servers tools list

List MCP server tools (OAuth login or personal API key required)

Code

sim mcp-servers tools list <mcpServerId> [options]

Arguments

Argument	Required	Description
`mcpServerId`	Yes	Unique MCP server identifier.

Options

Option	Required	Description
`--refresh`	No	Refresh tools using your credentials. Otherwise results may reuse another workspace member's recent discovery and omit newly added tools.
`--no-refresh`	No	Send --refresh as false.

API request and response schemas: listMcpServerTools.

sim mcp-servers update

Update MCP server

Code

sim mcp-servers update <mcpServerId> [options]

Arguments

Argument	Required	Description
`mcpServerId`	Yes	Unique MCP server identifier.

Options

Option	Required	Description
`--name <value>`	No	Server display name.
`--description <value>`	No	Optional server description.
`--transport <value>`	No	Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`.
`--url <value>`	No	Immutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints.
`--auth-type <value>`	No	Authentication method. On creation, omission without `headers` probes once: an OAuth challenge selects `oauth`, an unauthenticated success selects `none`, and other outcomes fall back to `headers`. An OAuth client ID selects `oauth` when the method is omitted. Set explicitly to use headers with a server advertising OAuth; adding headers later does not change the saved method. Accepted values: `none`, `headers`, `oauth`.
`--headers <json\|@file>`	No	Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).
`--timeout <value>`	No	Per-request timeout in milliseconds. Defaults to 30000 on creation.
`--retries <value>`	No	Number of retries per request. Defaults to 3 on creation.
`--enabled`	No	Whether workflows can use the server's tools. Defaults to true on creation.
`--no-enabled`	No	Send --enabled as false.
`--oauth-client-id <value>`	No	Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.
`--oauth-client-secret <value>`	No	Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null).

API request and response schemas: updateMcpServer.

sim meta

Inspect API availability and the calling credential’s type and expiry.

sim meta status

Show API availability and the calling credential’s type and expiry

Code

sim meta status

API request and response schemas: getMeta.

sim organizations

Manage organization membership, invitations, usage, access requests, and SSO.

sim organizations domains add

Add organization domain (OAuth login or personal API key required)

Code

sim organizations domains add [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--domain <value>`	Yes	Domain to claim and verify through a DNS TXT record.

API request and response schemas: addOrganizationDomain.

sim organizations domains list

List organization domains (OAuth login or personal API key required)

Code

sim organizations domains list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "domain". Accepted values: `domain`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listOrganizationDomains.

sim organizations domains remove

Remove organization domain (OAuth login or personal API key required)

This removes the domain claim and revokes verified SSO authority for its providers.

Code

sim organizations domains remove <domainId> [options]

Arguments

Argument	Required	Description
`domainId`	Yes	Domain claim owned by this organization.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removeOrganizationDomain.

sim organizations domains verify

Verify organization domain (OAuth login or personal API key required)

Code

sim organizations domains verify <domainId> [options]

Arguments

Argument	Required	Description
`domainId`	Yes	Domain claim owned by this organization.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: verifyOrganizationDomain.

sim organizations access-requests cancel

Cancel organization access request (OAuth login or personal API key required)

Code

sim organizations access-requests cancel <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: cancelOrganizationAccessRequest.

sim organizations access-requests create

Create organization access request (OAuth login or personal API key required)

Code

sim organizations access-requests create [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--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. Defaults to "".

API request and response schemas: createOrganizationAccessRequest.

sim organizations access-requests discover

Discover organization access requests (OAuth login or personal API key required)

Code

sim organizations access-requests discover [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--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. Defaults to "label". Accepted values: `label`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". 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.

API request and response schemas: discoverOrganizationAccessRequests.

sim organizations access-requests settings get

Get organization access request settings (OAuth login or personal API key required)

Code

sim organizations access-requests settings get [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationAccessRequestSettings.

sim organizations access-requests settings update

Update organization access request settings (OAuth login or personal API key required)

Code

sim organizations access-requests settings update [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--allow-requests <true\|false>`	Yes	Allow new requests and approvals. Disabling requests preserves history and still allows cancellation and decline. Accepted values: `true`, `false`.

API request and response schemas: updateOrganizationAccessRequestSettings.

sim organizations access-requests mine

List my organization access requests (OAuth login or personal API key required)

Code

sim organizations access-requests mine [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--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. Defaults to "createdAt". Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". 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.

API request and response schemas: listMyOrganizationAccessRequests.

sim organizations access-requests list

List organization access requests (OAuth login or personal API key required)

Code

sim organizations access-requests list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--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. Defaults to "createdAt". Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". 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.
`--search <value>`	No	Case-insensitive substring match against the target label or requester name or email.

API request and response schemas: listOrganizationAccessRequests.

sim organizations access-requests preview

Preview organization access request (OAuth login or personal API key required)

Code

sim organizations access-requests preview <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: previewOrganizationAccessRequest.

sim organizations access-requests resolve

Resolve organization access request (OAuth login or personal API key required)

Code

sim organizations access-requests resolve <requestId> [options]

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--action <value>`	Yes	apply: Apply the reviewed change to the governing group or member credit cap. decline: Decline the request without changing permissions or credit limits. Accepted values: `apply`, `decline`.
`--expected-fingerprint <value>`	Conditional	Fingerprint from Preview Organization Access Request. Review its changes and impact before applying; a stale preview returns a conflict. Available when action is apply. Required when action is apply.
`--new-limit-credits <value>`	Conditional	Required only for a usage-limit request: a whole-number credit cap greater than the current cap. Omit for permission requests. Available when action is apply.
`--reason <value>`	Conditional	Required explanation for declining this request. Available when action is decline. Required when action is decline.

API request and response schemas: resolveOrganizationAccessRequest.

sim organizations invitations create

Create organization invitation (OAuth login or personal API key required)

Code

sim organizations invitations create [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--email <value>`	Yes	Email address of the person to invite.
`--role <value>`	No	Organization role to offer. Defaults to member; grants no workspace-specific permissions. Accepted values: `member`, `admin`.

API request and response schemas: createOrganizationInvitation.

sim organizations invitations get

Get organization invitation (OAuth login or personal API key required)

Code

sim organizations invitations get <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationInvitation.

sim organizations invitations list

List organization invitations (OAuth login or personal API key required)

Code

sim organizations invitations list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the invitee email.
`--status <value>`	No	Filter by current invitation status. Omit to include all statuses. Accepted values: `pending`, `accepted`, `rejected`, `cancelled`, `expired`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `email`, `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". 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.

API request and response schemas: listOrganizationInvitations.

sim organizations invitations workspaces

List organization invitation workspaces (OAuth login or personal API key required)

Code

sim organizations invitations workspaces <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the workspace name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". 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.

API request and response schemas: listOrganizationInvitationWorkspaces.

sim organizations invitations resend

Resend organization invitation (OAuth login or personal API key required)

Code

sim organizations invitations resend <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: resendOrganizationInvitation.

sim organizations invitations revoke

Revoke organization invitation (OAuth login or personal API key required)

This cancels the invitation and all its workspace grants, preventing acceptance.

Code

sim organizations invitations revoke <invitationId> [options]

Arguments

Argument	Required	Description
`invitationId`	Yes	Invitation identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: revokeOrganizationInvitation.

sim organizations sso providers delete

Delete SSO provider (OAuth login or personal API key required)

This removes the identity provider used for SSO sign-in; linked accounts remain.

Code

sim organizations sso providers delete <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSsoProvider.

sim organizations sso providers get

Get SSO provider (OAuth login or personal API key required)

Code

sim organizations sso providers get <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getSsoProvider.

sim organizations sso providers list

List SSO providers (OAuth login or personal API key required)

Code

sim organizations sso providers list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "providerId". Accepted values: `providerId`, `domain`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listSsoProviders.

sim organizations sso providers save

Save SSO provider (OAuth login or personal API key required)

Choose --provider-type oidc or saml. OIDC requires --client-id and --client-secret; SAML requires --entry-point and --cert. Both require an organization-verified domain. The option descriptions state which omitted fields are preserved or cleared.

Code

sim organizations sso providers save [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--provider-type <value>`	Yes	oidc: Configure an OpenID Connect identity provider. saml: Configure a SAML identity provider. Accepted values: `oidc`, `saml`.
`--provider-id <value>`	Yes	Globally unique provider ID; saving an existing provider replaces its supplied configuration.
`--issuer <value>`	Yes	Identity provider issuer URL.
`--domain <value>`	Yes	Email domain already verified by this organization.
`--jit-provisioning-enabled`	No	Allow SSO sign-in to provision organization membership, subject to eligibility and available seats. Defaults to true.
`--no-jit-provisioning-enabled`	No	Send --jit-provisioning-enabled as false.
`--mapping <json\|@file>`	No	Identity-provider claims mapped to user fields. Defaults to {"id":"sub","email":"email","name":"name","image":"picture"}. (JSON, or @path / @- to read a file or stdin).
`--client-id <value>`	Conditional	Identity provider client identifier. Available when providerType is oidc. Required when providerType is oidc.
`--client-secret <value\|@file>`	Conditional	Write-only OIDC client secret; the redacted marker from providers get preserves an existing secret. Passing it inline exposes it to shell history and process listings. Required when --provider-type is oidc (@path / @- reads a file or stdin verbatim, including trailing newlines; @@value for a literal leading @).
`--scopes <json\|@file>`	No	OIDC scopes; offline_access is omitted. Available when providerType is oidc. Defaults to ["openid","profile","email"]. (JSON, or @path / @- to read a file or stdin).
`--pkce`	No	Use PKCE for the authorization flow. Available when providerType is oidc. Defaults to true.
`--no-pkce`	No	Send --pkce as false.
`--authorization-endpoint <value>`	No	Optional authorization endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--token-endpoint <value>`	No	Optional token endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--user-info-endpoint <value>`	No	Optional UserInfo endpoint. Available when providerType is oidc.
`--skip-user-info-endpoint`	No	Read identity claims from the ID token instead of calling UserInfo. Available when providerType is oidc. Defaults to false.
`--no-skip-user-info-endpoint`	No	Send --skip-user-info-endpoint as false.
`--jwks-endpoint <value>`	No	Optional signing-key endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc.
`--entry-point <value>`	Conditional	Identity provider SAML sign-in endpoint. Available when providerType is saml. Required when providerType is saml.
`--cert <value>`	Conditional	Identity provider signing certificate. Available when providerType is saml. Required when providerType is saml.
`--callback-url <value>`	No	SAML callback URL; defaults to this provider’s Sim callback. Available when providerType is saml.
`--audience <value>`	No	SAML audience; omission preserves the saved value. Available when providerType is saml.
`--want-assertions-signed`	No	Require signed assertions; omission preserves the saved value. Available when providerType is saml.
`--no-want-assertions-signed`	No	Send --want-assertions-signed as false.
`--signature-algorithm <value>`	No	Signature algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml.
`--digest-algorithm <value>`	No	Digest algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml.
`--identifier-format <value>`	No	SAML NameID format; omission clears the saved value. Available when providerType is saml.
`--idp-metadata <value>`	No	Identity provider metadata XML; omission clears the saved document. Available when providerType is saml.

API request and response schemas: saveSsoProvider.

sim organizations sso providers primary

Set primary SSO provider (OAuth login or personal API key required)

Code

sim organizations sso providers primary <providerId> [options]

Arguments

Argument	Required	Description
`providerId`	Yes	Identity provider identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: setPrimarySsoProvider.

sim organizations sso policy get

Get SSO policy (OAuth login or personal API key required)

Code

sim organizations sso policy get [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getSsoPolicy.

sim organizations sso policy update

Update SSO policy (OAuth login or personal API key required)

Code

sim organizations sso policy update [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--require-sso <true\|false>`	Yes	Require organization SSO on future sign-ins; existing sessions remain active. Accepted values: `true`, `false`.

API request and response schemas: updateSsoPolicy.

sim organizations get

Get organization (OAuth login or personal API key required)

Code

sim organizations get <organizationId>

Arguments

Argument	Required	Description
`organizationId`	Yes	Organization identifier.

API request and response schemas: getOrganization.

sim organizations members usage-limit get

Get organization member credit limit (OAuth login or personal API key required)

Code

sim organizations members usage-limit get <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getOrganizationMemberUsageLimit.

sim organizations members usage-limit update

Update organization member credit limit (OAuth login or personal API key required)

Code

sim organizations members usage-limit update <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--credit-limit <number\|null>`	Yes	Credit cap for this person. Send null to clear the cap or 0 to prevent further credit-consuming usage. Organization limits still apply.

API request and response schemas: updateOrganizationMemberUsageLimit.

sim organizations members list

List organization members (OAuth login or personal API key required)

Code

sim organizations members list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against member name or email.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `email`, `joinedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizationMembers.

sim organizations members remove

Remove organization member (OAuth login or personal API key required)

This removes the member, revokes their organization workspace access, and ends their sessions.

Code

sim organizations members remove <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User identifier of the organization member.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removeOrganizationMember.

sim organizations members update

Update organization member (OAuth login or personal API key required)

Code

sim organizations members update <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User identifier of the organization member.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--role <value>`	Yes	New organization role. Ownership transfers use a separate operation. Accepted values: `member`, `admin`.

API request and response schemas: updateOrganizationMember.

sim organizations usage breakdown

Get organization usage breakdown (OAuth login or personal API key required)

Code

sim organizations usage breakdown [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.
`--dimension <value>`	Yes	Usage grouping dimension. Accepted values: `member`, `workspace`, `workflow`, `model`, `byok`, `source`.
`--limit <value>`	No	Maximum ranked groups to return. Remaining usage is summarized in other. Must be a whole number from 1 to 100. Defaults to 50.

API request and response schemas: getOrganizationUsageBreakdown.

sim organizations usage summary

Get organization usage summary (OAuth login or personal API key required)

Code

sim organizations usage summary [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.

API request and response schemas: getOrganizationUsageSummary.

sim organizations usage events

List organization usage events (OAuth login or personal API key required)

Code

sim organizations usage events [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--preset <value>`	No	Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Defaults to "30d". Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`.
`--start-date <value>`	No	First calendar date included, in the selected timezone. Requires preset=custom.
`--end-date <value>`	No	Last calendar date included, in the selected timezone. Requires preset=custom.
`--timezone <value>`	No	IANA timezone for calendar boundaries; defaults to UTC.
`--source <value>`	No	Restrict events to one product surface. Accepted values: `workflow`, `wand`, `sim-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`.
`--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	Field used to sort the result. Defaults to "createdAt". Accepted values: `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.

API request and response schemas: listOrganizationUsageEvents.

sim organizations list

List organizations (OAuth login or personal API key required)

Code

sim organizations list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the organization name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizations.

sim organizations workspaces

List organization workspaces (OAuth login or personal API key required)

Code

sim organizations workspaces [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the workspace name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listOrganizationWorkspaces.

sim permission-groups

Manage organization permission groups, their configuration, and member assignments.

Use the linked API request schema for the supported --config keys. Supplied arrays replace their entire lists; omitted settings remain unchanged on update.

Also spelled sim permission-group.

sim permission-groups members add

Add permission group member (OAuth login or personal API key required)

Code

sim permission-groups members add [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--group <value>`	Yes	Permission group identifier.
`--user <value>`	Yes	Existing organization member to add.

API request and response schemas: addPermissionGroupMember.

sim permission-groups members batch-add

Bulk add permission group members (OAuth login or personal API key required)

Code

sim permission-groups members batch-add [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--group <value>`	Yes	Permission group identifier.
`--user <value...>`	No	User IDs to add; cannot be combined with --all-members (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--all-members`	No	Add every current organization member; cannot be combined with --user.

API request and response schemas: bulkAddPermissionGroupMembers.

sim permission-groups members list

List permission group members (OAuth login or personal API key required)

Code

sim permission-groups members list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--group <value>`	Yes	Permission group identifier.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "assignedAt". Accepted values: `assignedAt`, `userId`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listPermissionGroupMembers.

sim permission-groups members remove

Remove permission group member (OAuth login or personal API key required)

This removes the member assignment and changes which permission groups apply to the user.

Code

sim permission-groups members remove <userId> [options]

Arguments

Argument	Required	Description
`userId`	Yes	User identifier of the member to remove.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--group <value>`	Yes	Permission group identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: removePermissionGroupMember.

sim permission-groups create

Create permission group (OAuth login or personal API key required)

Code

sim permission-groups create [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--name <value>`	Yes	Group name, unique within the organization.
`--description <value>`	No	Optional group description.
`--config <json\|@file>`	No	Group settings to set. Omitted keys use the default permission configuration. (JSON, or @path / @- to read a file or stdin).
`--default`	No	Whether the group is the organization default. Only one group can be the default.
`--no-default`	No	Send --default as false.
`--workspace-ids <json\|@file>`	Conditional	Workspace IDs targeted by a non-default group. Required when creating a non-default group; omit for a default group. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: createPermissionGroup.

sim permission-groups delete

Delete permission group (OAuth login or personal API key required)

This permanently deletes the permission group and its member assignments.

Code

sim permission-groups delete <groupId> [options]

Arguments

Argument	Required	Description
`groupId`	Yes	Permission group identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deletePermissionGroup.

sim permission-groups get

Get permission group (OAuth login or personal API key required)

Code

sim permission-groups get <groupId> [options]

Arguments

Argument	Required	Description
`groupId`	Yes	Permission group identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.

API request and response schemas: getPermissionGroup.

sim permission-groups list

List permission groups (OAuth login or personal API key required)

Code

sim permission-groups list [options]

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--search <value>`	No	Case-insensitive substring match against the group name.
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listPermissionGroups.

sim permission-groups update

Update permission group (OAuth login or personal API key required)

Code

sim permission-groups update <groupId> [options]

Arguments

Argument	Required	Description
`groupId`	Yes	Permission group identifier.

Options

Option	Required	Description
`--organization <value>`	Yes	Organization identifier.
`--name <value>`	No	Group name, unique within the organization.
`--description <value>`	No	Group description. Null or an empty string clears it; omission leaves it unchanged. (--description null sends the word, not JSON null).
`--config <json\|@file>`	No	Patch of group settings. Omitted keys remain unchanged; each supplied array replaces that entire list. (JSON, or @path / @- to read a file or stdin).
`--default`	No	Whether the group is the organization default. Only one group can be the default.
`--no-default`	No	Send --default as false.
`--workspace-ids <json\|@file>`	No	Workspace identifiers for a non-default group. Required on creation; an empty update makes the group inactive. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: updatePermissionGroup.

sim sandboxes

Manage reusable dependency sets for Function blocks.

Also spelled sim sandbox.

sim sandboxes create

Create sandbox (OAuth login or personal API key required)

Code

sim sandboxes create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Display name, unique within the workspace; 1 to 64 characters.
`--language <value>`	Yes	Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`.
`--dependencies <value...>`	No	Package specifiers installed into the sandbox, one per entry. Defaults to []. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @).
`--cli-tools <value...>`	No	Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. Defaults to []. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--system-packages <value...>`	No	Debian packages installed into the sandbox, one per entry. Defaults to []. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @).

API request and response schemas: createSandbox.

sim sandboxes delete

Delete sandbox (OAuth login or personal API key required)

This deletes the sandbox; Function blocks that select it fail until re-pointed.

Code

sim sandboxes delete <sandboxId> [options]

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSandbox.

sim sandboxes get

Get sandbox

Code

sim sandboxes get <sandboxId>

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

API request and response schemas: getSandbox.

sim sandboxes list

List sandboxes

Code

sim sandboxes list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the sandbox name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listSandboxes.

sim sandboxes update

Update sandbox (OAuth login or personal API key required)

Code

sim sandboxes update <sandboxId> [options]

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

Options

Option	Required	Description
`--name <value>`	No	New display name, unique within the workspace; 1 to 64 characters.
`--language <value>`	No	Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`.
`--dependencies <value...>`	No	Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @).
`--cli-tools <value...>`	No	Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--system-packages <value...>`	No	Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @).

API request and response schemas: updateSandbox.

sim secrets

Set and manage workspace or personal secrets.

Personal secrets belong to the caller across workspaces. Workspace secrets are shared resources. Listings include stored values only for workspace secrets marked visible (unredacted); all other entries contain metadata.

Also spelled sim secret.

sim secrets delete

Delete secret (OAuth login or personal API key required)

This deletes the secret; anything using it may stop working.

Code

sim secrets delete <name> [options]

Arguments

Argument	Required	Description
`name`	Yes	Secret to delete.

Options

Option	Required	Description
`--scope <value>`	Yes	Whether the secret belongs to the workspace or to the caller. A personal secret belongs to the caller across every workspace, not to one workspace. Accepted values: `workspace`, `personal`.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSecret.

sim secrets list

List secrets (OAuth login or personal API key required)

Code

sim secrets list [options]

Options

Option	Required	Description
`--scope <value>`	No	Restrict results to one ownership scope. Accepted values: `workspace`, `personal`.
`--search <value>`	No	Case-insensitive substring match against the secret name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listSecrets.

sim secrets set

Create or replace a named secret, such as an API key or environment variable (OAuth login or personal API key required)

Code

sim secrets set <name> [options]

Arguments

Argument	Required	Description
`name`	Yes	Secret name, as referenced in workflows

Options

Option	Required	Description
`--scope <scope>`	Yes	Secret ownership scope. Accepted values: `workspace`, `personal`.
`--value <value\|@file>`	No	Secret value. Passing it inline exposes it to shell history and process listings; @path reads it from a file and @- from stdin, verbatim — a trailing newline is part of the value, so write the file with printf rather than echo. Prefix a literal leading @ with a second one.
`--description <description>`	No	What the secret is for, shown to teammates; workspace scope only. Omit to leave an existing description unchanged.
`--unredacted`	No	Opt the workspace secret out of redaction: its value then appears in plaintext in run logs, model-visible content, and files, including publicly shared log links. Workspace scope only — sending it for a personal secret is rejected. Omit it to leave the current setting untouched. Pass --no-unredacted to restore redaction.
`--no-unredacted`	No	Send --unredacted as false.

Omit --value to enter it privately in a terminal. For an existing workspace secret, passing only --description or a redaction flag keeps the stored value and does not prompt. Personal secrets always require a value; they accept no writable metadata. In scripts, pass --value @path or --value @-.

API request and response schemas: setSecret.

sim selectors

Discover destination options for registered fields, such as calendars, channels, and tables.

A selector key identifies the field’s option source. Its context accepts only declared dependencies; missing OAuth access requires a person to authorize the connection.

sim selectors get

Get selector option (OAuth login or personal API key required)

Code

sim selectors get [options]

Options

Option	Required	Description
`--selector-key <value>`	Yes	Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`.
`--context <json\|@file>`	No	Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin).
`--id <value>`	Yes	Provider option ID to resolve with the same selector and declared context.

API request and response schemas: getSelector.

sim selectors list

List selector options (OAuth login or personal API key required)

Code

sim selectors list [options]

Options

Option	Required	Description
`--selector-key <value>`	Yes	Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`.
`--context <json\|@file>`	No	Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin).
`--search <value>`	No	Provider option search text.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.

API request and response schemas: listSelector.

sim skills

Create reusable agent instructions and manage their editors.

Also spelled sim skill.

sim skills create

Create skill (OAuth login or personal API key required)

Code

sim skills create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Kebab-case name, unique within the workspace and not reserved by a built-in skill.
`--description <value>`	Yes	One-line summary of when the skill applies.
`--content <value>`	Yes	Skill body containing the instructions given to the agent.

API request and response schemas: createSkill.

sim skills delete

Delete skill (OAuth login or personal API key required)

This deletes the skill.

Code

sim skills delete <skillId> [options]

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSkill.

sim skills get

Get skill

Code

sim skills get <skillId>

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

API request and response schemas: getSkill.

sim skills editors create

Grant skill editor (OAuth login or personal API key required)

Code

sim skills editors create <skillId> [options]

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

Options

Option	Required	Description
`--email <value>`	Yes	Email address of a current workspace member.

API request and response schemas: grantSkillEditor.

sim skills editors list

List skill editors

Code

sim skills editors list <skillId> [options]

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

Options

Option	Required	Description
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "email". Accepted values: `email`, `name`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listSkillEditors.

sim skills editors delete

Revoke skill editor (OAuth login or personal API key required)

This revokes the explicit skill editor grant for the selected email.

Code

sim skills editors delete <skillId> [options]

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

Options

Option	Required	Description
`--email <value>`	Yes	Email address of a current workspace member.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: revokeSkillEditor.

sim skills list

List skills

Code

sim skills list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the skill name.
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listSkills.

sim skills update

Update skill (OAuth login or personal API key required)

Code

sim skills update <skillId> [options]

Arguments

Argument	Required	Description
`skillId`	Yes	Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`.

Options

Option	Required	Description
`--name <value>`	No	New kebab-case skill name.
`--description <value>`	No	New one-line summary of when the skill applies.
`--content <value>`	No	Replacement skill body.

API request and response schemas: updateSkill.

sim tables

Manage tables, rows, schemas, views, enrichment runs, imports, and exports.

Also spelled sim table.

sim tables columns create

Add column

Code

sim tables columns create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--column <json\|@file>`	Yes	Column definition to add. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: addTableColumn.

sim tables columns delete

Delete column

This deletes the column and its values in every row.

Code

sim tables columns delete <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--column-name <value>`	Yes	Name of the column to delete.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTableColumn.

sim tables columns update

Update column

Code

sim tables columns update <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--column-name <value>`	Yes	Current name of the column to update.
`--updates <json\|@file>`	Yes	Mutable column fields. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: updateTableColumn.

sim tables groups create

Add workflow group

Code

sim tables groups create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--group <json\|@file>`	Yes	Workflow or enrichment producer definition. (JSON, or @path / @- to read a file or stdin).
`--output-columns <json\|@file>`	No	Columns to create for producer outputs. An entry naming a column the table already has attaches that column to the group instead of creating it (its `type` must match), and an output whose column already exists may omit its entry entirely — so `[]` attaches existing columns only. Defaults to []. (JSON, or @path / @- to read a file or stdin).
`--auto-run`	No	Whether to schedule existing rows after group creation. Defaults to false.
`--no-auto-run`	No	Send --auto-run as false.

API request and response schemas: addWorkflowGroup.

sim tables groups delete

Delete workflow group

This deletes the group AND its output columns with all of their row data; the workflow it pointed at is untouched.

Code

sim tables groups delete <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--group-id <value>`	Yes	Workflow group to delete.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteWorkflowGroup.

sim tables groups list

List workflow groups

Code

sim tables groups list <tableId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

API request and response schemas: listWorkflowGroups.

sim tables groups update

Update workflow group

Code

sim tables groups update <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--group-id <value>`	Yes	Workflow group to update.
`--workflow-id <value>`	No	Replacement backing workflow identifier.
`--name <value>`	No	Replacement workflow-group display name.
`--dependencies <json\|@file>`	No	Replacement input dependencies. (JSON, or @path / @- to read a file or stdin).
`--outputs <json\|@file>`	No	Replacement producer outputs. (JSON, or @path / @- to read a file or stdin).
`--new-output-columns <json\|@file>`	No	Columns to add for new outputs. (JSON, or @path / @- to read a file or stdin).
`--mapping-updates <json\|@file>`	No	Existing output-column mapping changes. (JSON, or @path / @- to read a file or stdin).
`--input-mappings <json\|@file>`	No	Replacement workflow input mappings. (JSON, or @path / @- to read a file or stdin).
`--deployment-mode <value>`	No	Replacement workflow execution mode. Accepted values: `live`, `deployed`.
`--type <value>`	No	Workflow-group producer type. Must match the group's stored type — a group's producer cannot be changed after creation. Accepted values: `manual`, `enrichment`.
`--auto-run`	No	Replacement automatic-run setting.
`--no-auto-run`	No	Send --auto-run as false.

API request and response schemas: updateWorkflowGroup.

sim tables batch-delete

Bulk delete tables and folders

This archives the selected tables and folders, including their rows. Restore eligible tables with tables restore.

Code

sim tables batch-delete [options]

Options

Option	Required	Description
`--table-ids <json\|@file>`	No	Tables to archive, by identifier. Defaults to []. (JSON, or @path / @- to read a file or stdin).
`--folder <value...>`	No	Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: bulkDeleteTables.

sim tables rows update-each

Apply a distinct patch to each listed row

Code

sim tables rows update-each <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--updates <json\|@file>`	Yes	One merge patch per row. Each row identifier may appear at most once. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: bulkUpdateTableRows.

sim tables rows create

Create rows

Code

sim tables rows create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--data <json\|@file>`	No	One row keyed by column name (JSON, or @path / @-; choose exactly one body flag).
`--rows <json\|@file>`	No	Several rows keyed by column name (JSON, or @path / @-; choose exactly one body flag).

API request and response schemas: createTableRows.

sim tables rows delete

Delete row

This deletes the row.

Code

sim tables rows delete <tableId> <rowId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`rowId`	Yes	Unique table row identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTableRow.

sim tables rows batch-delete

Delete rows matching a filter, or an explicit list of ids

This deletes every matching row and cannot be undone.

Code

sim tables rows batch-delete <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--filter <json\|@file>`	No	Predicate: {"all":[{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--limit <value>`	No	Maximum matching rows to delete. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted).
`--row <value...>`	No	Explicit row identifiers to delete. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTableRows.

sim tables rows get

Get row

Code

sim tables rows get <tableId> <rowId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`rowId`	Yes	Unique table row identifier.

Options

Option	Required	Description
`--include-run-state`	No	Include per-workflow-group run outcomes on the row. Off by default. Run state above 2 MiB returns `413`; omit this option to read the row without run state.
`--no-include-run-state`	No	Send --include-run-state as false.

API request and response schemas: getTableRow.

sim tables rows list

List rows

Code

sim tables rows list <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

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.
`--include-run-state`	No	Include per-workflow-group run outcomes on every row. Off by default. Caps `limit` at 200. Run state above 2 MiB returns `413`; request fewer rows or omit run state.
`--no-include-run-state`	No	Send --include-run-state as false.

API request and response schemas: listTableRows.

sim tables rows query

Query rows with a filter and sort

Code

sim tables rows query <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--filter <json\|@file>`	No	Condition: {"field":"status","op":"eq","value":"active"}. Groups: {"all":[{"field":"status","op":"eq","value":"active"}]} or {"any":[{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--sort <json\|@file>`	No	Ordered sort keys: [{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin).
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--include-run-state`	No	Include per-workflow-group run outcomes on every row. Off by default. Each request above 2 MiB of run state returns 413; request fewer rows or omit run state. CLI --limit 0 still fetches bounded pages.
`--no-include-run-state`	No	Send --include-run-state as false.

API request and response schemas: queryRows.

sim tables rows count

Count rows matching a filter

Code

sim tables rows count <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--filter <json\|@file>`	No	Condition: {"field":"status","op":"eq","value":"active"}. Groups: {"all":[{"field":"status","op":"eq","value":"active"}]} or {"any":[{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).

API request and response schemas: queryRowsCount.

sim tables rows enrich

Run one row’s enrichment group

Code

sim tables rows enrich <tableId> <rowId> <groupId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`rowId`	Yes	Unique table row identifier.
`groupId`	Yes	Workflow or enrichment group to run.

API request and response schemas: runRowEnrichment.

sim tables rows search

Search cells for a value and return their coordinates

Code

sim tables rows search <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--query <value>`	Yes	Value to search for.
`--filter <json\|@file>`	No	Predicate: {"all":[{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--sort <json\|@file>`	No	Ordered sort keys: [{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin).

API request and response schemas: searchTableRows.

sim tables rows batch-update

Update every row matching a filter

This updates every matching row and cannot be undone.

Code

sim tables rows batch-update <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--filter <json\|@file>`	Yes	Predicate: {"all":[{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--data <json\|@file>`	Yes	Row-data patch applied to every matching row. (JSON, or @path / @- to read a file or stdin).
`--limit <value>`	No	Maximum matching rows to update. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: updateRowsByFilter.

sim tables rows update

Update row

Code

sim tables rows update <tableId> <rowId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`rowId`	Yes	Unique table row identifier.

Options

Option	Required	Description
`--data <json\|@file>`	Yes	Partial row-data patch keyed by column name. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: updateTableRow.

sim tables dispatches cancel

Cancel a running dispatch

This stops the dispatch. Cells already handed to the queue keep running — use tables cancel-runs to stop those.

Code

sim tables dispatches cancel <tableId> <dispatchId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`dispatchId`	Yes	Unique table run-dispatch identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: cancelTableDispatch.

sim tables dispatches create

Start a column or enrichment run

Code

sim tables dispatches create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--group-ids <value...>`	Yes	Workflow or enrichment groups to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--run-mode <value>`	No	Whether to run all or only incomplete cells. Defaults to "all". Accepted values: `all`, `incomplete`.
`--row-ids <value...>`	No	Explicit row subset to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--filter <json\|@file>`	No	Predicate: {"all":[{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--exclude-row-ids <value...>`	No	Rows excluded from a select-all run scope. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--max-rows <n>`	No	Stop after this many eligible rows have run (1-1,000,000). Omit for an unbounded run.

API request and response schemas: createTableDispatch.

sim tables dispatches get

Get run dispatch

Code

sim tables dispatches get <tableId> <dispatchId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`dispatchId`	Yes	Unique table run-dispatch identifier.

API request and response schemas: getTableDispatch.

sim tables dispatches list

List run dispatches

Code

sim tables dispatches list <tableId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

API request and response schemas: listTableDispatches.

sim tables exports cancel

Stop a running export

Code

sim tables exports cancel <tableId> <exportId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`exportId`	Yes	Unique table-export identifier.

API request and response schemas: cancelTableExport.

sim tables exports create

Create table export

Code

sim tables exports create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--format <value>`	No	Export file format. Defaults to "csv". Accepted values: `csv`, `json`.

API request and response schemas: createTableExport.

sim tables exports get

Get table export

Code

sim tables exports get <tableId> <exportId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`exportId`	Yes	Unique table-export identifier.

API request and response schemas: getTableExport.

sim tables exports download

Get the download URL for a finished export

Code

sim tables exports download <tableId> <exportId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`exportId`	Yes	Unique table-export identifier.

API request and response schemas: tableExportDownload.

sim tables imports cancel

Stop a running import

This stops the import between row batches, so whatever it already wrote stays and nothing resumes it. A replace import empties the table before its first batch, so cancelling one leaves only part of the new file; an append adds its rows again if you import the file a second time.

Code

sim tables imports cancel <importId> [options]

Arguments

Argument	Required	Description
`importId`	Yes	Unique table-import identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: cancelTableImport.

sim tables imports get

Get table import

Code

sim tables imports get <importId>

Arguments

Argument	Required	Description
`importId`	Yes	Unique table-import identifier.

API request and response schemas: getTableImport.

sim tables cancel-runs

Stop every running column job

This cancels running column jobs — the whole table with --scope all, one row with --scope row.

Code

sim tables cancel-runs <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--scope <value>`	Yes	Whether to cancel across the table or one row. Accepted values: `all`, `row`.
`--row-id <value>`	No	Row whose runs should be canceled for row scope.
`--filter <json\|@file>`	No	Predicate: {"all":[{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin).
`--exclude-row-ids <value...>`	No	Rows excluded from an all-scope cancellation. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: cancelTableRuns.

sim tables create

Create table

Code

sim tables create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Identifier: letters, numbers, and underscores; cannot start with a number.
`--description <value>`	No	Optional table description.
`--schema <json\|@file>`	Yes	Table schema: {"columns":[{"name":"email","type":"string"}]} (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: createTable.

sim tables folders create

Create a table folder at a path

Code

sim tables folders create <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: createTableFolder.

sim tables folders delete

Delete folder

This archives the table folder and, when recursive, everything inside it.

Code

sim tables folders delete <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

Options

Option	Required	Description
`--recursive`	No	Archive the folder and its descendants. Defaults to "false".
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTableFolder.

sim tables folders list

List table folders

Code

sim tables folders list [options]

Also available as sim tables folders ls.

Options

Option	Required	Description
`--parent <value>`	No	Direct parent folder path.
`--search <value>`	No	Case-insensitive substring match against the folder name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listTableFolders.

sim tables folders move

Rename or move a table folder

Code

sim tables folders move <path> <destination>

Also available as sim tables folders mv.

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional
`destination`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: relocateTableFolder.

sim tables folders restore

Restore an archived table folder

Code

sim tables folders restore <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: restoreTableFolder.

sim tables views create

Create view

Code

sim tables views create <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--name <value>`	Yes	Saved-view display name.
`--config <json\|@file>`	Yes	Saved filter, sort, and column-layout configuration. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: createTableView.

sim tables views delete

Delete view

This deletes the saved view and its filters.

Code

sim tables views delete <tableId> <viewId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`viewId`	Yes	Unique saved-view identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTableView.

sim tables views get

Get view

Code

sim tables views get <tableId> <viewId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`viewId`	Yes	Unique saved-view identifier.

API request and response schemas: getTableView.

sim tables views list

List views

Code

sim tables views list <tableId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

API request and response schemas: listTableViews.

sim tables views update

Update view

Code

sim tables views update <tableId> <viewId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`viewId`	Yes	Unique saved-view identifier.

Options

Option	Required	Description
`--name <value>`	No	Replacement saved-view display name.
`--config <json\|@file>`	No	Complete replacement saved-view configuration. (JSON, or @path / @- to read a file or stdin).
`--config-patch <json\|@file>`	No	Saved-view configuration fields to shallow-merge. (JSON, or @path / @- to read a file or stdin).
`--default`	No	Whether to promote this view to the table default.
`--no-default`	No	Send --default as false.

API request and response schemas: updateTableView.

sim tables delete

Delete table

This archives the table and all of its rows; restore with tables restore.

Code

sim tables delete <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteTable.

sim tables enrichment get

Get row group run

Code

sim tables enrichment get <tableId> <rowId> <groupId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`rowId`	Yes	Unique table row identifier.
`groupId`	Yes	Workflow or enrichment group to run.

API request and response schemas: getRowEnrichment.

sim tables get

Get table

Code

sim tables get <tableId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

API request and response schemas: getTable.

sim tables list

List tables

Code

sim tables list [options]

Options

Option	Required	Description
`--scope <value>`	No	Which lifecycle set to list: `active` (default) for live tables, `archived` for tables a delete archived and a table restore can bring back. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--search <value>`	No	Case-insensitive substring match against the resource name.
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listTables.

sim tables move

Move tables and folders

Code

sim tables move [options]

Options

Option	Required	Description
`--table-ids <json\|@file>`	No	Tables to move, by identifier. Defaults to []. (JSON, or @path / @- to read a file or stdin).
`--folder <value...>`	No	Table folders to move, by path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--to <value>`	No	Destination folder path; omit for root.

API request and response schemas: moveTables.

sim tables restore

Restore an archived table

Code

sim tables restore <tableId>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

API request and response schemas: restoreTable.

sim tables update

Update table

Code

sim tables update <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--name <value>`	No	Identifier: letters, numbers, and underscores; cannot start with a number.
`--description <value>`	No	Replacement table description, or null to clear it. (--description null sends the word, not JSON null).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: updateTable.

sim tables mv

Move a table to a folder

Code

sim tables mv <tableId> <folder>

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.
`folder`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: updateTable.

sim tables upsert

Insert a row, or replace the one matching a unique column

Code

sim tables upsert <tableId> [options]

Arguments

Argument	Required	Description
`tableId`	Yes	Unique table identifier.

Options

Option	Required	Description
`--data <json\|@file>`	Yes	Complete set of row cells keyed by column name. On the update branch this REPLACES the matched row: any column not present here is cleared, unlike a single-row update, which merges. (JSON, or @path / @- to read a file or stdin).
`--on <value>`	No	Unique column to resolve the conflict against.

API request and response schemas: upsertTableRow.

sim tables import

Import a CSV, into a new table by default

Choose exactly one source: a local CSV path or --file-id. For a new table imported with --file-id, supply --name. With --table-id, omit the new-table --name and --folder flags; --mode, --mapping, and --create-columns apply only to an existing table.

Replace mode deletes all existing rows before loading the CSV and cannot be undone. It requires --yes; cancellation leaves only the rows already imported.

The command watches the import by default. --no-wait returns a queued receipt. A completed import can still report rowsRejected, cellsRejected, and rejectedSamples; inspect them before accepting the result.

Code

sim tables import [path] [options]

Arguments

Argument	Required	Description
`path`	No	Local CSV file to import; choose exactly one source: this path or --file-id

Options

Option	Required	Description
`--name <name>`	Conditional	Name for a new table: letters, numbers, and underscores. A local CSV defaults to its sanitized filename; required with --file-id unless --table-id names an existing table.
`--table-id <id>`	No	Import into this existing table instead of creating one.
`--mode <append\|replace>`	No	How to write into --table-id (default: append). Accepted values: `append`, `replace`.
`--folder <path>`	No	Folder path for the new table, as shown in the app.
`--file-id <id>`	No	Import a file already in the workspace instead of a local path.
`--mapping <json\|@file>`	No	Column mapping (--table-id only).
`--create-columns <json\|@file>`	No	Columns to create (--table-id only).
`--timezone <iana>`	No	Timezone for date parsing, e.g. America/New_York.
`-y, --yes`	Conditional	Confirm this destructive operation (required with --mode replace).
`--no-wait`	No	Return once the import is queued instead of watching it.

API request and response schemas: createTableImport, createTableImportPartUrls, completeTableImport, cancelTableImport, getTableImport.

sim tables ls

List table resources and child folders together

Code

sim tables ls [path] [options]

Arguments

Argument	Required	Description
`path`	No	Folder path to list; defaults to the root folder

Options

Option	Required	Description
`--search <text>`	No	Filter folders and resources by name.
`--limit <n>`	No	Maximum combined items to return (0 for everything). Defaults to `0`.

API request and response schemas: listTables, listTableFolders.

sim tables mkdir

Create a table directory at a path

Code

sim tables mkdir <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path to create; the leading / is optional

API request and response schemas: createTableFolder.

sim tools

Find built-in tools, inspect their parameters, and run them.

Inspect a tool with sim tools get <toolId> before passing its parameters to sim tools execute.

sim tools execute

Run one built-in tool and print what it produced (OAuth login or personal API key required)

Code

sim tools execute <toolId> [options]

Arguments

Argument	Required	Description
`toolId`	Yes	Tool identifier. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The response echoes the resolved ID.

Options

Option	Required	Description
`--input <json\|@file>`	No	Tool arguments as JSON, keyed by the parameter ids `sim tools get <toolId>` lists. Defaults to {}. (JSON, or @path / @- to read a file or stdin).
`--credential-id <value>`	No	Credential to authenticate with, required for OAuth tools.
`--timeout <value>`	No	Seconds to wait before abandoning the call.

API request and response schemas: executeTool.

sim tools get

Get tool

Code

sim tools get <toolId>

Arguments

Argument	Required	Description
`toolId`	Yes	Tool identifier. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The response echoes the resolved ID.

API request and response schemas: getTool.

sim tools list

List tools

Code

sim tools list [options]

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against the tool id, name, and description.
`--hosted-api-key <value>`	No	Restrict to tools by how their API key is supplied. Accepted values: `always`, `conditional`, `none`.
`--oauth-provider <value>`	No	Restrict to tools that authenticate against this OAuth service.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "id". Accepted values: `id`, `name`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listTools.

sim workflow-mcp-servers

Serve deployed workflows as tools for Model Context Protocol (MCP) clients.

These servers expose Sim workflows. To connect a server that provides external tools, use MCP servers.

sim workflow-mcp-servers create

Create workflow MCP server (OAuth login or personal API key required)

Code

sim workflow-mcp-servers create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Server display name, shown to connecting MCP clients.
`--description <value>`	No	Optional server description.
`--is-public`	No	Whether the server accepts MCP clients without a Sim API key. Defaults to false; a public server lets anyone holding its URL execute the workflows it exposes.
`--no-is-public`	No	Send --is-public as false.
`--workflow <value...>`	No	Deployed workflows to expose as MCP tools on the new server. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: createWorkflowMcpServer.

sim workflow-mcp-servers delete

Delete workflow MCP server (OAuth login or personal API key required)

This deletes the MCP server, and any agent calling its tools loses access.

Code

sim workflow-mcp-servers delete <serverId> [options]

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteWorkflowMcpServer.

sim workflow-mcp-servers tools create

Deploy workflow as MCP tool (OAuth login or personal API key required)

Code

sim workflow-mcp-servers tools create <serverId> [options]

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.

Options

Option	Required	Description
`--workflow-id <value>`	Yes	Workflow to expose as an MCP tool. It must already be deployed.
`--tool-name <value>`	No	Name MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted.
`--tool-description <value>`	No	Description shown to MCP clients. Derived from the workflow name when omitted.
`--parameter-descriptions <json\|@file>`	No	Per-field description overrides applied to the schema generated from the deployed workflow inputs, as [{"name":"email","description":"Customer email address"}]. A name matching no input field is ignored (JSON, or @path / @- to read a file or stdin).

API request and response schemas: deployWorkflowMcpTool.

sim workflow-mcp-servers tools list

List workflow MCP tools (OAuth login or personal API key required)

Code

sim workflow-mcp-servers tools list <serverId>

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.

API request and response schemas: listWorkflowMcpTools.

sim workflow-mcp-servers tools delete

Undeploy workflow MCP tool (OAuth login or personal API key required)

This withdraws the tool, and any agent calling it loses access.

Code

sim workflow-mcp-servers tools delete <serverId> <workflowId> [options]

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.
`workflowId`	Yes	Workflow registered as an MCP tool on this server.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: undeployWorkflowMcpTool.

sim workflow-mcp-servers get

Get workflow MCP server (OAuth login or personal API key required)

Code

sim workflow-mcp-servers get <serverId>

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.

API request and response schemas: getWorkflowMcpServer.

sim workflow-mcp-servers list

List workflow MCP servers (OAuth login or personal API key required)

Code

sim workflow-mcp-servers list [options]

Options

Option	Required	Description
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listWorkflowMcpServers.

sim workflow-mcp-servers update

Update workflow MCP server (OAuth login or personal API key required)

Code

sim workflow-mcp-servers update <serverId> [options]

Arguments

Argument	Required	Description
`serverId`	Yes	Unique workflow-MCP server identifier.

Options

Option	Required	Description
`--name <value>`	No	Server display name, shown to connecting MCP clients.
`--description <value>`	No	New server description, or null to clear it. (--description null sends the word, not JSON null).
`--is-public`	No	Whether the server answers MCP clients without a Sim API key.
`--no-is-public`	No	Send --is-public as false.

API request and response schemas: updateWorkflowMcpServer.

sim workflows

Build, deploy, run, and inspect workflows from the terminal.

Also spelled sim workflow.

sim workflows activate create

Activate workflow version (OAuth login or personal API key required)

This changes which deployed version runs in production for every API and chat consumer.

Code

sim workflows activate create <workflowId> <version> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.
`version`	Yes	Numeric deployment version.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: activateWorkflowVersion.

sim workflows operations apply

Edit a workflow’s blocks, connections and settings with a batch of operations (OAuth login or personal API key required)

This edits the draft graph: the batch adds, edits, or deletes blocks and their edges as written.

Code

sim workflows operations apply <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--dry-run`	No	Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs.
`--no-dry-run`	No	Send --dry-run as false.
`--operations <json\|@file>`	Yes	Edits to apply, in a single batch, keyed by operation_type: [{"operation_type":"add","block_id":"my-fn","params":{"type":"function","name":"My Fn","inputs":{"code":"return {ok:true}"}}},{"operation_type":"edit","block_id":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, and insert_into_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin).
`--atomic`	No	Fail the whole batch when any operation is declined or any block input would be dropped. The default applies what it can and reports the rest in `skipped` and `inputValidationErrors`; `true` writes nothing and answers `409` instead.
`--no-atomic`	No	Send --atomic as false.
`--layout <value>`	No	Whether to reposition blocks the batch touched. `targeted` (default) nudges only the affected subgraph; `none` leaves every position exactly as supplied. Accepted values: `targeted`, `none`.
`--set-block-enabled <json\|@file>`	No	Blocks to enable or disable, applied after --operations: [{"block_id":"<uuid>","enabled":false}]. Disabling a loop or parallel cascades to its unlocked descendants; enabling a block whose container is disabled is declined (JSON, or @path / @- to read a file or stdin).
`-y, --yes`	Conditional	Confirm this operation (required unless --dry-run).

API request and response schemas: applyWorkflowOperations.

sim workflows variables update

Update workflow variables

This applies the listed variable changes; variables omitted from the operations remain unchanged.

Code

sim workflows variables update <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--operations <json\|@file>`	Yes	Variable changes to apply in order, keyed by operation: [{"operation":"add","name":"my_var","type":"string","value":"hello"},{"operation":"edit","name":"my_var","value":"updated"},{"operation":"delete","name":"my_var"}] (JSON, or @path / @- to read a file or stdin).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: applyWorkflowVariables.

sim workflows runs cancel

Cancel a running workflow run

Canceling a paused run prevents resuming that run. Starting a new run can repeat side effects already performed.

Code

sim workflows runs cancel <runId> [options]

Arguments

Argument	Required	Description
`runId`	Yes	Unique workflow run identifier.

Options

Option	Required	Description
`--workflow <workflowId>`	Yes	Workflow ID.

API request and response schemas: cancelWorkflowRun.

sim workflows runs get

Show run status (requested outputs are included in JSON or YAML output)

Code

sim workflows runs get <runId> [options]

Arguments

Argument	Required	Description
`runId`	Yes	Unique workflow run identifier.

Options

Option	Required	Description
`--workflow <workflowId>`	Yes	Workflow ID.
`--include-output`	No	Include the final output in JSON or YAML output.
`--select-output <value...>`	No	Include blockName.path or blockId.path values (e.g. agent_1.content) in JSON or YAML output; names resolve against the workflow’s current blocks, and missing paths are omitted (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--include-file-base64`	No	Inline each produced file's bytes as base64. Requires `includeOutput`. A file above the inline ceiling answers `413` naming its download path; fetch large files from `downloadPath` instead.
`--no-include-file-base64`	No	Send --include-file-base64 as false.
`--base64-max-bytes <value>`	No	Per-file inline ceiling, lowering but never raising the server limit of 16 MiB.

API request and response schemas: getWorkflowRun.

sim workflows runs list

List runs for a workflow

Code

sim workflows runs list [options]

Options

Option	Required	Description
`--workflow <workflowId>`	Yes	Workflow ID.
`--status <value>`	No	Filter by run status. Accepted values: `pending`, `running`, `completed`, `failed`, `cancelled`, `paused`.
`--trigger <value>`	No	Filter by trigger type.
`--start-date <value>`	No	Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--end-date <value>`	No	Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--order <value>`	No	Sort direction by run start time. This list is sortable only by run start time, so it takes `order` in place of `sortBy`/`sortOrder`, which it rejects. Defaults to "desc". Accepted values: `asc`, `desc`.

API request and response schemas: listWorkflowRuns.

sim workflows runs resume

Resume a paused run (output is included in JSON or YAML output)

Code

sim workflows runs resume <runId> [options]

Arguments

Argument	Required	Description
`runId`	Yes	Unique workflow run identifier.

Options

Option	Required	Description
`--workflow <workflowId>`	Yes	Workflow ID.
`--context <value>`	Yes	Pause context ID returned by run status.
`--input <json\|@file>`	No	Resume input as JSON (JSON, or @path / @- to read a file or stdin).

API request and response schemas: resumeWorkflow.

sim workflows runs wait

Wait until a run finishes or needs input

Code

sim workflows runs wait <runId> [options]

Arguments

Argument	Required	Description
`runId`	Yes	Unique workflow run identifier.

Options

Option	Required	Description
`--workflow <workflowId>`	Yes	Workflow ID.
`--wait-timeout <seconds>`	No	Give up after this many seconds, or 0 to wait indefinitely (default: 3600). Bounds the whole wait; SIM_TIMEOUT_SECONDS bounds one request.

Exit codes: 0 completed, 1 failed, 2 cancelled, 3 needs input, 4 timed out. Time-based pauses continue waiting; a human pause or an unspecified pause kind ends the wait with code 3. Use sim workflows runs resume with the pause context to continue.

API request and response schemas: getWorkflowRun.

sim workflows versions compare

Compare workflow versions

Code

sim workflows versions compare <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--base <value>`	Yes	Deployment version to compare from.
`--target <value>`	Yes	Deployment version to compare to, in the same workflow.

API request and response schemas: compareWorkflowVersions.

sim workflows versions get

Get workflow version

Code

sim workflows versions get <workflowId> <version>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.
`version`	Yes	Numeric deployment version.

API request and response schemas: getWorkflowVersion.

sim workflows versions list

List workflow versions

Code

sim workflows versions list <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

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.

API request and response schemas: listWorkflowVersions.

sim workflows versions update

Update workflow version

Code

sim workflows versions update <workflowId> <version> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.
`version`	Yes	Numeric deployment version.

Options

Option	Required	Description
`--name <value>`	No	New label for the deployment version.
`--description <value>`	No	New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null).

API request and response schemas: updateWorkflowVersion.

sim workflows create

Create workflow

Code

sim workflows create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Workflow name.
`--description <value>`	No	Optional workflow description.
`--folder <value>`	No	Existing folder path (leading / optional); create it first with sim workflows mkdir <path>.

API request and response schemas: createWorkflow.

sim workflows folders create

Create a workflow folder at a path

Code

sim workflows folders create <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: createWorkflowFolder.

sim workflows folders delete

Delete workflow folder

This archives the workflow folder and, when recursive, everything inside it.

Code

sim workflows folders delete <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

Options

Option	Required	Description
`--recursive`	No	Archive the folder and its descendants. Defaults to "false".
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteWorkflowFolder.

sim workflows folders list

List workflow folders

Code

sim workflows folders list [options]

Also available as sim workflows folders ls.

Options

Option	Required	Description
`--parent <value>`	No	Direct parent folder path.
`--search <value>`	No	Case-insensitive substring match against the folder name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listWorkflowFolders.

sim workflows folders move

Rename or move a workflow folder

Code

sim workflows folders move <path> <destination>

Also available as sim workflows folders mv.

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional
`destination`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: relocateWorkflowFolder.

sim workflows delete

Delete workflow

This archives the workflow and its run history; restore with workflows restore.

Code

sim workflows delete <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteWorkflow.

sim workflows chat unpublish

Take a workflow’s chat deployment offline (OAuth login or personal API key required)

This takes the chat offline and frees its identifier. The workflow itself stays deployed and executable.

Code

sim workflows chat unpublish <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteWorkflowChatDeployment.

sim workflows chat status

Show a workflow’s chat deployment (OAuth login or personal API key required)

Code

sim workflows chat status <workflowId>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

API request and response schemas: getWorkflowChatDeployment.

sim workflows chat publish

Deploy or replace a workflow chat (OAuth login or personal API key required)

This replaces visitor access settings for the chat deployment. Omitted authentication fields reset to defaults, including the password and allowed-email list; avatar and welcome-message behavior follows their option descriptions.

Omitting --auth-type selects public access: anyone holding the URL can chat. Supply the complete password or allow-list settings again when replacing a restricted deployment.

Code

sim workflows chat publish <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--identifier <value>`	Yes	URL slug the deployed chat answers on. Must be free across live deployments.
`--title <value>`	Yes	Title shown to visitors.
`--description <value>`	No	Description shown to visitors. Omitted clears it.
`--customizations <json\|@file>`	No	Presentation overrides. Omitted `primaryColor` and `welcomeMessage` use platform defaults; an omitted or empty `imageUrl` keeps the existing avatar. An empty `welcomeMessage` keeps the existing message. (JSON, or @path / @- to read a file or stdin).
`--auth-type <value>`	No	How visitors are gated. `public` leaves the chat open to anyone holding the URL. Defaults to "public". Accepted values: `public`, `password`, `email`, `sso`.
`--password <value>`	Conditional	Write-only password of 15 to 1024 characters, not only whitespace. Required whenever `authType` is `password`, and rejected otherwise. Never readable back. Taken literally, except that a request from the Sim agent resolves a whole-value `{{ENV_VAR}}` reference to that variable before the rules apply.
`--allowed-emails <json\|@file>`	No	Email addresses or domains admitted under `email` and `sso` gating. At least one is required for those modes. (JSON, or @path / @- to read a file or stdin).
`--output-configs <json\|@file>`	No	Block outputs to surface to visitors. Omitted surfaces none. (JSON, or @path / @- to read a file or stdin).
`--include-thinking`	No	Allow visitors to receive provider thinking events. Defaults to false.
`--no-include-thinking`	No	Send --include-thinking as false.
`--include-tool-calls`	No	Allow visitors to receive tool lifecycle events. Defaults to false.
`--no-include-tool-calls`	No	Send --include-tool-calls as false.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: replaceWorkflowChatDeployment.

sim workflows deploy

Deploy workflow (OAuth login or personal API key required)

Code

sim workflows deploy <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--name <value>`	No	Optional label for the deployment version.
`--description <value>`	No	Optional release note for the deployment version.

API request and response schemas: deployWorkflow.

sim workflows duplicate create

Duplicate workflow

Code

sim workflows duplicate create <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--name <value>`	No	Name for the copy. Defaults to the source name, deduplicated within the folder.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: duplicateWorkflow.

sim workflows run

Run a deployed workflow or execute saved state manually

Code

sim workflows run <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--input <json\|@file>`	No	Trigger input as JSON (JSON, or @path / @- to read a file or stdin).
`--async`	No	Queue the run and return immediately. Defaults to false.
`--execution-timeout-seconds <value>`	No	Maximum duration of the run in seconds, capped by the plan's execution timeout. Requires --async or --wait-timeout.
`--select-output <value...>`	No	Return blockName.path values (e.g. agent_1.content), or childWorkflowId.blockName.path for a child workflow (applies to every invocation) — in blockOutputs on a sync run, or from the streamed result with --follow; missing paths are omitted. Not available with --async (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--include-file-base64`	No	Inline eligible output files as base64 content. Defaults to true for the installed CLI; Chat defaults to file references and admits requested bytes only for synchronous runs. Rejected when async is true.
`--no-include-file-base64`	No	Send --include-file-base64 as false.
`--base64-max-bytes <value>`	No	Maximum total bytes of file content to inline as base64, lowering but never raising the server limit of 16 MiB. Rejected when `async` is true.
`--run-id <value>`	No	One-shot identifier for this run; NOT an idempotency key — reusing a claimed value fails with RUN_ID_CONFLICT instead of replaying the first result, and a fresh value starts another run.
`--manual`	No	Run the current saved workflow state instead of the active deployment.
`--trigger <blockId>`	No	Enter the run through this runnable trigger; runs the current saved workflow state (implies --manual).
`--mock-payload`	No	Use the selected trigger's server-derived mock payload; runs the current saved workflow state (implies --manual).
`--from-block <blockId>`	No	Run manually from this saved workflow block.
`--source-run <runId>`	No	Prior run whose persisted state supplies upstream outputs (requires --from-block).
`--stop-after <blockId>`	No	Stop the run after this saved block, failing it if the run takes a path that skips the block; with --from-block on the same block, re-runs only that block (implies --manual).
`--wait-timeout <seconds>`	No	Wait at most this many seconds for a synchronous run (0 waits until it settles). A run still going then continues in the background under async limits: the command prints its run record and exits 4, and `sim workflows runs wait` keeps waiting. Not with --async or --follow.
`--follow`	No	Stream the run as it happens; progress on stderr, result on stdout. The stream reports only success and output, so the result omits the run id and timings a non-streaming run returns.
`--include-thinking`	No	Show model reasoning while following (requires --follow).
`--include-tool-calls`	No	Show tool calls while following (requires --follow).

API request and response schemas: executeWorkflow.

sim workflows export

Print a workflow as a portable JSON document

The export clears credentials, passwords, and table sub-block values, but it is not a general secret scanner. Inspect literal variables and inline configuration before sharing the document.

Code

sim workflows export <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--include-references`	No	Include non-secret resource identities for mapped import.
`--include-workspace-bindings`	No	Keep non-secret table, knowledge base, document, folder, channel, and other workspace bindings for a same-workspace import. Defaults to false, which clears these IDs. Registered credential fields and opaque table/tool values are cleared either way; environment references and ordinary workflow variables remain included.
`--no-include-workspace-bindings`	No	Send --include-workspace-bindings as false.

API request and response schemas: exportWorkflow.

sim workflows get

Get workflow

Code

sim workflows get <workflowId>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

API request and response schemas: getWorkflow.

sim workflows deployment status

Show a workflow’s current deployment

Code

sim workflows deployment status <workflowId>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

API request and response schemas: getWorkflowDeployment.

sim workflows deployment update

Update workflow public API access (OAuth login or personal API key required)

Code

sim workflows deployment update <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--is-public-api <true\|false>`	Yes	Whether the deployed workflow should accept unauthenticated public API execution. Accepted values: `true`, `false`.

API request and response schemas: updateWorkflowPublicApi.

sim workflows state get

Get workflow state

Code

sim workflows state get <workflowId>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

API request and response schemas: getWorkflowState.

sim workflows state replace

Replace workflow state (OAuth login or personal API key required)

This replaces the entire draft graph and cannot be undone.

Code

sim workflows state replace <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--dry-run`	No	Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs.
`--no-dry-run`	No	Send --dry-run as false.
`--blocks <json\|@file>`	Yes	Blocks keyed by block id. (JSON, or @path / @- to read a file or stdin).
`--edges <json\|@file>`	Yes	Directed connections between blocks. (JSON, or @path / @- to read a file or stdin).
`--loops <json\|@file>`	No	Ignored on write: loop containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin).
`--parallels <json\|@file>`	No	Ignored on write: parallel containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin).
`--variables <json\|@file>`	No	Replacement variable set. Omit to leave the stored variables untouched. (JSON, or @path / @- to read a file or stdin).
`-y, --yes`	Conditional	Confirm this operation (required unless --dry-run).

API request and response schemas: replaceWorkflowState.

sim workflows import

Import workflow

Code

sim workflows import [options]

Options

Option	Required	Description
`--workflow <json\|@file>`	Yes	Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--name <value>`	No	Override for the imported workflow name.
`--description <value>`	No	Override for the imported workflow description.
`--mappings <json\|@file>`	No	Mapping entries addressed by resource kind and source identifier. (JSON, or @path / @- to read a file or stdin).
`--bindings <json\|@file>`	No	Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin).
`--dependent-values <json\|@file>`	No	Destination-specific values addressed by the source block ID and field key, before imported IDs are regenerated. (JSON, or @path / @- to read a file or stdin).
`--request-id <value>`	No	Stable client request ID for mapped import. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can create another workflow.
`--preview-fingerprint <value>`	No	Fingerprint returned by an import preview with the same choices. A changed plan returns 409; preview again. Do not invent this value.
`--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).

API request and response schemas: importWorkflow.

sim workflows list

List workflows

Code

sim workflows list [options]

Options

Option	Required	Description
`--scope <value>`	No	Which lifecycle set to list: `active` (default) for live workflows, `archived` for workflows a `DELETE` archived. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--deployed-only`	No	Return only workflows with an active deployment when true.
`--no-deployed-only`	No	Send --deployed-only as false.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.
`--search <value>`	No	Case-insensitive substring match against the resource name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "position". Accepted values: `position`, `name`, `createdAt`, `updatedAt`, `runCount`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listWorkflows.

sim workflows move

Move workflows

Code

sim workflows move [options]

Options

Option	Required	Description
`--workflow <value...>`	Yes	Workflows to move. Duplicates are collapsed. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--to <value>`	Yes	Destination folder path; / moves the workflows to the workspace root.

API request and response schemas: moveWorkflows.

sim workflows import-preview

Preview workflow import

Code

sim workflows import-preview [options]

Options

Option	Required	Description
`--workflow <json\|@file>`	Yes	Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--name <value>`	No	Override for the imported workflow name.
`--description <value>`	No	Override for the imported workflow description.
`--mappings <json\|@file>`	No	Mapping entries addressed by resource kind and source identifier. (JSON, or @path / @- to read a file or stdin).
`--bindings <json\|@file>`	No	Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin).
`--dependent-values <json\|@file>`	No	Destination-specific values addressed by the source block ID and field key, before imported IDs are regenerated. (JSON, or @path / @- to read a file or stdin).

API request and response schemas: previewWorkflowImport.

sim workflows restore

Restore an archived workflow

Code

sim workflows restore <workflowId>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

API request and response schemas: restoreWorkflow.

sim workflows revert create

Revert workflow to version (OAuth login or personal API key required)

This overwrites the draft graph with the selected version and cannot be undone.

Code

sim workflows revert create <workflowId> <version> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.
`version`	Yes	Numeric deployment version, or `active` for the currently live version.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: revertWorkflowVersion.

sim workflows rollback

Rollback workflow (OAuth login or personal API key required)

This changes which deployed version runs in production for every API and chat consumer.

Code

sim workflows rollback <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--to-version <value>`	No	Deployment version to reactivate. Omit to select the previous active version.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: rollbackWorkflow.

sim workflows undeploy

Take a workflow out of deployment (OAuth login or personal API key required)

This takes the workflow offline for every API and chat consumer, and agents calling its MCP tools lose access until it is deployed again.

Code

sim workflows undeploy <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: undeployWorkflow.

sim workflows update

Update workflow

Code

sim workflows update <workflowId> [options]

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.

Options

Option	Required	Description
`--name <value>`	No	Replacement workflow name.
`--description <value>`	No	Replacement workflow description; null clears it. (--description null sends the word, not JSON null).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: updateWorkflow.

sim workflows mv

Move a workflow to a folder

Code

sim workflows mv <workflowId> <folder>

Arguments

Argument	Required	Description
`workflowId`	Yes	Unique workflow identifier.
`folder`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: updateWorkflow.

sim workflows ls

List workflow resources and child folders together

Code

sim workflows ls [path] [options]

Arguments

Argument	Required	Description
`path`	No	Folder path to list; defaults to the root folder

Options

Option	Required	Description
`--search <text>`	No	Filter folders and resources by name.
`--limit <n>`	No	Maximum combined items to return (0 for everything). Defaults to `0`.

API request and response schemas: listWorkflows, listWorkflowFolders.

sim workflows mkdir

Create a workflow directory at a path

Code

sim workflows mkdir <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path to create; the leading / is optional

API request and response schemas: createWorkflowFolder.

sim workspaces

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

Also spelled sim workspace.

sim workspaces access-requests cancel

Cancel workspace access request (OAuth login or personal API key required)

Code

sim workspaces access-requests cancel <requestId>

Arguments

Argument	Required	Description
`requestId`	Yes	Access request identifier.

API request and response schemas: cancelWorkspaceAccessRequest.

sim workspaces access-requests create

Create workspace access request (OAuth login or personal API key required)

Code

sim workspaces access-requests create [options]

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. Defaults to "".

API request and response schemas: createWorkspaceAccessRequest.

sim workspaces access-requests discover

Discover workspace access requests (OAuth login or personal API key required)

Code

sim workspaces access-requests discover [options]

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. Defaults to "label". Accepted values: `label`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". 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.

API request and response schemas: discoverWorkspaceAccessRequests.

sim workspaces access-requests mine

List my workspace access requests (OAuth login or personal API key required)

Code

sim workspaces access-requests mine [options]

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. Defaults to "createdAt". Accepted values: `createdAt`, `targetLabel`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". 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.

API request and response schemas: listMyWorkspaceAccessRequests.

sim workspaces invitations create

Create workspace invitations (OAuth login or personal API key required)

Code

sim workspaces invitations create [options]

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. Defaults to "read". 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. Defaults to "member". Accepted values: `member`, `admin`, `external`.

API request and response schemas: createWorkspaceInvitations.

sim workspaces fork

Fork workspace (OAuth login or personal API key required)

Code

sim workspaces fork [options]

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. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
`--preview-fingerprint <value>`	Yes	Fingerprint 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.
`--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).

API request and response schemas: forkWorkspace.

sim workspaces get

Get workspace

Code

sim workspaces get

API request and response schemas: getWorkspace.

sim workspaces fork-availability

Get workspace fork availability (OAuth login or personal API key required)

Code

sim workspaces fork-availability

API request and response schemas: getWorkspaceForkAvailability.

sim workspaces lineage

Get workspace fork lineage (OAuth login or personal API key required)

Code

sim workspaces lineage

API request and response schemas: getWorkspaceForkLineage.

sim workspaces mappings get

Get workspace fork mappings (OAuth login or personal API key required)

Code

sim workspaces mappings get [options]

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. Defaults to "id". Accepted values: `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`.

API request and response schemas: getWorkspaceForkMappings.

sim workspaces mappings update

Update workspace fork mappings (OAuth login or personal API key required)

Code

sim workspaces mappings update [options]

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	Mapping 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.

sim workspaces operations get

Get workspace operation

Code

sim workspaces operations get <operationId>

Arguments

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

API request and response schemas: getWorkspaceOperation.

sim workspaces operations list

List workspace operations

Code

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	Find an uncertain mutation by the original client request ID; keep the same filter while paging.

API request and response schemas: listWorkspaceOperations.

sim workspaces operations wait

Wait for workspace copy and deployment readiness

Code

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

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.

sim workspaces permission-config

Get workspace permission config (OAuth login or personal API key required)

Code

sim workspaces permission-config

API request and response schemas: getWorkspacePermissionConfig.

sim workspaces children

List workspace fork children (OAuth login or personal API key required)

Code

sim workspaces children [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.
`--sort-by <value>`	No	Supported stable sort key for this collection. Defaults to "createdAt". Accepted values: `createdAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `desc`.

API request and response schemas: listWorkspaceForkChildren.

sim workspaces fork-resources

List workspace fork resources (OAuth login or personal API key required)

Code

sim workspaces fork-resources [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.
`--kind <value>`	Yes	Kind of source resource to list for copy selection. Accepted values: `files`, `tables`, `knowledgeBases`, `customTools`, `skills`, `mcpServers`, `workflowMcpServers`.
`--sort-by <value>`	No	Supported stable sort key for this collection. Defaults to "id". Accepted values: `id`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`.

API request and response schemas: listWorkspaceForkResources.

sim workspaces members

List workspace members

Code

sim workspaces members [options]

Options

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

API request and response schemas: listWorkspaceMembers.

sim workspaces list

List workspaces

Code

sim workspaces list [options]

Options

Option	Required	Description
`--sort-by <value>`	No	Field 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>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listWorkspaces.

sim workspaces fork-preview

Preview workspace fork (OAuth login or personal API key required)

Code

sim workspaces fork-preview [options]

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

API request and response schemas: previewWorkspaceFork.

sim workspaces pull-preview

Preview workspace pull (OAuth login or personal API key required)

Code

sim workspaces pull-preview [options]

Options

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`--mappings <json\|@file>`	No	Proposed 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>`	No	Destination-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>`	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).

API request and response schemas: previewWorkspacePull.

sim workspaces push-preview

Preview workspace push (OAuth login or personal API key required)

Code

sim workspaces push-preview [options]

Options

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`--mappings <json\|@file>`	No	Proposed 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>`	No	Destination-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>`	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).

API request and response schemas: previewWorkspacePush.

sim workspaces pull

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

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`--mappings <json\|@file>`	No	Proposed 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>`	No	Destination-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>`	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. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
`--preview-fingerprint <value>`	Yes	Fingerprint 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.
`--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.

API request and response schemas: pullWorkspace.

sim workspaces push

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

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`--mappings <json\|@file>`	No	Proposed 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>`	No	Destination-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>`	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. Reuse it with identical inputs after an uncertain response; changed inputs return 409. A new ID can apply another operation.
`--preview-fingerprint <value>`	Yes	Fingerprint 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.
`--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.

API request and response schemas: pushWorkspace.

sim workspaces fork-rollback

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

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: rollbackWorkspaceFork.

sim workspaces unlink

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

Option	Required	Description
`--other-workspace-id <value>`	Yes	Workspace on the other side of the direct fork edge.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: unlinkWorkspaceFork.

sim workspaces sync-exclusions

Update workspace fork exclusions (OAuth login or personal API key required)

Code

sim workspaces sync-exclusions [options]

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

API request and response schemas: updateWorkspaceForkExclusions.