Skip to content
Try for free
On this page

Commands

CLI commands

Find command groups, global options, and login, configuration, and Chat commands.

Resource commands use this shape:

Code
sim <resource> [sub-resource] <verb> [arguments] [options]

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. Login, configuration, and Chat commands appear below. To find a command for a task, use sim cli search "describe your task".

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.

OptionDescription
-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. Run sim --version to print the CLI version; --version takes no value and exits without running a command. Deployment-version commands use their documented arguments or --to-version instead.

See output formats for the JSON default and display formats.

Command groups

GroupDescription
sim profilesList profiles and add a workspace profile that shares a stored login.
sim telemetryInspect and change this machine’s anonymous usage-reporting preference.
sim cliFind a command by describing the task you want to perform.
sim audit-logsRead organization audit actions and filter by actor, resource, workspace, or time.
sim billingRead billing status, credit usage, and storage usage.
sim blocksInspect workflow blocks, integration blocks, and triggers available to the workspace.
sim chat-deploymentsList workflow chat deployments in the workspace.
sim connector-typesDiscover knowledge connectors and their authentication and source-configuration schemas.
sim credentialsDiscover providers, connect accounts, and manage credential access.
sim custom-toolsCreate and manage code-backed tools that agents can call.
sim filesBrowse workspace files, read or write content, manage versions, and configure sharing.
sim knowledgeManage knowledge bases, indexed documents, search, tags, and connector syncs.
sim logsRead run diagnostics, follow new runs, and summarize failures and latency.
sim mcp-serversConnect external Model Context Protocol (MCP) servers so workflows can use their tools.
sim metaInspect API availability and the calling credential’s type and expiry.
sim organizationsManage organization membership, invitations, usage, access requests, and SSO.
sim permission-groupsManage organization permission groups, their configuration, and member assignments.
sim sandboxesManage reusable dependency sets for Function blocks.
sim secretsSet and manage workspace or personal secrets.
sim selectorsDiscover destination options for registered fields, such as calendars, channels, and tables.
sim skillsCreate reusable agent instructions and manage their editors.
sim tablesManage tables, rows, schemas, views, enrichment runs, imports, and exports.
sim toolsFind built-in tools, inspect their parameters, and run them.
sim workflow-mcp-serversServe deployed workflows as tools for Model Context Protocol (MCP) clients.
sim workflowsBuild, deploy, run, and inspect workflows from the terminal.
sim workspacesRead workspace access and manage reviewed fork, push, and pull operations.

Log in through the browser and store the login for the profile

Code
sim login [options]

Options

OptionRequiredDescription
--method <method>NoCredential to obtain: oauth requires OAuth support; api-key creates a permanent key through pairing (auto-selects when omitted). Accepted values: oauth, api-key.
--no-browserNoPrint the approval URL without opening it (either login method).
--read-onlyNoAsk only for permission to read, never to change anything.
--callback-port <port>NoPin the local port the browser returns to.
-y, --yesNoOverwrite an existing API-key profile without prompting.

Sign out and remove the profile's stored login

Code
sim logout [options]

Options

OptionRequiredDescription
--allNoRemove the profile entirely, including its settings.

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

Code
sim whoami [options]

Options

OptionRequiredDescription
--no-verifyNoSkip the API check and only print the resolved settings.

API request and response schemas: getMeta, getWorkspace.

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

Code
sim configure [options]

Options

OptionRequiredDescription
--set-endpoint <url>NoSim deployment to talk to.
--set-workspace <id>NoDefault workspace for workspace-scoped commands.
--set-output <format>NoDefault output format (table | json | yaml | text).
--unset <key...>NoRemove settings (endpoint, workspace, output).

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

Code
sim update [options]

Options

OptionRequiredDescription
--package-manager <manager>NoPackage manager that installed this copy. Accepted values: npm, pnpm, bun, yarn.

Ask Sim and print the reply

Code
sim chat <message> [options]

Arguments

ArgumentRequiredDescription
messageYesWhat to ask Sim

Options

OptionRequiredDescription
-c, --conversation <id>NoContinue 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'

Related docs

Was this helpful?
Suggest an edit