# Complete reference (/cli/reference)





Every command on one page, generated from the CLI itself. Start at the
[overview](/cli/commands) to browse; this page is for searching and for tools.

Append `.mdx` to any page for its raw Markdown —
[`/cli/reference.mdx`](/cli/reference.mdx) is this page as plain text. The docs
are also published as [`/llms.txt`](/llms.txt) and
[`/llms-full.txt`](/llms-full.txt).

## Global options [#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`. |

## sim login [#sim-login]

Authorize this terminal and store an API key for the profile

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

**Options**

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

## sim logout [#sim-logout]

Remove the profile's stored API key

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

**Options**

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

## sim whoami [#sim-whoami]

Show the resolved profile and where each setting came from

```bash
sim whoami
```

## sim profiles [#sim-profiles]

List the profiles defined in the config and credentials files

```bash
sim profiles
```

Also available as `sim profile`.

## sim configure [#sim-configure]

Set a profile's endpoint, default workspace, 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>

## sim audit-logs [#sim-audit-logs]

Also spelled `sim audit-log`.

### sim audit-logs get [#sim-audit-logs-get]

Get Audit Log

```bash
sim audit-logs get <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Audit-log entry identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                  |
  | ------------------------ | -------- | -------------------------------------------- |
  | `--organization <value>` | Yes      | Organization ID (personal API key required). |
</CommandTable>

### sim audit-logs list [#sim-audit-logs-list]

List Audit Logs

```bash
sim audit-logs list [options]
```

**Options**

<CommandTable>
  | Option                    | Required | Description                                                                                                                                                                                                                                   |
  | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--action <value>`        | No       | Filter by exact action name.                                                                                                                                                                                                                  |
  | `--resource-type <value>` | No       | Filter by resource type. Accepts a comma-separated set; members are trimmed and deduplicated, and member order affects neither the result nor the cursor.                                                                                     |
  | `--resource-id <value>`   | No       | Filter by exact resource identifier.                                                                                                                                                                                                          |
  | `--start-date <value>`    | No       | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.  |
  | `--end-date <value>`      | No       | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. |
  | `--include-departed`      | No       | Include actions by users who have left the organization.                                                                                                                                                                                      |
  | `--no-include-departed`   | No       | Send --include-departed as false.                                                                                                                                                                                                             |
  | `--limit <n>`             | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                |
  | `--organization <value>`  | Yes      | Organization ID (personal API key required).                                                                                                                                                                                                  |
  | `--actor-email <value>`   | No       | Filter by actor email address.                                                                                                                                                                                                                |
  | `--all-workspaces`        | No       | Do not filter to the configured workspace (personal API key required for account-wide access).                                                                                                                                                |
</CommandTable>

## sim billing [#sim-billing]

### sim billing status [#sim-billing-status]

Show billing status and current-period credit usage

```bash
sim billing status [options]
```

**Options**

<CommandTable>
  | Option             | Required | Description                                                                                    |
  | ------------------ | -------- | ---------------------------------------------------------------------------------------------- |
  | `--all-workspaces` | No       | Do not filter to the configured workspace (personal API key required for account-wide access). |
</CommandTable>

### sim billing logs [#sim-billing-logs]

List credit usage events

```bash
sim billing logs [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                                              |
  | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `--source <value>`     | No       | Filter by usage source; sim-chat combines Copilot and workspace chat. Accepted values: `workflow`, `wand`, `sim-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`. |
  | `--period <value>`     | No       | Billing period. Accepted values: `1d`, `7d`, `30d`, `all`, `custom`.                                                                                                                                                     |
  | `--start-date <value>` | No       | Custom period start (ISO 8601).                                                                                                                                                                                          |
  | `--end-date <value>`   | No       | Custom period end (ISO 8601).                                                                                                                                                                                            |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                           |
  | `--all-workspaces`     | No       | Do not filter to the configured workspace (personal API key required for account-wide access).                                                                                                                           |
</CommandTable>

## sim credentials [#sim-credentials]

Also spelled `sim credential`.

### sim credentials delete [#sim-credentials-delete]

Disconnect Credential

```bash
sim credentials delete <credentialId> [options]
```

**Arguments**

<CommandTable>
  | Argument       | Required | Description               |
  | -------------- | -------- | ------------------------- |
  | `credentialId` | Yes      | Credential to disconnect. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim credentials providers list [#sim-credentials-providers-list]

List Credential Providers

```bash
sim credentials providers list [options]
```

**Options**

<CommandTable>
  | Option             | Required | Description                                                            |
  | ------------------ | -------- | ---------------------------------------------------------------------- |
  | `--search <value>` | No       | Case-insensitive substring match against the credential provider name. |
</CommandTable>

### sim credentials list [#sim-credentials-list]

List Credentials

```bash
sim credentials list [options]
```

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                              |
  | ----------------------- | -------- | ---------------------------------------------------------------------------------------- |
  | `--type <value>`        | No       | Restrict results to this credential type. Accepted values: `oauth`, `service_account`.   |
  | `--provider-id <value>` | No       | Restrict results to credentials for this integration provider.                           |
  | `--search <value>`      | No       | Case-insensitive substring match against the credential display name.                    |
  | `--sort-by <value>`     | No       | Field used to sort the result. Accepted values: `displayName`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>`  | No       | Sort direction. Accepted values: `asc`, `desc`.                                          |
  | `--limit <n>`           | No       | Maximum items to return (0 for everything). Defaults to `100`.                           |
</CommandTable>

### sim credentials create [#sim-credentials-create]

Create a service-account credential using its discovered provider schema

```bash
sim credentials create <providerId> [options]
```

**Arguments**

<CommandTable>
  | Argument     | Required | Description                                         |
  | ------------ | -------- | --------------------------------------------------- |
  | `providerId` | Yes      | Service-account provider to create a credential for |
</CommandTable>

**Options**

<CommandTable>
  | Option                        | Required | Description                                                           |
  | ----------------------------- | -------- | --------------------------------------------------------------------- |
  | `--name <displayName>`        | Yes      | Name shown for the credential in Sim.                                 |
  | `--credentials <json\|@file>` | Yes      | Provider credentials as JSON (or @path / @- to read a file or stdin). |
  | `--description <description>` | No       | Optional credential description.                                      |
  | `--id <credentialId>`         | No       | Client-generated credential ID when provider discovery requires it.   |
</CommandTable>

### sim credentials connect [#sim-credentials-connect]

Create a short-lived link for connecting an OAuth provider

```bash
sim credentials connect <providerId> [options]
```

**Arguments**

<CommandTable>
  | Argument     | Required | Description               |
  | ------------ | -------- | ------------------------- |
  | `providerId` | Yes      | OAuth provider to connect |
</CommandTable>

**Options**

<CommandTable>
  | Option                 | Required | Description                               |
  | ---------------------- | -------- | ----------------------------------------- |
  | `--name <displayName>` | Yes      | Name shown for the new credential in Sim. |
</CommandTable>

### sim credentials reconnect [#sim-credentials-reconnect]

Create a short-lived link for reconnecting an OAuth credential

```bash
sim credentials reconnect <credentialId>
```

**Arguments**

<CommandTable>
  | Argument       | Required | Description                               |
  | -------------- | -------- | ----------------------------------------- |
  | `credentialId` | Yes      | Existing OAuth credential to re-authorize |
</CommandTable>

## sim custom-tools [#sim-custom-tools]

Also spelled `sim custom-tool`.

### sim custom-tools create [#sim-custom-tools-create]

Create Custom Tool

```bash
sim custom-tools create [options]
```

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                             |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--title <value>`        | Yes      | Display title, unique within the workspace.                                                                                                                             |
  | `--schema <json\|@file>` | Yes      | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). |
  | `--code <value>`         | Yes      | Tool implementation executed in the sandboxed function runtime.                                                                                                         |
</CommandTable>

### sim custom-tools delete [#sim-custom-tools-delete]

Delete Custom Tool

```bash
sim custom-tools delete <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                    |
  | -------- | -------- | ------------------------------ |
  | `id`     | Yes      | Unique custom tool identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim custom-tools get [#sim-custom-tools-get]

Get Custom Tool

```bash
sim custom-tools get <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                    |
  | -------- | -------- | ------------------------------ |
  | `id`     | Yes      | Unique custom tool identifier. |
</CommandTable>

### sim custom-tools list [#sim-custom-tools-list]

List Custom Tools

```bash
sim custom-tools list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                        |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------- |
  | `--search <value>`     | No       | Case-insensitive substring match against the tool title.                           |
  | `--sort-by <value>`    | No       | Field used to sort the result. Accepted values: `title`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                    |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                     |
</CommandTable>

### sim custom-tools update [#sim-custom-tools-update]

Update Custom Tool

```bash
sim custom-tools update <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                    |
  | -------- | -------- | ------------------------------ |
  | `id`     | Yes      | Unique custom tool identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                             |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--title <value>`        | No       | New display title for the tool.                                                                                                                                         |
  | `--schema <json\|@file>` | No       | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). |
  | `--code <value>`         | No       | Replacement tool implementation.                                                                                                                                        |
