Every sim command follows the same shape:
sim <resource> [sub-resource] <verb> [arguments] [options]Resource groups are plural, and each one also accepts its singular spelling —
sim workflow get and sim workflows get are the same command. knowledge
additionally answers to kb.
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 |
Authorize this terminal and store an API key for the profile
sim login [options]Options
| Option | Required | Description |
|---|---|---|
--scope <scope> | No | Key space to mint from: platform or copilot. Defaults to platform. |
--no-browser | No | Print the URL instead of opening a browser. |
-y, --yes | No | Overwrite an existing profile without prompting. |
Remove the profile's stored API key
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. |