Sim CLI

sim is the command line for Sim. Sign in once, then run workflows, query tables, move files, search knowledge bases, and read run logs from the terminal. Use --output json for structured results that pipe into jq, cron jobs, and CI pipelines. See Output formats for commands that emit raw content or local configuration.

Install

npm install -g sim
pnpm add -g sim
bun add -g sim

Requires Node.js 20 or newer. Verify with sim --version.

To run it without installing, use npx sim <command>.

Using Sim as a library instead? See the TypeScript and Python SDKs, or the HTTP API.

Your first command

Sign in

sim login

The CLI opens your browser for approval. Local sign-in prefers OAuth; remote terminals use API-key pairing. After OAuth sign-in, choose a default workspace with sim configure --set-workspace <id>. For SSH and containers, use sim login --method api-key --no-browser and approve the pairing code.

See Authentication for CI keys, multiple accounts, and self-hosted deployments.

Check what you are pointed at

sim whoami

This prints the resolved endpoint, workspace, and output format — and where each one came from. It is the fastest way to explain a surprising result.

List your workflows

sim workflows list
ID                                    NAME           FOLDER     DEPLOYED  RUNS  LAST RUN
3a9e21d8-5f47-4c0b-b2ea-91d7c6034ef8  Refund triage  /Support   yes       412   2026-08-15 14:02:11
b8c0d247-9e13-4a86-97f5-2ad4e1638c09  Weekly digest  /Reporting no        18    2026-08-11 09:00:04

Run one

sim workflows run 3a9e21d8-5f47-4c0b-b2ea-91d7c6034ef8 --input '{"ticketId":"T-4821"}'

This command runs the active deployment. Deploy from the editor or with sim workflows deploy <id>. To run the current saved workflow state instead, use sim workflows run <id> --manual.

How commands are shaped

Every command reads the same way:

sim <resource> [sub-resource] <verb> [arguments] [options]
sim workflows list
sim tables rows query tbl_9f3c1a05d4b7426e8c2f0917ab35de64 --limit 50
sim knowledge documents upload 4c1b7f60-2d55-4a3e-9c18-70b6ea2f9d31 ./handbook.pdf

Some resource groups also accept a singular alias: sim workflow get and sim workflows get are the same command. knowledge also answers to kb. Each group’s reference lists its supported aliases.

Every command accepts --help, at any depth:

sim --help
sim tables --help
sim tables rows query --help

What you can do

GroupWhat it covers
workflowsRun, deploy, roll back, import, export, and organize workflows
logsRead run diagnostics, including the full trace tree
tablesQuery, insert, update, and import rows; manage columns and views
filesUpload, download, share, and organize workspace files
knowledgeSearch knowledge bases and manage their documents and tags
skillsManage agent skills
sandboxesManage sandbox dependencies, managed CLIs, and system packages
mcp-serversManage MCP server connections and their tools
custom-toolsManage custom tool definitions
credentialsConnect, reconnect, and disconnect integration credentials
secretsSet and remove workspace secrets
billingCheck plan status and credit usage
audit-logsRead organization audit logs
workspacesInspect the active workspace and its members
blocksBrowse the block catalog and read one block's configuration fields
toolsBrowse and execute built-in tools
connector-typesBrowse knowledge-base connector types and their config fields
chat-deploymentsList the hosted chats a workspace serves
workflow-mcp-serversPublish workflows as MCP tools for outside agents
metaCheck what this API supports and which limits apply

The command overview has the global options and the commands that take no resource; the complete reference documents every subcommand, argument, and flag on one page. Both are generated from the CLI itself.

Where to go next

  • Authentication — signing in, API keys for CI, and multiple accounts
  • Configuration — profiles, config files, environment variables, and precedence
  • Output formats — table, json, yaml, and text, and when to use each
  • Scripting — piping, file inputs, exit codes, and automation recipes
  • Troubleshooting — what each error means, and how to resolve it
Authentication