</CommandTable>

## sim files [#sim-files]

Also spelled `sim file`.

### sim files batch-delete [#sim-files-batch-delete]

Delete several files at once

```bash
sim files batch-delete [options]
```

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                           |
  | ----------------------- | -------- | ------------------------------------------------------------------------------------- |
  | `--file-ids <value...>` | Yes      | File identifiers to update. (space-separated, or @path / @- with one value per line). |
  | `-y, --yes`             | No       | Skip the confirmation.                                                                |
</CommandTable>

### sim files create [#sim-files-create]

Create File

```bash
sim files create [options]
```

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                                                                                                                                |
  | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--name <value>`         | Yes      | File name, including its extension. Path separators and dot segments are rejected.                                                                                                                                                                                         |
  | `--content-type <value>` | No       | MIME type. When omitted, it is inferred from the file extension.                                                                                                                                                                                                           |
  | `--folder <value>`       | No       | Folder path; the leading / is optional.                                                                                                                                                                                                                                    |
  | `--content <value>`      | No       | Initial file content. Omit or send an empty string for a zero-byte file. The 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with `413`. Use an upload session for anything larger. |
  | `--encoding <value>`     | No       | Encoding of the content field. Accepted values: `utf-8`, `base64`.                                                                                                                                                                                                         |
</CommandTable>

### sim files folders create [#sim-files-folders-create]

Create a file folder at a path

```bash
sim files folders create <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim files folders delete [#sim-files-folders-delete]

Delete Folder

```bash
sim files folders delete <path> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `--recursive` | No       | Delete the folder and its descendants. |
  | `-y, --yes`   | No       | Skip the confirmation.                 |
</CommandTable>

### sim files folders list [#sim-files-folders-list]

List Folders

```bash
sim files folders list [options]
```

Also available as `sim files folders ls`.

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--parent <value>`     | No       | Direct parent folder path.                                                                                                                                                                           |
  | `--search <value>`     | No       | Case-insensitive substring match against the folder name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
</CommandTable>

### sim files folders move [#sim-files-folders-move]

Rename or move a file folder

```bash
sim files folders move <path> <destination>
```

Also available as `sim files folders mv`.

**Arguments**

<CommandTable>
  | Argument      | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `path`        | Yes      | Folder path; the leading / is optional |
  | `destination` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim files delete [#sim-files-delete]

Delete File

```bash
sim files delete <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim files describe [#sim-files-describe]

Show file metadata and sharing status

```bash
sim files describe <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                                                                                                                                                                                                                                                                                              |
  | ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--scope <value>` | No       | Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file a `DELETE` soft-deleted; `archived` also resolves soft-deleted files, so metadata stays readable before `POST /files/&#123;fileId&#125;/restore`. Authorization is identical for both. Accepted values: `active`, `archived`. |
</CommandTable>

### sim files share get [#sim-files-share-get]

Show a file’s share settings

```bash
sim files share get <fileId>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

### sim files share set [#sim-files-share-set]

Enable or disable sharing for a file

```bash
sim files share set <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                        | Required | Description                                                                                                                                                                                                                                                                               |
  | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--is-active <true\|false>`   | Yes      | Whether the share should resolve. Disabling preserves the token and the whole access configuration, so re-enabling restores the share as it was; enabling rewrites the credentials the resulting mode does not use. Accepted values: `true`, `false`.                                     |
  | `--auth-type <value>`         | No       | How access to the share is gated. The stored mode is kept when omitted. Enabling `public` clears the stored password and empties `allowedEmails`; `password` empties `allowedEmails`; `email` and `sso` clear the stored password. Accepted values: `public`, `password`, `email`, `sso`. |
  | `--password <value>`          | No       | Password for a password-gated share. Kept when omitted; enabling `password` with neither a supplied nor a stored password is a 400.                                                                                                                                                       |
  | `--allowed-emails <value...>` | No       | Allowed addresses or `@domain` patterns for email and SSO shares. Kept when omitted; enabling `email` or `sso` with an empty resulting list is a 400. (space-separated, or @path / @- with one value per line).                                                                           |
</CommandTable>

### sim files list [#sim-files-list]

List Files

```bash
sim files list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                                                                                                                                    |
  | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--folder <value>`     | No       | Folder path; the leading / is optional.                                                                                                                                                                                                                                                                        |
  | `--scope <value>`      | No       | Which lifecycle set to list: `active` (default) for live files, `archived` for files a `DELETE` soft-deleted. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
  | `--search <value>`     | No       | Case-insensitive substring match against the file name.                                                                                                                                                                                                                                                        |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `size`, `uploadedAt`, `updatedAt`.                                                                                                  |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                                                                                                                                |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                                 |
</CommandTable>

### sim files move [#sim-files-move]

Move files into another folder

```bash
sim files move [options]
```

Also available as `sim files mv`.

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                           |
  | ----------------------- | -------- | ------------------------------------------------------------------------------------- |
  | `--file-ids <value...>` | Yes      | File identifiers to update. (space-separated, or @path / @- with one value per line). |
  | `--to <value>`          | No       | Destination folder path; omit for root.                                               |
</CommandTable>

### sim files rename [#sim-files-rename]

Rename a file

```bash
sim files rename <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option           | Required | Description                             |
  | ---------------- | -------- | --------------------------------------- |
  | `--name <value>` | Yes      | New file name, including its extension. |
</CommandTable>

### sim files restore create [#sim-files-restore-create]

Restore File

```bash
sim files restore create <fileId>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

### sim files set-content [#sim-files-set-content]

Replace a file’s contents

```bash
sim files set-content <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description      |
  | -------- | -------- | ---------------- |
  | `fileId` | Yes      | File identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option               | Required | Description                                                                                                                                                                                       |
  | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--content <value>`  | Yes      | Complete replacement content for the file. The 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with `413`. |
  | `--encoding <value>` | No       | Content encoding. Accepted values: `utf-8`, `base64`.                                                                                                                                             |
</CommandTable>

### sim files upload [#sim-files-upload]

Upload a file to the workspace

```bash
sim files upload <path> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description          |
  | -------- | -------- | -------------------- |
  | `path`   | Yes      | Local file to upload |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                              |
  | ----------------- | -------- | ---------------------------------------- |
  | `--folder <path>` | No       | Destination folder path (defaults to /). |
  | `--name <name>`   | No       | Store it under a different name.         |
</CommandTable>

### sim files get [#sim-files-get]

Get a file’s content

```bash
sim files get <fileId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                |
  | -------- | -------- | -------------------------- |
  | `fileId` | Yes      | File whose content to read |
</CommandTable>

**Options**

<CommandTable>
  | Option                     | Required | Description                                   |
  | -------------------------- | -------- | --------------------------------------------- |
  | `-o, --output-file <path>` | No       | Write content to a file instead of stdout.    |
  | `--force`                  | No       | Overwrite --output-file if it already exists. |
</CommandTable>

### sim files ls [#sim-files-ls]

List file resources and child folders together

```bash
sim files ls [path] [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | No       | Folder path to list; defaults to the root folder |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                             |
  | ----------------- | -------- | ----------------------------------------------------------------------- |
  | `--search <text>` | No       | Filter folders and resources by name.                                   |
  | `--limit <n>`     | No       | Maximum combined items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim files mkdir [#sim-files-mkdir]

Create a file directory at a path

```bash
sim files mkdir <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | Yes      | Folder path to create; the leading / is optional |
</CommandTable>

## sim knowledge [#sim-knowledge]

Also spelled `sim kb`.

### sim knowledge documents batch-update [#sim-knowledge-documents-batch-update]

Enable or disable every matching document

```bash
sim knowledge documents batch-update <knowledgeBaseId> [options]
```

**Arguments**

<CommandTable>
  | Argument          | Required | Description                       |
  | ----------------- | -------- | --------------------------------- |
  | `knowledgeBaseId` | Yes      | Unique knowledge base identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                     | Required | Description                                                                                                      |
  | -------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
  | `--operation <value>`      | Yes      | Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`.      |
  | `--document <value...>`    | No       | Documents to update, by identifier. (space-separated, or @path / @- with one value per line).                    |
  | `--select-all`             | No       | Apply to every document in the knowledge base.                                                                   |
  | `--enabled-filter <value>` | No       | With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`. |
</CommandTable>

### sim knowledge documents delete [#sim-knowledge-documents-delete]

Delete Document

```bash
sim knowledge documents delete <knowledgeBaseId> <documentId> [options]
```

**Arguments**

<CommandTable>
  | Argument          | Required | Description                           |
  | ----------------- | -------- | ------------------------------------- |
  | `knowledgeBaseId` | Yes      | Unique knowledge base identifier.     |
  | `documentId`      | Yes      | Unique knowledge document identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim knowledge documents get [#sim-knowledge-documents-get]

Get Document

```bash
sim knowledge documents get <knowledgeBaseId> <documentId>
```

**Arguments**

<CommandTable>
  | Argument          | Required | Description                           |
  | ----------------- | -------- | ------------------------------------- |
  | `knowledgeBaseId` | Yes      | Unique knowledge base identifier.     |
  | `documentId`      | Yes      | Unique knowledge document identifier. |
</CommandTable>

### sim knowledge documents list [#sim-knowledge-documents-list]

List Documents

```bash
sim knowledge documents list <knowledgeBaseId> [options]
```

**Arguments**

<CommandTable>
  | Argument          | Required | Description                       |
  | ----------------- | -------- | --------------------------------- |
  | `knowledgeBaseId` | Yes      | Unique knowledge base identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                     | Required | Description                                                                                                                                                                                                                                                                                                                |
  | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--limit <n>`              | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                                             |
  | `--search <value>`         | No       | Case-insensitive substring match against the document filename.                                                                                                                                                                                                                                                            |
  | `--enabled-filter <value>` | No       | Filter by whether documents are enabled for search. Accepted values: `all`, `enabled`, `disabled`.                                                                                                                                                                                                                         |
  | `--sort-by <value>`        | No       | Field used to sort the result. Sorting by `filename` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`.                                                    |
  | `--sort-order <value>`     | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                                                                                                                                            |
  | `--tag-filters <value>`    | No       | A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[&#123;"tagName":"category","operator":"eq","value":"billing"&#125;]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored. |
</CommandTable>

### sim knowledge documents update [#sim-knowledge-documents-update]

Update Document

```bash
sim knowledge documents update <id> <documentId> [options]
```

**Arguments**

<CommandTable>
  | Argument     | Required | Description                           |
  | ------------ | -------- | ------------------------------------- |
  | `id`         | Yes      | Unique knowledge base identifier.     |
  | `documentId` | Yes      | Unique knowledge document identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                                                                                                                |
  | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--filename <value>`    | No       | New filename for the document.                                                                                                                                             |
  | `--enabled`             | No       | Whether the document participates in search. Disabling keeps it indexed.                                                                                                   |
  | `--no-enabled`          | No       | Send --enabled as false.                                                                                                                                                   |
  | `--tag1 <value>`        | No       | New value for tag slot 1.                                                                                                                                                  |
  | `--tag2 <value>`        | No       | New value for tag slot 2.                                                                                                                                                  |
  | `--tag3 <value>`        | No       | New value for tag slot 3.                                                                                                                                                  |
  | `--tag4 <value>`        | No       | New value for tag slot 4.                                                                                                                                                  |
  | `--tag5 <value>`        | No       | New value for tag slot 5.                                                                                                                                                  |
  | `--tag6 <value>`        | No       | New value for tag slot 6.                                                                                                                                                  |
  | `--tag7 <value>`        | No       | New value for tag slot 7.                                                                                                                                                  |
  | `--number1 <value>`     | No       | New value for number tag slot 1.                                                                                                                                           |
  | `--number2 <value>`     | No       | New value for number tag slot 2.                                                                                                                                           |
  | `--number3 <value>`     | No       | New value for number tag slot 3.                                                                                                                                           |
  | `--number4 <value>`     | No       | New value for number tag slot 4.                                                                                                                                           |
  | `--number5 <value>`     | No       | New value for number tag slot 5.                                                                                                                                           |
  | `--date1 <value>`       | No       | New value for date tag slot 1, formatted YYYY-MM-DD.                                                                                                                       |
  | `--date2 <value>`       | No       | New value for date tag slot 2, formatted YYYY-MM-DD.                                                                                                                       |
  | `--boolean1`            | No       | New value for boolean tag slot 1.                                                                                                                                          |
  | `--no-boolean1`         | No       | Send --boolean1 as false.                                                                                                                                                  |
  | `--boolean2`            | No       | New value for boolean tag slot 2.                                                                                                                                          |
  | `--no-boolean2`         | No       | Send --boolean2 as false.                                                                                                                                                  |
  | `--boolean3`            | No       | New value for boolean tag slot 3.                                                                                                                                          |
  | `--no-boolean3`         | No       | Send --boolean3 as false.                                                                                                                                                  |
  | `--retry-processing`    | No       | Requeue a failed or stuck document for processing. Send it alone — no other field may accompany it — and it answers with a queue acknowledgement rather than the document. |
  | `--no-retry-processing` | No       | Send --retry-processing as false.                                                                                                                                          |
</CommandTable>

### sim knowledge documents upload [#sim-knowledge-documents-upload]

Upload a document to a knowledge base

```bash
sim knowledge documents upload <knowledgeBaseId> <path> [options]
```

**Arguments**

<CommandTable>
  | Argument          | Required | Description                   |
  | ----------------- | -------- | ----------------------------- |
  | `knowledgeBaseId` | Yes      | Knowledge base to upload into |
  | `path`            | Yes      | Local file to upload          |
</CommandTable>

**Options**

<CommandTable>
  | Option             | Required | Description                                |
  | ------------------ | -------- | ------------------------------------------ |
  | `--name <name>`    | No       | Store it under a different name.           |
  | `--tag <value...>` | No       | Document tags, in tag1 through tag7 order. |
  | `--recipe <name>`  | No       | Document processing recipe.                |
  | `--lang <code>`    | No       | Document language code.                    |
</CommandTable>

### sim knowledge create [#sim-knowledge-create]

Create Knowledge Base

```bash
sim knowledge create [options]
```

**Options**

<CommandTable>
  | Option                            | Required | Description                                                                                               |
  | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
  | `--name <value>`                  | Yes      | Human-readable knowledge base name.                                                                       |
  | `--description <value>`           | No       | Optional knowledge base description.                                                                      |
  | `--chunking-config <json\|@file>` | No       | Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin). |
  | `--folder <value>`                | No       | Folder path; the leading / is optional.                                                                   |
</CommandTable>

### sim knowledge folders create [#sim-knowledge-folders-create]

Create a knowledge folder at a path

```bash
sim knowledge folders create <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim knowledge folders delete [#sim-knowledge-folders-delete]

Delete Folder

```bash
sim knowledge folders delete <path> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `--recursive` | No       | Delete the folder and its descendants. |
  | `-y, --yes`   | No       | Skip the confirmation.                 |
</CommandTable>

### sim knowledge folders list [#sim-knowledge-folders-list]

List Folders

```bash
sim knowledge folders list [options]
```

Also available as `sim knowledge folders ls`.

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--parent <value>`     | No       | Direct parent folder path.                                                                                                                                                                           |
  | `--search <value>`     | No       | Case-insensitive substring match against the folder name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
</CommandTable>

### sim knowledge folders move [#sim-knowledge-folders-move]

Rename or move a knowledge folder

```bash
sim knowledge folders move <path> <destination>
```

Also available as `sim knowledge folders mv`.

**Arguments**

<CommandTable>
  | Argument      | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `path`        | Yes      | Folder path; the leading / is optional |
  | `destination` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim knowledge delete [#sim-knowledge-delete]

Delete Knowledge Base

```bash
sim knowledge delete <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                       |
  | -------- | -------- | --------------------------------- |
  | `id`     | Yes      | Unique knowledge base identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim knowledge get [#sim-knowledge-get]

Get Knowledge Base

```bash
sim knowledge get <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                       |
  | -------- | -------- | --------------------------------- |
  | `id`     | Yes      | Unique knowledge base identifier. |
</CommandTable>

### sim knowledge list [#sim-knowledge-list]

List Knowledge Bases

```bash
sim knowledge list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--folder <value>`     | No       | Folder path; the leading / is optional.                                                                                                                                                              |
  | `--search <value>`     | No       | Case-insensitive substring match against the resource name.                                                                                                                                          |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                       |
</CommandTable>

### sim knowledge tags list [#sim-knowledge-tags-list]

List Tags

```bash
sim knowledge tags list <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                       |
  | -------- | -------- | --------------------------------- |
  | `id`     | Yes      | Unique knowledge base identifier. |
</CommandTable>

### sim knowledge search [#sim-knowledge-search]

Search Knowledge

```bash
sim knowledge search [options]
```

**Options**

<CommandTable>
  | Option                           | Required | Description                                                                                                                                                                                                                                                                   |
  | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--kb <value...>`                | Yes      | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line).                                                                                                                                                                                      |
  | `--query <value>`                | No       | Text to search for.                                                                                                                                                                                                                                                           |
  | `--top-k <value>`                | No       | Maximum number of search results to return. Must be a whole number between 1 and 100; the boundary schema only bounds the range, so a fractional value is admitted here and then rejected with 400 during search.                                                             |
  | `--tag-filters <json\|@file>`    | No       | Tag filters as \[\{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin).                                                                                                                                                            |
  | `--search-mode <value>`          | No       | Search algorithm. Accepted values: `vector`, `hybrid`.                                                                                                                                                                                                                        |
  | `--reranker-enabled`             | No       | Re-order retrieved chunks with a reranking model before truncating to `topK`. Ignored for a tag-only search, and billed as an additional search unit. Reranking is best-effort — a provider failure falls back to vector ordering, so check `rerankerStatus` on the response. |
  | `--no-reranker-enabled`          | No       | Send --reranker-enabled as false.                                                                                                                                                                                                                                             |
  | `--reranker-model <value>`       | No       | Reranking model to use when `rerankerEnabled` is true. Defaults to `rerank-v4.0-fast`. Accepted values: `rerank-v4.0-pro`, `rerank-v4.0-fast`, `rerank-v3.5`.                                                                                                                 |
  | `--reranker-input-count <value>` | No       | How many candidate chunks to retrieve before reranking. Defaults to four times `topK`, capped at 100. A larger pool costs more retrieval work but gives the reranker more to choose from.                                                                                     |
</CommandTable>

### sim knowledge update [#sim-knowledge-update]

Update Knowledge Base

```bash
sim knowledge update <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                       |
  | -------- | -------- | --------------------------------- |
  | `id`     | Yes      | Unique knowledge base identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                            | Required | Description                                                                         |
  | --------------------------------- | -------- | ----------------------------------------------------------------------------------- |
  | `--name <value>`                  | No       | New knowledge base name.                                                            |
  | `--description <value>`           | No       | New knowledge base description.                                                     |
  | `--chunking-config <json\|@file>` | No       | New document chunking configuration. (JSON, or @path / @- to read a file or stdin). |
  | `--folder <value>`                | No       | Folder path; the leading / is optional.                                             |
</CommandTable>

### sim knowledge mv [#sim-knowledge-mv]

Move a knowledge base to a folder

```bash
sim knowledge mv <id> <folder>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `id`     | Yes      | Unique knowledge base identifier.      |
  | `folder` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim knowledge ls [#sim-knowledge-ls]

List knowledge resources and child folders together

```bash
sim knowledge ls [path] [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | No       | Folder path to list; defaults to the root folder |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                             |
  | ----------------- | -------- | ----------------------------------------------------------------------- |
  | `--search <text>` | No       | Filter folders and resources by name.                                   |
  | `--limit <n>`     | No       | Maximum combined items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim knowledge mkdir [#sim-knowledge-mkdir]

Create a knowledge directory at a path

```bash
sim knowledge mkdir <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | Yes      | Folder path to create; the leading / is optional |
</CommandTable>

## sim logs [#sim-logs]

Also spelled `sim log`.

### sim logs get [#sim-logs-get]

Show run diagnostics

```bash
sim logs get <runId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                     |
  | -------- | -------- | ------------------------------- |
  | `runId`  | Yes      | Unique workflow run identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option    | Required | Description                                                               |
  | --------- | -------- | ------------------------------------------------------------------------- |
  | `--trace` | No       | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
</CommandTable>

### sim logs list [#sim-logs-list]

List Logs

```bash
sim logs list [options]
```

**Options**

<CommandTable>
  | Option                      | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--workflow <value...>`     | No       | Comma-separated workflow identifiers to include. An empty entry is rejected. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | `--trigger <value...>`      | No       | Comma-separated trigger types to include. An empty entry is rejected. Values are matched exactly and are case-sensitive — every recorded trigger is lowercase, so `API` matches nothing while `api` matches. The vocabulary is open: it covers the core trigger types (`manual`, `api`, `schedule`, `chat`, `webhook`, `mcp`, `copilot`, `workflow`, `custom_block`) and the provider id of any webhook trigger (`slack`, `gmail`, `github`, …), so an unrecognized member is not rejected — it selects no runs. The literal value `all` is a sentinel that disables this filter entirely, so a list containing it returns runs of every trigger type; no real trigger type is named `all`. (space-separated, or @path / @- with one value per line). |
  | `--level <value>`           | No       | Severity level to include. Accepted values: `info`, `error`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | `--start-date <value>`      | No       | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | `--end-date <value>`        | No       | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | `--min-duration-ms <value>` | No       | Minimum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | `--max-duration-ms <value>` | No       | Maximum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | `--min-cost <value>`        | No       | Minimum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | `--max-cost <value>`        | No       | Maximum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | `--model <value>`           | No       | AI model used during execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | `--details <value>`         | No       | Response detail level. Accepted values: `basic`, `full`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  | `--include-trace-spans`     | No       | Include trace spans in JSON or YAML output (implies full detail).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | `--include-final-output`    | No       | Include final output in JSON or YAML output (implies full detail).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | `--limit <n>`               | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | `--order <value>`           | No       | Sort direction by execution start time. This list is sortable only by execution start time, so it takes `order` in place of `sortBy`/`sortOrder`, which it rejects. Accepted values: `asc`, `desc`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | `--run-id <value>`          | No       | Exact run identifier to match.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | `--folder <value...>`       | No       | Folder path; the leading / is optional (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
</CommandTable>

## sim mcp-servers [#sim-mcp-servers]

Also spelled `sim mcp-server`.

### sim mcp-servers create [#sim-mcp-servers-create]

Create MCP Server

```bash
sim mcp-servers create [options]
```

**Options**

<CommandTable>
  | Option                          | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--name <value>`                | Yes      | Server display name.                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | `--description <value>`         | No       | Optional server description.                                                                                                                                                                                                                                                                                                                                                                                                            |
  | `--transport <value>`           | No       | Transport used to communicate with the server. Applied server-side as `streamable-http` when omitted on create. Accepted values: `streamable-http`.                                                                                                                                                                                                                                                                                     |
  | `--url <value>`                 | Yes      | Absolute HTTP or HTTPS endpoint URL without `&#123;&#123;ENV_VAR&#125;&#125;` references. It determines server identity and is immutable: delete and recreate the server to change endpoints.                                                                                                                                                                                                                                           |
  | `--auth-type <value>`           | No       | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. |
  | `--headers <json\|@file>`       | No       | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).                                                                                                                                                                                                                         |
  | `--timeout <value>`             | No       | Per-request timeout in milliseconds. Applied server-side as 30000 when omitted on create.                                                                                                                                                                                                                                                                                                                                               |
  | `--retries <value>`             | No       | Number of retries per request. Applied server-side as 3 when omitted on create.                                                                                                                                                                                                                                                                                                                                                         |
  | `--enabled`                     | No       | Whether the server tools are available to workflows. Applied server-side as true when omitted on create.                                                                                                                                                                                                                                                                                                                                |
  | `--no-enabled`                  | No       | Send --enabled as false.                                                                                                                                                                                                                                                                                                                                                                                                                |
  | `--oauth-client-id <value>`     | No       | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.                                                                                                                                                                                                                                                                                                                |
  | `--oauth-client-secret <value>` | No       | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication.                                                                                                                                                                                                                                 |
</CommandTable>

### sim mcp-servers delete [#sim-mcp-servers-delete]

Delete MCP Server

```bash
sim mcp-servers delete <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                   |
  | -------- | -------- | ----------------------------- |
  | `id`     | Yes      | Unique MCP server identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim mcp-servers get [#sim-mcp-servers-get]

Get MCP Server

```bash
sim mcp-servers get <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                   |
  | -------- | -------- | ----------------------------- |
  | `id`     | Yes      | Unique MCP server identifier. |
</CommandTable>

### sim mcp-servers list [#sim-mcp-servers-list]

List MCP Servers

```bash
sim mcp-servers list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--search <value>`     | No       | Case-insensitive substring match against the server name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                       |
</CommandTable>

### sim mcp-servers tools list [#sim-mcp-servers-tools-list]

List MCP Server Tools

```bash
sim mcp-servers tools list <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                   |
  | -------- | -------- | ----------------------------- |
  | `id`     | Yes      | Unique MCP server identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option         | Required | Description                                                                                                                                                                                                                                               |
  | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--refresh`    | No       | Bypass the short-lived per-workspace tool cache and reconnect under your own credentials. A cached result reflects whichever workspace member last ran discovery, so this is the only way to pick up a tool added since then; it costs a live round trip. |
  | `--no-refresh` | No       | Send --refresh as false.                                                                                                                                                                                                                                  |
</CommandTable>

### sim mcp-servers update [#sim-mcp-servers-update]

Update MCP Server

```bash
sim mcp-servers update <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                   |
  | -------- | -------- | ----------------------------- |
  | `id`     | Yes      | Unique MCP server identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                          | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--name <value>`                | No       | Server display name.                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | `--description <value>`         | No       | Optional server description.                                                                                                                                                                                                                                                                                                                                                                                                            |
  | `--transport <value>`           | No       | Transport used to communicate with the server. Applied server-side as `streamable-http` when omitted on create. Accepted values: `streamable-http`.                                                                                                                                                                                                                                                                                     |
  | `--url <value>`                 | No       | Immutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints.                                                                                                                                                                                                                                                                                                                          |
  | `--auth-type <value>`           | No       | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. |
  | `--headers <json\|@file>`       | No       | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).                                                                                                                                                                                                                         |
  | `--timeout <value>`             | No       | Per-request timeout in milliseconds. Applied server-side as 30000 when omitted on create.                                                                                                                                                                                                                                                                                                                                               |
  | `--retries <value>`             | No       | Number of retries per request. Applied server-side as 3 when omitted on create.                                                                                                                                                                                                                                                                                                                                                         |
  | `--enabled`                     | No       | Whether the server tools are available to workflows. Applied server-side as true when omitted on create.                                                                                                                                                                                                                                                                                                                                |
  | `--no-enabled`                  | No       | Send --enabled as false.                                                                                                                                                                                                                                                                                                                                                                                                                |
  | `--oauth-client-id <value>`     | No       | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.                                                                                                                                                                                                                                                                                                                |
  | `--oauth-client-secret <value>` | No       | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication.                                                                                                                                                                                                                                 |
</CommandTable>

## sim secrets [#sim-secrets]

Also spelled `sim secret`.

### sim secrets delete [#sim-secrets-delete]

Delete Secret

```bash
sim secrets delete <name> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                           |
  | -------- | -------- | ------------------------------------- |
  | `name`   | Yes      | Secret to create, replace, or delete. |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                                                                                                                                                   |
  | ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--scope <value>` | Yes      | Whether the secret belongs to the workspace or to the caller. A personal secret belongs to the caller across every workspace, not to one workspace. Accepted values: `workspace`, `personal`. |
  | `-y, --yes`       | No       | Skip the confirmation.                                                                                                                                                                        |
</CommandTable>

### sim secrets list [#sim-secrets-list]

List Secrets

```bash
sim secrets list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--scope <value>`      | No       | Restrict results to one ownership scope. Accepted values: `workspace`, `personal`.                                                                                                                   |
  | `--search <value>`     | No       | Case-insensitive substring match against the secret name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                       |
</CommandTable>

### sim secrets set [#sim-secrets-set]

Create or replace a named secret

```bash
sim secrets set <name> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                             |
  | -------- | -------- | --------------------------------------- |
  | `name`   | Yes      | Secret name, as referenced in workflows |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                       |
  | ----------------- | -------- | ----------------------------------------------------------------- |
  | `--scope <scope>` | Yes      | Secret ownership scope. Accepted values: `workspace`, `personal`. |
  | `--value <value>` | No       | Secret value; visible to shell history when supplied directly.    |
</CommandTable>

## sim skills [#sim-skills]

Also spelled `sim skill`.

### sim skills create [#sim-skills-create]

Create Skill

```bash
sim skills create [options]
```

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                        |
  | ----------------------- | -------- | ---------------------------------------------------------------------------------- |
  | `--name <value>`        | Yes      | Kebab-case name, unique within the workspace and not reserved by a built-in skill. |
  | `--description <value>` | Yes      | One-line summary of when the skill applies.                                        |
  | `--content <value>`     | Yes      | Skill body containing the instructions given to the agent.                         |
</CommandTable>

### sim skills delete [#sim-skills-delete]

Delete Skill

```bash
sim skills delete <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                                                                                   |
  | -------- | -------- | ------------------------------------------------------------------------------------------------------------- |
  | `id`     | Yes      | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim skills get [#sim-skills-get]

Get Skill

```bash
sim skills get <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                                                                                   |
  | -------- | -------- | ------------------------------------------------------------------------------------------------------------- |
  | `id`     | Yes      | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. |
</CommandTable>

### sim skills list [#sim-skills-list]

List Skills

```bash
sim skills list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--search <value>`     | No       | Case-insensitive substring match against the skill name.                                                                                                                                             |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                       |
</CommandTable>

### sim skills update [#sim-skills-update]

Update Skill

```bash
sim skills update <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                                                                                   |
  | -------- | -------- | ------------------------------------------------------------------------------------------------------------- |
  | `id`     | Yes      | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                                     |
  | ----------------------- | -------- | ----------------------------------------------- |
  | `--name <value>`        | No       | New kebab-case skill name.                      |
  | `--description <value>` | No       | New one-line summary of when the skill applies. |
  | `--content <value>`     | No       | Replacement skill body.                         |
</CommandTable>

## sim tables [#sim-tables]

Also spelled `sim table`.

### sim tables columns create [#sim-tables-columns-create]

Add Column

```bash
sim tables columns create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                              |
  | ------------------------ | -------- | ------------------------------------------------------------------------ |
  | `--column <json\|@file>` | Yes      | Column definition to add. (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim tables columns delete [#sim-tables-columns-delete]

Delete Column

```bash
sim tables columns delete <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                   |
  | ----------------------- | -------- | ----------------------------- |
  | `--column-name <value>` | Yes      | Name of the column to delete. |
  | `-y, --yes`             | No       | Skip the confirmation.        |
</CommandTable>

### sim tables columns run [#sim-tables-columns-run]

Run a column’s workflow

```bash
sim tables columns run <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                         | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--group-ids <value...>`       | Yes      | Workflow or enrichment groups to run. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                       |
  | `--run-mode <value>`           | No       | Whether to run all or only incomplete cells. Accepted values: `all`, `incomplete`.                                                                                                                                                                                                                    |
  | `--row-ids <value...>`         | No       | Explicit row subset to run. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                                 |
  | `--filter <json\|@file>`       | No       | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--exclude-row-ids <value...>` | No       | Rows excluded from a select-all run scope. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                  |
  | `--limit <json\|@file>`        | No       | Optional cap on eligible rows to run. (JSON, or @path / @- to read a file or stdin).                                                                                                                                                                                                                  |
</CommandTable>

### sim tables columns update [#sim-tables-columns-update]

Update Column

```bash
sim tables columns update <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                    | Required | Description                                                           |
  | ------------------------- | -------- | --------------------------------------------------------------------- |
  | `--column-name <value>`   | Yes      | Current name of the column to update.                                 |
  | `--updates <json\|@file>` | Yes      | Mutable column fields. (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim tables groups create [#sim-tables-groups-create]

Add Workflow Group

```bash
sim tables groups create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                           | Required | Description                                                                                |
  | -------------------------------- | -------- | ------------------------------------------------------------------------------------------ |
  | `--group <json\|@file>`          | Yes      | Workflow or enrichment producer definition. (JSON, or @path / @- to read a file or stdin). |
  | `--output-columns <json\|@file>` | Yes      | Columns created for producer outputs. (JSON, or @path / @- to read a file or stdin).       |
  | `--auto-run`                     | No       | Whether to schedule existing rows after group creation.                                    |
  | `--no-auto-run`                  | No       | Send --auto-run as false.                                                                  |
</CommandTable>

### sim tables groups delete [#sim-tables-groups-delete]

Delete Workflow Group

```bash
sim tables groups delete <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option               | Required | Description               |
  | -------------------- | -------- | ------------------------- |
  | `--group-id <value>` | Yes      | Workflow group to delete. |
  | `-y, --yes`          | No       | Skip the confirmation.    |
</CommandTable>

### sim tables groups list [#sim-tables-groups-list]

List Workflow Groups

```bash
sim tables groups list <tableId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

### sim tables groups update [#sim-tables-groups-update]

Update Workflow Group

```bash
sim tables groups update <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                               | Required | Description                                                                                                                                                      |
  | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--group-id <value>`                 | Yes      | Workflow group to update.                                                                                                                                        |
  | `--workflow-id <value>`              | No       | Replacement backing workflow identifier.                                                                                                                         |
  | `--name <value>`                     | No       | Replacement workflow-group display name.                                                                                                                         |
  | `--dependencies <json\|@file>`       | No       | Replacement input dependencies. (JSON, or @path / @- to read a file or stdin).                                                                                   |
  | `--outputs <json\|@file>`            | No       | Replacement producer outputs. (JSON, or @path / @- to read a file or stdin).                                                                                     |
  | `--new-output-columns <json\|@file>` | No       | Columns to add for new outputs. (JSON, or @path / @- to read a file or stdin).                                                                                   |
  | `--mapping-updates <json\|@file>`    | No       | Existing output-column mapping changes. (JSON, or @path / @- to read a file or stdin).                                                                           |
  | `--input-mappings <json\|@file>`     | No       | Replacement workflow input mappings. (JSON, or @path / @- to read a file or stdin).                                                                              |
  | `--deployment-mode <value>`          | No       | Replacement workflow execution mode. Accepted values: `live`, `deployed`.                                                                                        |
  | `--type <value>`                     | No       | Workflow-group producer type. Must match the group's stored type — a group's producer cannot be changed after creation. Accepted values: `manual`, `enrichment`. |
  | `--auto-run`                         | No       | Replacement automatic-run setting.                                                                                                                               |
  | `--no-auto-run`                      | No       | Send --auto-run as false.                                                                                                                                        |
</CommandTable>

### sim tables exports cancel [#sim-tables-exports-cancel]

Cancel Table Export

```bash
sim tables exports cancel <exportId>
```

**Arguments**

<CommandTable>
  | Argument   | Required | Description                     |
  | ---------- | -------- | ------------------------------- |
  | `exportId` | Yes      | Unique table-export identifier. |
</CommandTable>

### sim tables exports create [#sim-tables-exports-create]

Create Table Export

```bash
sim tables exports create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option             | Required | Description                                         |
  | ------------------ | -------- | --------------------------------------------------- |
  | `--format <value>` | No       | Export file format. Accepted values: `csv`, `json`. |
</CommandTable>

### sim tables exports get [#sim-tables-exports-get]

Get Table Export

```bash
sim tables exports get <exportId>
```

**Arguments**

<CommandTable>
  | Argument   | Required | Description                     |
  | ---------- | -------- | ------------------------------- |
  | `exportId` | Yes      | Unique table-export identifier. |
</CommandTable>

### sim tables exports download [#sim-tables-exports-download]

Get the download URL for a finished export

```bash
sim tables exports download <exportId>
```

**Arguments**

<CommandTable>
  | Argument   | Required | Description                     |
  | ---------- | -------- | ------------------------------- |
  | `exportId` | Yes      | Unique table-export identifier. |
</CommandTable>

### sim tables imports cancel [#sim-tables-imports-cancel]

Cancel Table Import

```bash
sim tables imports cancel <importId>
```

**Arguments**

<CommandTable>
  | Argument   | Required | Description                     |
  | ---------- | -------- | ------------------------------- |
  | `importId` | Yes      | Unique table-import identifier. |
</CommandTable>

### sim tables imports get [#sim-tables-imports-get]

Get Table Import

```bash
sim tables imports get <importId>
```

**Arguments**

<CommandTable>
  | Argument   | Required | Description                     |
  | ---------- | -------- | ------------------------------- |
  | `importId` | Yes      | Unique table-import identifier. |
</CommandTable>

### sim tables cancel-runs [#sim-tables-cancel-runs]

Stop every running column job

```bash
sim tables cancel-runs <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                         | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--scope <value>`              | Yes      | Whether to cancel across the table or one row. Accepted values: `all`, `row`.                                                                                                                                                                                                                         |
  | `--row-id <value>`             | No       | Row whose runs should be canceled for row scope.                                                                                                                                                                                                                                                      |
  | `--filter <json\|@file>`       | No       | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--exclude-row-ids <value...>` | No       | Rows excluded from an all-scope cancellation. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                               |
</CommandTable>

### sim tables create [#sim-tables-create]

Create Table

```bash
sim tables create [options]
```

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                    |
  | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------- |
  | `--name <value>`         | Yes      | Identifier: letters, numbers, and underscores; cannot start with a number.                                     |
  | `--description <value>`  | No       | Optional table description.                                                                                    |
  | `--schema <json\|@file>` | Yes      | Table schema: \{"columns":\[\{"name":"email","type":"string"}]} (JSON, or @path / @- to read a file or stdin). |
  | `--folder <value>`       | No       | Folder path; the leading / is optional.                                                                        |
</CommandTable>

### sim tables folders create [#sim-tables-folders-create]

Create a table folder at a path

```bash
sim tables folders create <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim tables folders delete [#sim-tables-folders-delete]

Delete Folder

```bash
sim tables folders delete <path> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `--recursive` | No       | Delete the folder and its descendants. |
  | `-y, --yes`   | No       | Skip the confirmation.                 |
</CommandTable>

### sim tables folders list [#sim-tables-folders-list]

List Folders

```bash
sim tables folders list [options]
```

Also available as `sim tables folders ls`.

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--parent <value>`     | No       | Direct parent folder path.                                                                                                                                                                           |
  | `--search <value>`     | No       | Case-insensitive substring match against the folder name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
</CommandTable>

### sim tables folders move [#sim-tables-folders-move]

Rename or move a table folder

```bash
sim tables folders move <path> <destination>
```

Also available as `sim tables folders mv`.

**Arguments**

<CommandTable>
  | Argument      | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `path`        | Yes      | Folder path; the leading / is optional |
  | `destination` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim tables rows create [#sim-tables-rows-create]

Create Rows

```bash
sim tables rows create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                            |
  | ---------------------- | -------- | -------------------------------------------------------------------------------------- |
  | `--data <json\|@file>` | No       | One row keyed by column name (JSON, or @path / @-; choose exactly one body flag).      |
  | `--rows <json\|@file>` | No       | Several rows keyed by column name (JSON, or @path / @-; choose exactly one body flag). |
</CommandTable>

### sim tables rows delete [#sim-tables-rows-delete]

Delete Row

```bash
sim tables rows delete <tableId> <rowId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                  |
  | --------- | -------- | ---------------------------- |
  | `tableId` | Yes      | Unique table identifier.     |
  | `rowId`   | Yes      | Unique table row identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim tables rows batch-delete [#sim-tables-rows-batch-delete]

Delete rows matching a filter, or an explicit list of ids

```bash
sim tables rows batch-delete <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--filter <json\|@file>` | No       | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--limit <n>`            | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                        |
  | `--row <value...>`       | No       | Explicit row identifiers to delete. (space-separated, or @path / @- with one value per line).                                                                                                                                                                                                         |
  | `-y, --yes`              | No       | Skip the confirmation.                                                                                                                                                                                                                                                                                |
</CommandTable>

### sim tables rows find [#sim-tables-rows-find]

Find rows matching a predicate

```bash
sim tables rows find <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--q <value>`            | Yes      | Value to find.                                                                                                                                                                                                                                                                                        |
  | `--filter <json\|@file>` | No       | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--sort <json\|@file>`   | No       | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin).                                                                                                                                                               |
</CommandTable>

### sim tables rows get [#sim-tables-rows-get]

Get Row

```bash
sim tables rows get <tableId> <rowId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                  |
  | --------- | -------- | ---------------------------- |
  | `tableId` | Yes      | Unique table identifier.     |
  | `rowId`   | Yes      | Unique table row identifier. |
</CommandTable>

### sim tables rows list [#sim-tables-rows-list]

List Rows

```bash
sim tables rows list <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                                                    |
  | ------------- | -------- | -------------------------------------------------------------- |
  | `--limit <n>` | No       | Maximum items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim tables rows query [#sim-tables-rows-query]

Query Rows

```bash
sim tables rows query <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--filter <json\|@file>` | No       | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--sort <json\|@file>`   | No       | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin).                                                                                                                                                               |
  | `--limit <n>`            | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                        |
</CommandTable>

### sim tables rows enrich [#sim-tables-rows-enrich]

Run one row’s enrichment group

```bash
sim tables rows enrich <tableId> <rowId> <groupId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                          |
  | --------- | -------- | ------------------------------------ |
  | `tableId` | Yes      | Unique table identifier.             |
  | `rowId`   | Yes      | Unique table row identifier.         |
  | `groupId` | Yes      | Workflow or enrichment group to run. |
</CommandTable>

### sim tables rows batch-update [#sim-tables-rows-batch-update]

Update every row matching a filter

```bash
sim tables rows batch-update <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                                                                                                                                                                                                                           |
  | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--filter <json\|@file>` | Yes      | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). |
  | `--data <json\|@file>`   | Yes      | Row-data patch applied to every matching row. (JSON, or @path / @- to read a file or stdin).                                                                                                                                                                                                          |
  | `--limit <n>`            | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                                                                        |
  | `-y, --yes`              | No       | Skip the confirmation.                                                                                                                                                                                                                                                                                |
</CommandTable>

### sim tables rows update [#sim-tables-rows-update]

Update Row

```bash
sim tables rows update <tableId> <rowId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                  |
  | --------- | -------- | ---------------------------- |
  | `tableId` | Yes      | Unique table identifier.     |
  | `rowId`   | Yes      | Unique table row identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                 |
  | ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
  | `--data <json\|@file>` | Yes      | Partial row-data patch keyed by column name. (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim tables views create [#sim-tables-views-create]

Create View

```bash
sim tables views create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                   | Required | Description                                                                                         |
  | ------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
  | `--name <value>`         | Yes      | Saved-view display name.                                                                            |
  | `--config <json\|@file>` | Yes      | Saved filter, sort, and column-layout configuration. (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim tables views delete [#sim-tables-views-delete]

Delete View

```bash
sim tables views delete <tableId> <viewId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                   |
  | --------- | -------- | ----------------------------- |
  | `tableId` | Yes      | Unique table identifier.      |
  | `viewId`  | Yes      | Unique saved-view identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim tables views get [#sim-tables-views-get]

Get View

```bash
sim tables views get <tableId> <viewId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                   |
  | --------- | -------- | ----------------------------- |
  | `tableId` | Yes      | Unique table identifier.      |
  | `viewId`  | Yes      | Unique saved-view identifier. |
</CommandTable>

### sim tables views list [#sim-tables-views-list]

List Views

```bash
sim tables views list <tableId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

### sim tables views update [#sim-tables-views-update]

Update View

```bash
sim tables views update <tableId> <viewId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                   |
  | --------- | -------- | ----------------------------- |
  | `tableId` | Yes      | Unique table identifier.      |
  | `viewId`  | Yes      | Unique saved-view identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                         | Required | Description                                                                                      |
  | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------ |
  | `--name <value>`               | No       | Replacement saved-view display name.                                                             |
  | `--config <json\|@file>`       | No       | Complete replacement saved-view configuration. (JSON, or @path / @- to read a file or stdin).    |
  | `--config-patch <json\|@file>` | No       | Saved-view configuration fields to shallow-merge. (JSON, or @path / @- to read a file or stdin). |
  | `--is-default`                 | No       | Whether to promote this view to the table default.                                               |
  | `--no-is-default`              | No       | Send --is-default as false.                                                                      |
</CommandTable>

### sim tables delete [#sim-tables-delete]

Delete Table

```bash
sim tables delete <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim tables get [#sim-tables-get]

Get Table

```bash
sim tables get <tableId>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

### sim tables list [#sim-tables-list]

List Tables

```bash
sim tables list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--folder <value>`     | No       | Folder path; the leading / is optional.                                                                                                                                                              |
  | `--search <value>`     | No       | Case-insensitive substring match against the resource name.                                                                                                                                          |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                       |
</CommandTable>

### sim tables count create [#sim-tables-count-create]

Count Rows

```bash
sim tables count create <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                      | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--predicate <json\|@file>` | No       | Recursive predicate tree. Each group node is exactly one non-empty `all` or `any` array whose members are further groups or `&#123; field, op, value &#125;` conditions; the root must be a group, not a bare condition. At most 100 members per group, 10 levels of nesting, and 500 nodes in total. The negating operators include nulls: `ne`, `nin`, `ncontains`, `nlike`, and `nilike` match rows whose column is null or absent, so "not X" is not the complement of "X" over a nullable column. That holds for every column type, multi-select included. To exclude nulls, `all`-combine the negation with `isNotEmpty` (multi-select) or `isNotNull`. Comparison: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`. Membership: `in`, `nin` (array operand). Emptiness: `isEmpty`, `isNotEmpty`, `isNull`, `isNotNull` (no operand). Substring, always case-insensitive, operand matched literally: `contains`, `ncontains`, `startsWith`, `endsWith`. Pattern: `like`/`nlike` (case-sensitive), `ilike`/`nilike&#x60; (case-insensitive). **`*` is the only wildcard** and stands for any run of characters; `%`, `_`, and backslash match themselves. Use `like: "Hi*"`, not `like: "Hi%"`. A `select` column compares by option id and restricts its operators: single-select accepts `eq`, `ne`, `in`, `nin`; multi-select accepts `contains`, `ncontains`. Option names are accepted as operands and resolved to ids. (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim tables update [#sim-tables-update]

Update Table

```bash
sim tables update <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                                                                |
  | ----------------------- | -------- | -------------------------------------------------------------------------- |
  | `--name <value>`        | No       | Identifier: letters, numbers, and underscores; cannot start with a number. |
  | `--description <value>` | No       | Replacement table description, or null to clear it.                        |
  | `--folder <value>`      | No       | Folder path; the leading / is optional.                                    |
</CommandTable>

### sim tables mv [#sim-tables-mv]

Move a table to a folder

```bash
sim tables mv <tableId> <folder>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                            |
  | --------- | -------- | -------------------------------------- |
  | `tableId` | Yes      | Unique table identifier.               |
  | `folder`  | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim tables upsert [#sim-tables-upsert]

Insert a row, or update the one that conflicts on a unique column

```bash
sim tables upsert <tableId> [options]
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description              |
  | --------- | -------- | ------------------------ |
  | `tableId` | Yes      | Unique table identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                                                                                                      |
  | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--data <json\|@file>` | Yes      | Complete set of row cells keyed by column name. On the update branch this REPLACES the matched row: any column not present here is cleared, unlike the merging `PATCH /api/v2/tables/&#123;tableId&#125;/rows/&#123;rowId&#125;`. (JSON, or @path / @- to read a file or stdin). |
  | `--on <value>`         | No       | Unique column to resolve the conflict against.                                                                                                                                                                                                                                   |
</CommandTable>

### sim tables import [#sim-tables-import]

Import a CSV, into a new table by default

```bash
sim tables import [path] [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                         |
  | -------- | -------- | --------------------------------------------------- |
  | `path`   | No       | Local CSV file to import; omit when using --file-id |
</CommandTable>

**Options**

<CommandTable>
  | Option                           | Required | Description                                                                                           |
  | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------- |
  | `--name <name>`                  | No       | Identifier for the new table: letters, numbers, and underscores; defaults to the sanitized file name. |
  | `--table-id <id>`                | No       | Import into this existing table instead of creating one.                                              |
  | `--mode <append\|replace>`       | No       | How to write into --table-id (default: append). Accepted values: `append`, `replace`.                 |
  | `--folder <path>`                | No       | Folder path for the new table.                                                                        |
  | `--file-id <id>`                 | No       | Import a file already in the workspace instead of a local path.                                       |
  | `--mapping <json\|@file>`        | No       | Column mapping (--table-id only).                                                                     |
  | `--create-columns <json\|@file>` | No       | Columns to create (--table-id only).                                                                  |
  | `--timezone <iana>`              | No       | Timezone for date parsing, e.g. America/New\_York.                                                    |
  | `--no-wait`                      | No       | Return once the import is queued instead of watching it.                                              |
</CommandTable>

### sim tables ls [#sim-tables-ls]

List table resources and child folders together

```bash
sim tables ls [path] [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | No       | Folder path to list; defaults to the root folder |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                             |
  | ----------------- | -------- | ----------------------------------------------------------------------- |
  | `--search <text>` | No       | Filter folders and resources by name.                                   |
  | `--limit <n>`     | No       | Maximum combined items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim tables mkdir [#sim-tables-mkdir]

Create a table directory at a path

```bash
sim tables mkdir <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | Yes      | Folder path to create; the leading / is optional |
</CommandTable>

## sim workflows [#sim-workflows]

Also spelled `sim workflow`.

### sim workflows runs cancel [#sim-workflows-runs-cancel]

Cancel a running workflow run

```bash
sim workflows runs cancel <runId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                     |
  | -------- | -------- | ------------------------------- |
  | `runId`  | Yes      | Unique workflow run identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                    | Required | Description  |
  | ------------------------- | -------- | ------------ |
  | `--workflow <workflowId>` | Yes      | Workflow ID. |
</CommandTable>

### sim workflows runs get [#sim-workflows-runs-get]

Show run status (requested outputs are included in JSON or YAML output)

```bash
sim workflows runs get <runId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                     |
  | -------- | -------- | ------------------------------- |
  | `runId`  | Yes      | Unique workflow run identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                       | Required | Description                                                                                                                             |
  | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
  | `--workflow <workflowId>`    | Yes      | Workflow ID.                                                                                                                            |
  | `--include-output`           | No       | Include the final output in JSON or YAML output.                                                                                        |
  | `--select-output <value...>` | No       | Include blockName.field values in JSON or YAML output (e.g. agent\_1.content) (space-separated, or @path / @- with one value per line). |
</CommandTable>

### sim workflows runs list [#sim-workflows-runs-list]

List runs for a workflow

```bash
sim workflows runs list [options]
```

**Options**

<CommandTable>
  | Option                    | Required | Description                                                                                                                                                                                                                                   |
  | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--workflow <workflowId>` | Yes      | Workflow ID.                                                                                                                                                                                                                                  |
  | `--status <value>`        | No       | Filter by run status. Accepted values: `pending`, `running`, `completed`, `failed`, `cancelled`, `paused`.                                                                                                                                    |
  | `--trigger <value>`       | No       | Filter by trigger type.                                                                                                                                                                                                                       |
  | `--start-date <value>`    | No       | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant.  |
  | `--end-date <value>`      | No       | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. |
  | `--limit <n>`             | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                                                |
  | `--order <value>`         | No       | Sort direction by run start time. This list is sortable only by run start time, so it takes `order` in place of `sortBy`/`sortOrder`, which it rejects. Accepted values: `asc`, `desc`.                                                       |
</CommandTable>

### sim workflows runs resume [#sim-workflows-runs-resume]

Resume a paused run (output is included in JSON or YAML output)

```bash
sim workflows runs resume <runId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                     |
  | -------- | -------- | ------------------------------- |
  | `runId`  | Yes      | Unique workflow run identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                    | Required | Description                                                         |
  | ------------------------- | -------- | ------------------------------------------------------------------- |
  | `--workflow <workflowId>` | Yes      | Workflow ID.                                                        |
  | `--context <value>`       | Yes      | Pause context ID returned by run status.                            |
  | `--input <json\|@file>`   | No       | Resume input as JSON (JSON, or @path / @- to read a file or stdin). |
</CommandTable>

### sim workflows create [#sim-workflows-create]

Create Workflow

```bash
sim workflows create [options]
```

**Options**

<CommandTable>
  | Option                  | Required | Description                             |
  | ----------------------- | -------- | --------------------------------------- |
  | `--name <value>`        | Yes      | Workflow name.                          |
  | `--description <value>` | No       | Optional workflow description.          |
  | `--folder <value>`      | No       | Folder path; the leading / is optional. |
</CommandTable>

### sim workflows folders create [#sim-workflows-folders-create]

Create a workflow folder at a path

```bash
sim workflows folders create <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim workflows folders delete [#sim-workflows-folders-delete]

Delete Workflow Folder

```bash
sim workflows folders delete <path> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `path`   | Yes      | Folder path; the leading / is optional |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `--recursive` | No       | Delete the folder and its descendants. |
  | `-y, --yes`   | No       | Skip the confirmation.                 |
</CommandTable>

### sim workflows folders list [#sim-workflows-folders-list]

List Workflow Folders

```bash
sim workflows folders list [options]
```

Also available as `sim workflows folders ls`.

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                          |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--parent <value>`     | No       | Direct parent folder path.                                                                                                                                                                           |
  | `--search <value>`     | No       | Case-insensitive substring match against the folder name.                                                                                                                                            |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                      |
</CommandTable>

### sim workflows folders move [#sim-workflows-folders-move]

Rename or move a workflow folder

```bash
sim workflows folders move <path> <destination>
```

Also available as `sim workflows folders mv`.

**Arguments**

<CommandTable>
  | Argument      | Required | Description                            |
  | ------------- | -------- | -------------------------------------- |
  | `path`        | Yes      | Folder path; the leading / is optional |
  | `destination` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim workflows delete [#sim-workflows-delete]

Delete Workflow

```bash
sim workflows delete <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option      | Required | Description            |
  | ----------- | -------- | ---------------------- |
  | `-y, --yes` | No       | Skip the confirmation. |
</CommandTable>

### sim workflows deploy [#sim-workflows-deploy]

Deploy Workflow

```bash
sim workflows deploy <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                                       |
  | ----------------------- | -------- | ------------------------------------------------- |
  | `--name <value>`        | No       | Optional label for the deployment version.        |
  | `--description <value>` | No       | Optional release note for the deployment version. |
</CommandTable>

### sim workflows run [#sim-workflows-run]

Run a deployed workflow

```bash
sim workflows run <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                                | Required | Description                                                                                                                                                                                                                                                                                                  |
  | ------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `--input <json\|@file>`               | No       | Trigger input as JSON (JSON, or @path / @- to read a file or stdin).                                                                                                                                                                                                                                         |
  | `--async`                             | No       | Queue the run and return immediately.                                                                                                                                                                                                                                                                        |
  | `--execution-timeout-seconds <value>` | No       | Requested server-side timeout for an asynchronous run, in seconds. An upper bound, not the effective timeout: the run uses the smaller of this value and the plan's execution timeout, so requesting more than the plan allows silently yields the plan timeout. Rejected with `400` unless `async` is true. |
  | `--select-output <value...>`          | No       | Return blockName.field values (e.g. agent\_1.content); missing fields are omitted (space-separated, or @path / @- with one value per line).                                                                                                                                                                  |
  | `--include-file-base64`               | No       | Inline eligible output files as base64 content. Rejected when `async` is true.                                                                                                                                                                                                                               |
  | `--no-include-file-base64`            | No       | Send --include-file-base64 as false.                                                                                                                                                                                                                                                                         |
  | `--base64-max-bytes <value>`          | No       | Maximum total bytes of file content to inline as base64. Rejected when `async` is true.                                                                                                                                                                                                                      |
</CommandTable>

### sim workflows export [#sim-workflows-export]

Print a workflow as a portable JSON document

```bash
sim workflows export <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

### sim workflows get [#sim-workflows-get]

Get Workflow

```bash
sim workflows get <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

### sim workflows deployment list [#sim-workflows-deployment-list]

Get Workflow Deployment

```bash
sim workflows deployment list <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

### sim workflows versions get [#sim-workflows-versions-get]

Get Workflow Version

```bash
sim workflows versions get <id> <version>
```

**Arguments**

<CommandTable>
  | Argument  | Required | Description                 |
  | --------- | -------- | --------------------------- |
  | `id`      | Yes      | Unique workflow identifier. |
  | `version` | Yes      | Numeric deployment version. |
</CommandTable>

### sim workflows versions list [#sim-workflows-versions-list]

List Workflow Versions

```bash
sim workflows versions list <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option        | Required | Description                                                    |
  | ------------- | -------- | -------------------------------------------------------------- |
  | `--limit <n>` | No       | Maximum items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim workflows import [#sim-workflows-import]

Import Workflow

```bash
sim workflows import [options]
```

**Options**

<CommandTable>
  | Option                     | Required | Description                                                                                                                        |
  | -------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
  | `--workflow <json\|@file>` | Yes      | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). |
  | `--folder <value>`         | No       | Folder path; the leading / is optional.                                                                                            |
  | `--name <value>`           | No       | Override for the imported workflow name.                                                                                           |
  | `--description <value>`    | No       | Override for the imported workflow description.                                                                                    |
</CommandTable>

### sim workflows list [#sim-workflows-list]

List Workflows

```bash
sim workflows list [options]
```

**Options**

<CommandTable>
  | Option                 | Required | Description                                                                                                                                                                                                                  |
  | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `--folder <value>`     | No       | Folder path; the leading / is optional.                                                                                                                                                                                      |
  | `--deployed-only`      | No       | Return only workflows with an active deployment when true.                                                                                                                                                                   |
  | `--no-deployed-only`   | No       | Send --deployed-only as false.                                                                                                                                                                                               |
  | `--limit <n>`          | No       | Maximum items to return (0 for everything). Defaults to `100`.                                                                                                                                                               |
  | `--search <value>`     | No       | Case-insensitive substring match against the resource name.                                                                                                                                                                  |
  | `--sort-by <value>`    | No       | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `position`, `name`, `createdAt`, `updatedAt`, `runCount`. |
  | `--sort-order <value>` | No       | Sort direction. Accepted values: `asc`, `desc`.                                                                                                                                                                              |
</CommandTable>

### sim workflows rollback [#sim-workflows-rollback]

Rollback Workflow

```bash
sim workflows rollback <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option              | Required | Description                                                                   |
  | ------------------- | -------- | ----------------------------------------------------------------------------- |
  | `--version <value>` | No       | Deployment version to reactivate. Omit to select the previous active version. |
</CommandTable>

### sim workflows undeploy [#sim-workflows-undeploy]

Take a workflow out of deployment

```bash
sim workflows undeploy <id>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

### sim workflows update [#sim-workflows-update]

Update Workflow

```bash
sim workflows update <id> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                 |
  | -------- | -------- | --------------------------- |
  | `id`     | Yes      | Unique workflow identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option                  | Required | Description                                       |
  | ----------------------- | -------- | ------------------------------------------------- |
  | `--name <value>`        | No       | Replacement workflow name.                        |
  | `--description <value>` | No       | Replacement workflow description; null clears it. |
  | `--folder <value>`      | No       | Folder path; the leading / is optional.           |
</CommandTable>

### sim workflows mv [#sim-workflows-mv]

Move a workflow to a folder

```bash
sim workflows mv <id> <folder>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                            |
  | -------- | -------- | -------------------------------------- |
  | `id`     | Yes      | Unique workflow identifier.            |
  | `folder` | Yes      | Folder path; the leading / is optional |
</CommandTable>

### sim workflows ls [#sim-workflows-ls]

List workflow resources and child folders together

```bash
sim workflows ls [path] [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | No       | Folder path to list; defaults to the root folder |
</CommandTable>

**Options**

<CommandTable>
  | Option            | Required | Description                                                             |
  | ----------------- | -------- | ----------------------------------------------------------------------- |
  | `--search <text>` | No       | Filter folders and resources by name.                                   |
  | `--limit <n>`     | No       | Maximum combined items to return (0 for everything). Defaults to `100`. |
</CommandTable>

### sim workflows mkdir [#sim-workflows-mkdir]

Create a workflow directory at a path

```bash
sim workflows mkdir <path>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description                                      |
  | -------- | -------- | ------------------------------------------------ |
  | `path`   | Yes      | Folder path to create; the leading / is optional |
</CommandTable>

## sim workspaces [#sim-workspaces]

Also spelled `sim workspace`.

### sim workspaces get [#sim-workspaces-get]

Get Workspace

```bash
sim workspaces get
```

### sim workspaces members [#sim-workspaces-members]

List workspace members

```bash
sim workspaces members [options]
```

**Options**

<CommandTable>
  | Option        | Required | Description                                                    |
  | ------------- | -------- | -------------------------------------------------------------- |
  | `--limit <n>` | No       | Maximum items to return (0 for everything). Defaults to `100`. |
</CommandTable>
