Skip to content

fix(cli): resolve findings from a full command-surface audit #6788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waleedlatif1 merged 3 commits into from
Aug 17, 2026
Merged

fix(cli): resolve findings from a full command-surface audit #6788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cdcf46
fix(cli): resolve findings from a full command-surface audit
waleedlatif1 Aug 17, 2026
00fca62
fix(cli): clear the paging progress line when a page fails
waleedlatif1 Aug 17, 2026
ac958ac
fix(cli): name a working API root when an endpoint redirects
waleedlatif1 Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions apps/docs/content/docs/en/cli/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,18 @@ re-logging into an existing profile preselects the one already configured.
## Checking who you are

```bash
sim whoami
sim whoami # resolved settings, plus a live check that they work
sim whoami --no-verify # resolved settings only, no request
```

Prints the resolved endpoint, workspace, output format, and account, and which
source each value came from.
Prints the resolved endpoint, workspace, and output format, and which source each
value came from, then reads the configured workspace to prove the key is accepted
and can reach it.

It exits `0` when the check passes, `1` when the credentials are wrong, and `2`
when the check could not be made at all — no workspace to check against, or an
endpoint that did not answer. The split matters in CI: only `1` is fixed by
logging in again.

## Signing out

Expand Down
14 changes: 12 additions & 2 deletions apps/docs/content/docs/en/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,22 @@ sim logout [options]

</CommandTable>

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

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

**Options**

<CommandTable>

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

</CommandTable>

## List the profiles defined in the config and credentials files

```bash
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/en/cli/credentials.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ sim credentials delete <credentialId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/en/cli/custom-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ sim custom-tools delete <id> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down
24 changes: 12 additions & 12 deletions apps/docs/content/docs/en/cli/files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sim files batch-delete [options]
| 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. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand All @@ -40,7 +40,7 @@ sim files create [options]
| --- | --- | --- |
| `--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. |
| `--folder <value>` | No | Folder path as shown in the app; 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`. |

Expand All @@ -58,7 +58,7 @@ sim files folders create <path>

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -74,7 +74,7 @@ sim files folders delete <path> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -85,7 +85,7 @@ sim files folders delete <path> [options]
| Option | Required | Description |
| --- | --- | --- |
| `--recursive` | No | Delete the folder and its descendants. |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down Expand Up @@ -124,8 +124,8 @@ Also available as `sim files folders mv`.

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `destination` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |
| `destination` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -151,7 +151,7 @@ sim files delete <fileId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down Expand Up @@ -238,7 +238,7 @@ sim files list [options]

| Option | Required | Description |
| --- | --- | --- |
| `--folder <value>` | No | Folder path; the leading / is optional. |
| `--folder <value>` | No | Folder path as shown in the app; 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`. |
Expand Down Expand Up @@ -292,10 +292,10 @@ sim files rename <fileId> [options]

</CommandTable>

## Restore file
## Restore an archived file

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

**Arguments**
Expand Down Expand Up @@ -357,7 +357,7 @@ sim files upload <path> [options]

| Option | Required | Description |
| --- | --- | --- |
| `--folder <path>` | No | Destination folder path (defaults to /). |
| `--folder <path>` | No | Folder path as shown in the app; defaults to the root folder. |
| `--name <name>` | No | Store it under a different name. |

</CommandTable>
Expand Down
30 changes: 15 additions & 15 deletions apps/docs/content/docs/en/cli/knowledge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ sim knowledge documents delete <knowledgeBaseId> <documentId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down Expand Up @@ -116,7 +116,7 @@ sim knowledge documents list <knowledgeBaseId> [options]
## Update document

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

**Arguments**
Expand All @@ -125,7 +125,7 @@ sim knowledge documents update <id> <documentId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Unique knowledge base identifier. |
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |
| `documentId` | Yes | Unique knowledge document identifier. |

</CommandTable>
Expand Down Expand Up @@ -209,7 +209,7 @@ sim knowledge create [options]
| `--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. |
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |

</CommandTable>

Expand All @@ -225,7 +225,7 @@ sim knowledge folders create <path>

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -241,7 +241,7 @@ sim knowledge folders delete <path> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -252,7 +252,7 @@ sim knowledge folders delete <path> [options]
| Option | Required | Description |
| --- | --- | --- |
| `--recursive` | No | Delete the folder and its descendants. |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down Expand Up @@ -291,8 +291,8 @@ Also available as `sim knowledge folders mv`.

| Argument | Required | Description |
| --- | --- | --- |
| `path` | Yes | Folder path; the leading / is optional |
| `destination` | Yes | Folder path; the leading / is optional |
| `path` | Yes | Folder path as shown in the app; the leading / is optional |
| `destination` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand All @@ -318,7 +318,7 @@ sim knowledge delete <id> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down Expand Up @@ -350,7 +350,7 @@ sim knowledge list [options]

| Option | Required | Description |
| --- | --- | --- |
| `--folder <value>` | No | Folder path; the leading / is optional. |
| `--folder <value>` | No | Folder path as shown in the app; 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`. |
Expand All @@ -361,7 +361,7 @@ sim knowledge list [options]
## List tags

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

**Arguments**
Expand All @@ -370,7 +370,7 @@ sim knowledge tags list <id>

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Unique knowledge base identifier. |
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |

</CommandTable>

Expand Down Expand Up @@ -423,7 +423,7 @@ sim knowledge update <id> [options]
| `--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. |
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |

</CommandTable>

Expand All @@ -440,7 +440,7 @@ sim knowledge mv <id> <folder>
| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Unique knowledge base identifier. |
| `folder` | Yes | Folder path; the leading / is optional |
| `folder` | Yes | Folder path as shown in the app; the leading / is optional |

</CommandTable>

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/en/cli/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ sim logs list [options]
| `--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`. |
| `--details <value>` | No | Response detail level; full is requested by default to name each run’s workflow. 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). |
| `--folder <value...>` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line). |

</CommandTable>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/en/cli/mcp-servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ sim mcp-servers delete <id> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | No | Skip the confirmation. |
| `-y, --yes` | Yes | Confirm this destructive operation. |

</CommandTable>

Expand Down
Loading
Loading