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 any 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
These apply to every command, and may be written before or after it.
| 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. |
sim login
Authorize this terminal and store an API key for the profile
sim login [options]Options
| Option | Required | Description |
|---|---|---|
--scope <scope> | No | Key space to mint from: platform or copilot. Defaults to platform. |
--no-browser | No | Print the URL instead of opening a browser. |
-y, --yes | No | Overwrite an existing profile without prompting. |
sim logout
Remove the profile's stored API key
sim logout [options]Options
| Option | Required | Description |
|---|---|---|
--all | No | Remove the profile entirely, including its settings. |
sim whoami
Show the resolved profile and where each setting came from
sim whoamisim profiles
List the profiles defined in the config and credentials files
sim profilesAlso available as sim profile.
sim configure
Set a profile's endpoint, default workspace, or output format
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 audit-logs
Also spelled sim audit-log.
sim audit-logs get
Get Audit Log
sim audit-logs get <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Audit-log entry identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization ID (personal API key required). |
sim audit-logs list
List Audit Logs
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 | 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. |
--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. |
--organization <value> | Yes | Organization ID (personal API key required). |
--actor-email <value> | No | Filter by actor email address. |
--all-workspaces | No | Do not filter to the configured workspace (personal API key required for account-wide access). |
sim billing
sim billing status
Show billing status and current-period credit usage
sim billing status [options]Options
| Option | Required | Description |
|---|---|---|
--all-workspaces | No | Do not filter to the configured workspace (personal API key required for account-wide access). |
sim billing logs
List credit usage events
sim billing logs [options]Options
| Option | Required | Description |
|---|---|---|
--source <value> | No | Filter by usage source; sim-chat combines Copilot and workspace chat. Accepted values: workflow, wand, sim-chat, mcp_copilot, mothership_block, knowledge-base, voice-input, enrichment, voice-output. |
--period <value> | No | Billing period. 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. |
--all-workspaces | No | Do not filter to the configured workspace (personal API key required for account-wide access). |
sim credentials
Also spelled sim credential.
sim credentials delete
Disconnect Credential
sim credentials delete <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to disconnect. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim credentials providers list
List Credential Providers
sim credentials providers list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the credential provider name. |
sim credentials list
List Credentials
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. Accepted values: displayName, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim credentials create
Create a service-account credential using its discovered provider schema
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. |
sim credentials connect
Create a short-lived link for connecting an OAuth provider
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. |
sim credentials reconnect
Create a short-lived link for reconnecting an OAuth credential
sim credentials reconnect <credentialId>Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Existing OAuth credential to re-authorize |
sim custom-tools
Also spelled sim custom-tool.
sim custom-tools create
Create Custom Tool
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. |
sim custom-tools delete
Delete Custom Tool
sim custom-tools delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique custom tool identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim custom-tools get
Get Custom Tool
sim custom-tools get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique custom tool identifier. |
sim custom-tools list
List Custom Tools
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. Accepted values: title, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim custom-tools update
Update Custom Tool
sim custom-tools update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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. |
sim files
Also spelled sim file.
sim files batch-delete
Delete several files at once
sim files batch-delete [options]Options
| Option | Required | Description |
|---|---|---|
--file-ids <value...> | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line). |
-y, --yes | No | Skip the confirmation. |
sim files create
Create File
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; the leading / is optional. |
--content <value> | No | Initial file content. Omit or send an empty string for a zero-byte file. The 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with 413. Use an upload session for anything larger. |
--encoding <value> | No | Encoding of the content field. Accepted values: utf-8, base64. |
sim files folders create
Create a file folder at a path
sim files folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
sim files folders delete
Delete Folder
sim files folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
sim files folders list
List Folders
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
sim files folders move
Rename or move a file folder
sim files folders move <path> <destination>Also available as sim files folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
sim files delete
Delete File
sim files delete <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim files describe
Show file metadata and sharing status
sim files describe <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
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 POST /files/{fileId}/restore. Authorization is identical for both. Accepted values: active, archived. |
sim files share get
Show a file’s share settings
sim files share get <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
sim files share set
Enable or disable sharing for a file
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 for a password-gated share. Kept when omitted; enabling password with neither a supplied nor a stored password is a 400. |
--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). |
sim files list
List Files
sim files list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | No | Folder path; the leading / is optional. |
--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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, size, uploadedAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim files move
Move files into another folder
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). |
--to <value> | No | Destination folder path; omit for root. |
sim files rename
Rename a file
sim files rename <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | New file name, including its extension. |
sim files restore create
Restore File
sim files restore create <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
sim files set-content
Replace a file’s contents
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 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with 413. |
--encoding <value> | No | Content encoding. Accepted values: utf-8, base64. |
sim files upload
Upload a file to the workspace
sim files upload <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Local file to upload |
Options
| Option | Required | Description |
|---|---|---|
--folder <path> | No | Destination folder path (defaults to /). |
--name <name> | No | Store it under a different name. |
sim files get
Get a file’s content
sim files get <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File whose content to read |
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. |
sim files ls
List file resources and child folders together
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 100. |
sim files mkdir
Create a file directory at a path
sim files mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
sim knowledge
Also spelled sim kb.
sim knowledge documents batch-update
Enable or disable every matching document
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). |
--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. |
sim knowledge documents delete
Delete Document
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 | No | Skip the confirmation. |
sim knowledge documents get
Get Document
sim knowledge documents get <knowledgeBaseId> <documentId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
sim knowledge documents list
List Documents
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. Accepted values: all, enabled, disabled. |
--sort-by <value> | No | Field used to sort the result. Sorting by filename is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: filename, fileSize, tokenCount, chunkCount, uploadedAt, processingStatus, enabled. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--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. |
sim knowledge documents update
Update Document
sim knowledge documents update <id> <documentId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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. |
--no-retry-processing | No | Send --retry-processing as false. |
sim knowledge documents upload
Upload a document to a knowledge base
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. |
--lang <code> | No | Document language code. |
sim knowledge create
Create Knowledge Base
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; the leading / is optional. |
sim knowledge folders create
Create a knowledge folder at a path
sim knowledge folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
sim knowledge folders delete
Delete Folder
sim knowledge folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
sim knowledge folders list
List Folders
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
sim knowledge folders move
Rename or move a knowledge folder
sim knowledge folders move <path> <destination>Also available as sim knowledge folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
sim knowledge delete
Delete Knowledge Base
sim knowledge delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim knowledge get
Get Knowledge Base
sim knowledge get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique knowledge base identifier. |
sim knowledge list
List Knowledge Bases
sim knowledge list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | No | Folder path; 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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim knowledge tags list
List Tags
sim knowledge tags list <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique knowledge base identifier. |
sim knowledge search
Search Knowledge
sim knowledge search [options]Options
| Option | Required | Description |
|---|---|---|
--kb <value...> | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line). |
--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; the boundary schema only bounds the range, so a fractional value is admitted here and then rejected with 400 during search. |
--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 | Re-order retrieved chunks with a reranking model before truncating to topK. Ignored for a tag-only search, and billed as an additional search unit. Reranking is best-effort — a provider failure falls back to vector ordering, so check rerankerStatus on the response. |
--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. |
sim knowledge update
Update Knowledge Base
sim knowledge update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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; the leading / is optional. |
sim knowledge mv
Move a knowledge base to a folder
sim knowledge mv <id> <folder>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique knowledge base identifier. |
folder | Yes | Folder path; the leading / is optional |
sim knowledge ls
List knowledge resources and child folders together
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 100. |
sim knowledge mkdir
Create a knowledge directory at a path
sim knowledge mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
sim logs
Also spelled sim log.
sim logs get
Show run diagnostics
sim logs get <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--trace | No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
sim logs list
List Logs
sim logs list [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | No | Comma-separated workflow identifiers to include. An empty entry is rejected. (space-separated, or @path / @- with one value per line). |
--trigger <value...> | No | Comma-separated trigger types to include. An empty entry is rejected. Values are matched exactly and are case-sensitive — every recorded trigger is lowercase, so API matches nothing while api matches. The vocabulary is open: it covers the core trigger types (manual, api, schedule, chat, webhook, mcp, copilot, workflow, custom_block) and the provider id of any webhook trigger (slack, gmail, github, …), so an unrecognized member is not rejected — it selects no runs. The literal value all is a sentinel that disables this filter entirely, so a list containing it returns runs of every trigger type; no real trigger type is named all. (space-separated, or @path / @- with one value per line). |
--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. 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. |
--order <value> | No | Sort direction by execution start time. This list is sortable only by execution start time, so it takes order in place of sortBy/sortOrder, which it rejects. Accepted values: asc, desc. |
--run-id <value> | No | Exact run identifier to match. |
--folder <value...> | No | Folder path; the leading / is optional (space-separated, or @path / @- with one value per line). |
sim mcp-servers
Also spelled sim mcp-server.
sim mcp-servers create
Create MCP Server
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 used to communicate with the server. Applied server-side as streamable-http when omitted on create. 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. When omitted, and no headers are sent, registration probes the endpoint once to classify it, falling back to headers when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as oauth, and headers configured afterwards will not authenticate — send this field explicitly to pin the 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. Applied server-side as 30000 when omitted on create. |
--retries <value> | No | Number of retries per request. Applied server-side as 3 when omitted on create. |
--enabled | No | Whether the server tools are available to workflows. Applied server-side as true when omitted on create. |
--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. |
sim mcp-servers delete
Delete MCP Server
sim mcp-servers delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim mcp-servers get
Get MCP Server
sim mcp-servers get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique MCP server identifier. |
sim mcp-servers list
List MCP Servers
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim mcp-servers tools list
List MCP Server Tools
sim mcp-servers tools list <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--refresh | No | Bypass the short-lived per-workspace tool cache and reconnect under your own credentials. A cached result reflects whichever workspace member last ran discovery, so this is the only way to pick up a tool added since then; it costs a live round trip. |
--no-refresh | No | Send --refresh as false. |
sim mcp-servers update
Update MCP Server
sim mcp-servers update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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 used to communicate with the server. Applied server-side as streamable-http when omitted on create. 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. When omitted, and no headers are sent, registration probes the endpoint once to classify it, falling back to headers when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as oauth, and headers configured afterwards will not authenticate — send this field explicitly to pin the 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. Applied server-side as 30000 when omitted on create. |
--retries <value> | No | Number of retries per request. Applied server-side as 3 when omitted on create. |
--enabled | No | Whether the server tools are available to workflows. Applied server-side as true when omitted on create. |
--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. |
sim secrets
Also spelled sim secret.
sim secrets delete
Delete Secret
sim secrets delete <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret to create, replace, or 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 | No | Skip the confirmation. |
sim secrets list
List Secrets
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim secrets set
Create or replace a named secret
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> | No | Secret value; visible to shell history when supplied directly. |
sim skills
Also spelled sim skill.
sim skills create
Create Skill
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. |
sim skills delete
Delete Skill
sim skills delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique skill identifier. A built-in skill is builtin- followed by its name, for example builtin-research. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim skills get
Get Skill
sim skills get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique skill identifier. A built-in skill is builtin- followed by its name, for example builtin-research. |
sim skills list
List Skills
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim skills update
Update Skill
sim skills update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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. |
sim tables
Also spelled sim table.
sim tables columns create
Add Column
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). |
sim tables columns delete
Delete Column
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 | No | Skip the confirmation. |
sim tables columns run
Run a column’s workflow
sim tables columns run <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). |
--run-mode <value> | No | Whether to run all or only incomplete cells. Accepted values: all, incomplete. |
--row-ids <value...> | No | Explicit row subset to run. (space-separated, or @path / @- with one value per line). |
--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). |
--limit <json|@file> | No | Optional cap on eligible rows to run. (JSON, or @path / @- to read a file or stdin). |
sim tables columns update
Update Column
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). |
sim tables groups create
Add Workflow Group
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> | Yes | Columns created for producer outputs. (JSON, or @path / @- to read a file or stdin). |
--auto-run | No | Whether to schedule existing rows after group creation. |
--no-auto-run | No | Send --auto-run as false. |
sim tables groups delete
Delete Workflow Group
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 | No | Skip the confirmation. |
sim tables groups list
List Workflow Groups
sim tables groups list <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
sim tables groups update
Update Workflow Group
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. |
sim tables exports cancel
Cancel Table Export
sim tables exports cancel <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
exportId | Yes | Unique table-export identifier. |
sim tables exports create
Create Table Export
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. Accepted values: csv, json. |
sim tables exports get
Get Table Export
sim tables exports get <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
exportId | Yes | Unique table-export identifier. |
sim tables exports download
Get the download URL for a finished export
sim tables exports download <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
exportId | Yes | Unique table-export identifier. |
sim tables imports cancel
Cancel Table Import
sim tables imports cancel <importId>Arguments
| Argument | Required | Description |
|---|---|---|
importId | Yes | Unique table-import identifier. |
sim tables imports get
Get Table Import
sim tables imports get <importId>Arguments
| Argument | Required | Description |
|---|---|---|
importId | Yes | Unique table-import identifier. |
sim tables cancel-runs
Stop every running column job
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). |
sim tables create
Create Table
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; the leading / is optional. |
sim tables folders create
Create a table folder at a path
sim tables folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
sim tables folders delete
Delete Folder
sim tables folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
sim tables folders list
List Folders
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
sim tables folders move
Rename or move a table folder
sim tables folders move <path> <destination>Also available as sim tables folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
sim tables rows create
Create Rows
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). |
sim tables rows delete
Delete Row
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 | No | Skip the confirmation. |
sim tables rows batch-delete
Delete rows matching a filter, or an explicit list of ids
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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--row <value...> | No | Explicit row identifiers to delete. (space-separated, or @path / @- with one value per line). |
-y, --yes | No | Skip the confirmation. |
sim tables rows find
Find rows matching a predicate
sim tables rows find <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--q <value> | Yes | Value to find. |
--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). |
sim tables rows get
Get Row
sim tables rows get <tableId> <rowId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
rowId | Yes | Unique table row identifier. |
sim tables rows list
List Rows
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. |
sim tables rows query
Query Rows
sim tables rows query <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). |
--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. |
sim tables rows enrich
Run one row’s enrichment group
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. |
sim tables rows batch-update
Update every row matching a filter
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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
-y, --yes | No | Skip the confirmation. |
sim tables rows update
Update Row
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). |
sim tables views create
Create View
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). |
sim tables views delete
Delete View
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 | No | Skip the confirmation. |
sim tables views get
Get View
sim tables views get <tableId> <viewId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
viewId | Yes | Unique saved-view identifier. |
sim tables views list
List Views
sim tables views list <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
sim tables views update
Update View
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). |
--is-default | No | Whether to promote this view to the table default. |
--no-is-default | No | Send --is-default as false. |
sim tables delete
Delete Table
sim tables delete <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim tables get
Get Table
sim tables get <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
sim tables list
List Tables
sim tables list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | No | Folder path; 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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim tables count create
Count Rows
sim tables count create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--predicate <json|@file> | No | Recursive predicate tree. Each group node is exactly one non-empty all or any array whose members are further groups or { field, op, value } conditions; the root must be a group, not a bare condition. At most 100 members per group, 10 levels of nesting, and 500 nodes in total. The negating operators include nulls: ne, nin, ncontains, nlike, and nilike match rows whose column is null or absent, so "not X" is not the complement of "X" over a nullable column. That holds for every column type, multi-select included. To exclude nulls, all-combine the negation with isNotEmpty (multi-select) or isNotNull. Comparison: eq, ne, gt, gte, lt, lte. Membership: in, nin (array operand). Emptiness: isEmpty, isNotEmpty, isNull, isNotNull (no operand). Substring, always case-insensitive, operand matched literally: contains, ncontains, startsWith, endsWith. Pattern: like/nlike (case-sensitive), ilike/nilike (case-insensitive). * is the only wildcard and stands for any run of characters; %, _, and backslash match themselves. Use like: "Hi*", not like: "Hi%". A select column compares by option id and restricts its operators: single-select accepts eq, ne, in, nin; multi-select accepts contains, ncontains. Option names are accepted as operands and resolved to ids. (JSON, or @path / @- to read a file or stdin). |
sim tables update
Update Table
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. |
--folder <value> | No | Folder path; the leading / is optional. |
sim tables mv
Move a table to a folder
sim tables mv <tableId> <folder>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
folder | Yes | Folder path; the leading / is optional |
sim tables upsert
Insert a row, or update the one that conflicts on a unique column
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 the merging PATCH /api/v2/tables/{tableId}/rows/{rowId}. (JSON, or @path / @- to read a file or stdin). |
--on <value> | No | Unique column to resolve the conflict against. |
sim tables import
Import a CSV, into a new table by default
sim tables import [path] [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | No | Local CSV file to import; omit when using --file-id |
Options
| Option | Required | Description |
|---|---|---|
--name <name> | No | Identifier for the new table: letters, numbers, and underscores; defaults to the sanitized file name. |
--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. |
--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. |
--no-wait | No | Return once the import is queued instead of watching it. |
sim tables ls
List table resources and child folders together
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 100. |
sim tables mkdir
Create a table directory at a path
sim tables mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
sim workflows
Also spelled sim workflow.
sim workflows runs cancel
Cancel a running workflow run
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. |
sim workflows runs get
Show run status (requested outputs are included in JSON or YAML output)
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.field values in JSON or YAML output (e.g. agent_1.content) (space-separated, or @path / @- with one value per line). |
sim workflows runs list
List runs for a workflow
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. |
--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. Accepted values: asc, desc. |
sim workflows runs resume
Resume a paused run (output is included in JSON or YAML output)
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). |
sim workflows create
Create Workflow
sim workflows create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Workflow name. |
--description <value> | No | Optional workflow description. |
--folder <value> | No | Folder path; the leading / is optional. |
sim workflows folders create
Create a workflow folder at a path
sim workflows folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
sim workflows folders delete
Delete Workflow Folder
sim workflows folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
sim workflows folders list
List Workflow Folders
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. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
sim workflows folders move
Rename or move a workflow folder
sim workflows folders move <path> <destination>Also available as sim workflows folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
sim workflows delete
Delete Workflow
sim workflows delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
sim workflows deploy
Deploy Workflow
sim workflows deploy <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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. |
sim workflows run
Run a deployed workflow
sim workflows run <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | 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. |
--execution-timeout-seconds <value> | No | Requested server-side timeout for an asynchronous run, in seconds. An upper bound, not the effective timeout: the run uses the smaller of this value and the plan's execution timeout, so requesting more than the plan allows silently yields the plan timeout. Rejected with 400 unless async is true. |
--select-output <value...> | No | Return blockName.field values (e.g. agent_1.content); missing fields are omitted (space-separated, or @path / @- with one value per line). |
--include-file-base64 | No | Inline eligible output files as base64 content. 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. Rejected when async is true. |
sim workflows export
Print a workflow as a portable JSON document
sim workflows export <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
sim workflows get
Get Workflow
sim workflows get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
sim workflows deployment list
Get Workflow Deployment
sim workflows deployment list <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
sim workflows versions get
Get Workflow Version
sim workflows versions get <id> <version>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
version | Yes | Numeric deployment version. |
sim workflows versions list
List Workflow Versions
sim workflows versions list <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
sim workflows import
Import Workflow
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; the leading / is optional. |
--name <value> | No | Override for the imported workflow name. |
--description <value> | No | Override for the imported workflow description. |
sim workflows list
List Workflows
sim workflows list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | No | Folder path; 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 100. |
--search <value> | No | Case-insensitive substring match against the resource name. |
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: position, name, createdAt, updatedAt, runCount. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
sim workflows rollback
Rollback Workflow
sim workflows rollback <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--version <value> | No | Deployment version to reactivate. Omit to select the previous active version. |
sim workflows undeploy
Take a workflow out of deployment
sim workflows undeploy <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
sim workflows update
Update Workflow
sim workflows update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Replacement workflow name. |
--description <value> | No | Replacement workflow description; null clears it. |
--folder <value> | No | Folder path; the leading / is optional. |
sim workflows mv
Move a workflow to a folder
sim workflows mv <id> <folder>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
folder | Yes | Folder path; the leading / is optional |
sim workflows ls
List workflow resources and child folders together
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 100. |
sim workflows mkdir
Create a workflow directory at a path
sim workflows mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
sim workspaces
Also spelled sim workspace.
sim workspaces get
Get Workspace
sim workspaces getsim workspaces members
List workspace members
sim workspaces members [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |