Skip to content
Try for free
On this page

Sim CLI

Sim CLI

Run workflows and manage Sim resources from your terminal.

Use sim to run workflows, query tables, move files, search knowledge bases, and read logs. Structured results default to JSON for scripts, CI jobs, and coding agents. Select --output table for a readable table.

Install

The installed CLI requires Node.js 20 or newer. Install it globally with Bun, then check the version:

Code
bun add -g sim
sim --version

To run a command without a global installation:

Code
bunx sim --help

The package also supports npm and pnpm installations. Keep using the package manager that owns your installation when upgrading; another manager may install a second copy on your PATH.

Eligible interactive invocations can show an update notice. Run sim update to update the active global installation. See Updates for supported managers, release channels, and notice controls.

Your first command

1. Sign in

Code
sim login

Local sign-in prefers OAuth and opens a browser for approval. SSH sessions and headless Linux terminals select API-key pairing. To choose pairing explicitly without opening a browser:

Code
sim login --method api-key --no-browser

Approve the code shown in your terminal. See Authentication for CI credentials, remote terminals, multiple accounts, and self-hosted deployments.

2. Choose a workspace

After OAuth login, list your workspaces and set a default:

Code
sim workspaces list
sim configure --set-workspace <workspaceId>

Pairing sets the default workspace you choose on its approval page. Override that target for one command with --workspace <workspaceId>.

3. Check the resolved settings

Code
sim whoami

This shows the endpoint, credential type, workspace, and output format, including the source of each setting. It also checks authentication and access to the selected workspace. Use --no-verify to inspect settings offline.

4. List and run a workflow

Code
sim workflows list --output table

Example table output; timestamps are UTC:

Code
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
Code
sim workflows run 3a9e21d8-5f47-4c0b-b2ea-91d7c6034ef8 --input '{"ticketId":"T-4821"}'

Ordinary execution runs the active deployment. Deploy from the workflow builder or with sim workflows deploy <workflowId>. To execute the current saved workflow state, use sim workflows run <workflowId> --manual.

How commands are shaped

Resource commands use this shape:

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

In the installed CLI, commands such as login, whoami, configure, update, and chat run directly under sim. Local setup and maintenance commands are unavailable when Sim runs commands inside Chat; see Configuration. Some resource groups have singular aliases: sim workflow get and sim workflows get are equivalent. knowledge also accepts kb; each group reference lists its aliases.

Find a command

Search by the task you want to complete, then inspect the result's arguments and options:

Code
sim cli search "cancel a workflow run"
sim workflows runs cancel --help

Help is available at every depth:

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

What you can do

GroupCapabilities
workflowsBuild, deploy, run, roll back, import, export, and organize workflows
logsInspect runs and recursive traces
tablesQuery and change rows; manage columns, views, imports, and exports
filesUpload, download, share, version, and organize workspace files
knowledgeSearch knowledge bases and manage documents, connectors, and tags
skillsManage skills and their editors
sandboxesConfigure dependencies, managed CLIs, and system packages
mcp-serversConnect external Model Context Protocol (MCP) servers and discover tools
custom-toolsManage custom tool definitions
credentialsConnect, reconnect, and disconnect integration credentials
secretsManage personal and workspace secrets
workspacesManage members, invitations, forks, and workspace sync
organizationsManage organization access, members, usage, domains, and SSO
permission-groupsManage restrictions and group membership
billingInspect plan status and credit usage
audit-logsRead organization audit actions
blocksInspect the block catalog and configuration fields
toolsInspect and execute built-in tools
connector-typesInspect knowledge-base connector types and fields
selectorsDiscover and verify configuration choices
chat-deploymentsList deployed workflow chats
workflow-mcp-serversExpose deployed workflows as MCP tools
metaInspect API availability and credential status

The command overview lists global options and root commands. The complete reference contains every subcommand, argument, and option on one page. Both are generated from the CLI.

Agent skills

The Sim skills teach coding agents such as Claude Code and Codex to build and operate Sim through the CLI. Install them with the standard Agent Skills installer:

Code
bunx skills add simstudioai/skills --global

To install one skill for one agent without prompting:

Code
bunx skills add simstudioai/skills \
  --skill build-workflow \
  --agent codex \
  --global \
  --yes
SkillWhat it covers
build-workflowDiscover blocks and author a draft graph with atomic workflow operations
run-workflowTest saved state, exercise triggers, resume from a block, and diagnose runs
deploy-workflowPublish and manage workflows as APIs, chats, or MCP tools
filesOrganize workspace files and folders, read and search text, and apply targeted edits
sync-workspacesImport portable workflows with bindings, fork workspaces, and preview, apply, and reconcile push/pull sync
tableDesign typed tables, load and query rows, import data, and run workflow groups
knowledge-baseIngest and index documents, configure connectors and tags, and verify retrieval
run-toolCall one integration tool directly with Sim-managed credentials

The repository is also a native Claude Code and Codex plugin, which exposes the same skills under the sim namespace (sim:build-workflow, sim:run-workflow, and so on).

The skills assume sim is installed and signed in, so complete Your first command first. They never store or print API keys. These agent skills are separate from the workspace skills you manage with sim skills.

Related docs

Was this helpful?
Suggest an edit