# CLI commands (/cli/commands)





Resource commands use this shape:

```bash
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 [#global-options]

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

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

Use `--help` to inspect a command. 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](/cli/output) for the JSON default and display formats.

## Command groups [#command-groups]

| Group | Description |
| - | - |
| [`sim profiles`](/cli/profiles) | List profiles and add a workspace profile that shares a stored login. |
| [`sim telemetry`](/cli/telemetry) | Inspect and change this machine’s anonymous usage-reporting preference. |
| [`sim cli`](/cli/cli) | Find a command by describing the task you want to perform. |
| [`sim audit-logs`](/cli/audit-logs) | Read organization audit actions and filter by actor, resource, workspace, or time. |
| [`sim billing`](/cli/billing) | Read billing status, credit usage, and storage usage. |
| [`sim blocks`](/cli/blocks) | Inspect workflow blocks, integration blocks, and triggers available to the workspace. |
| [`sim chat-deployments`](/cli/chat-deployments) | List workflow chat deployments in the workspace. |
| [`sim connector-types`](/cli/connector-types) | Discover knowledge connectors and their authentication and source-configuration schemas. |
| [`sim credentials`](/cli/credentials) | Discover providers, connect accounts, and manage credential access. |
| [`sim custom-tools`](/cli/custom-tools) | Create and manage code-backed tools that agents can call. |
| [`sim files`](/cli/files) | Browse workspace files, read or write content, manage versions, and configure sharing. |
| [`sim knowledge`](/cli/knowledge) | Manage knowledge bases, indexed documents, search, tags, and connector syncs. |
| [`sim logs`](/cli/logs) | Read run diagnostics, follow new runs, and summarize failures and latency. |
| [`sim mcp-servers`](/cli/mcp-servers) | Connect external Model Context Protocol (MCP) servers so workflows can use their tools. |
| [`sim meta`](/cli/meta) | Inspect API availability and the calling credential’s type and expiry. |
| [`sim organizations`](/cli/organizations) | Manage organization membership, invitations, usage, access requests, and SSO. |
| [`sim permission-groups`](/cli/permission-groups) | Manage organization permission groups, their configuration, and member assignments. |
| [`sim sandboxes`](/cli/sandboxes) | Manage reusable dependency sets for Function blocks. |
| [`sim secrets`](/cli/secrets) | Set and manage workspace or personal secrets. |
| [`sim selectors`](/cli/selectors) | Discover destination options for registered fields, such as calendars, channels, and tables. |
| [`sim skills`](/cli/skills) | Create reusable agent instructions and manage their editors. |
| [`sim tables`](/cli/tables) | Manage tables, rows, schemas, views, enrichment runs, imports, and exports. |
| [`sim tools`](/cli/tools) | Find built-in tools, inspect their parameters, and run them. |
| [`sim workflow-mcp-servers`](/cli/workflow-mcp-servers) | Serve deployed workflows as tools for Model Context Protocol (MCP) clients. |
| [`sim workflows`](/cli/workflows) | Build, deploy, run, and inspect workflows from the terminal. |
| [`sim workspaces`](/cli/workspaces) | Read workspace access and manage reviewed fork, push, and pull operations. |

## Log in through the browser and store the login for the profile [#log-in-through-the-browser-and-store-the-login-for-the-profile]

```bash
sim login [options]
```

**Options**

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

## Sign out and remove the profile's stored login [#sign-out-and-remove-the-profiles-stored-login]

```bash
sim logout [options]
```

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `--all` | No | Remove the profile entirely, including its settings. |
</CommandTable>

## Show the resolved profile, where each setting came from, and whether it works [#show-the-resolved-profile-where-each-setting-came-from-and-whether-it-works]

```bash
sim whoami [options]
```

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `--no-verify` | No | Skip the API check and only print the resolved settings. |
</CommandTable>

API request and response schemas: [getMeta](/api-reference/meta/getApiMeta), [getWorkspace](/api-reference/workspaces/getWorkspace).

## Switch a profile's default workspace, or set its endpoint or output format [#switch-a-profiles-default-workspace-or-set-its-endpoint-or-output-format]

```bash
sim configure [options]
```

**Options**

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

## Update this global CLI installation to the newest release on its channel [#update-this-global-cli-installation-to-the-newest-release-on-its-channel]

```bash
sim update [options]
```

**Options**

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

## Ask Sim and print the reply [#ask-sim-and-print-the-reply]

```bash
sim chat <message> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description |
  | - | - | - |
  | `message` | Yes | What to ask Sim |
</CommandTable>

**Options**

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

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**

```bash
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 [#related-docs]

* [Complete command reference](/cli/reference)
* [Authentication](/cli/authentication)
* [Scripting](/cli/scripting)