Every sim command follows the same shape:
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.
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. |
Command groups
| Group | Description |
|---|---|
sim profiles | List profiles or add a workspace profile that shares a stored login |
sim audit-logs | Manage audit logs |
sim billing | Manage billing |
sim blocks | Manage blocks |
sim chat-deployments | Manage chat deployments |
sim connector-types | Manage connector types |
sim credentials | Manage credentials |
sim custom-tools | Manage custom tools |
sim files | Manage files |
sim knowledge | Manage knowledge |
sim logs | Manage logs |
sim mcp-servers | Manage mcp servers |
sim meta | Manage meta |
sim sandboxes | Manage sandboxes |
sim secrets | Manage secrets |
sim skills | Manage skills |
sim tables | Manage tables |
sim tools | Manage tools |
sim workflow-mcp-servers | Manage workflow mcp servers |
sim workflows | Manage workflows |
sim workspaces | Manage workspaces |
Sign in through the browser and store the login for the profile
sim login [options]Options
| 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. |
Sign out and remove the profile's stored login
sim logout [options]Options
| Option | Required | Description |
|---|---|---|
--all | No | Remove the profile entirely, including its settings. |
Show the resolved profile, where each setting came from, and whether it works
sim whoami [options]Options
| Option | Required | Description |
|---|---|---|
--no-verify | No | Skip the API check and only print the resolved settings. |
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). |
Ask Sim and print the reply
sim chat <message> [options]Arguments
| Argument | Required | Description |
|---|---|---|
message | Yes | What to ask Sim |
Options
| Option | Required | Description |
|---|---|---|
-c, --conversation <id> | No | Continue the conversation with this ID. |