Skip to content

fix(cli,api): close defects found by live-testing the published CLI #7149

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

Closed
waleedlatif1 wants to merge 8 commits into from
Closed

fix(cli,api): close defects found by live-testing the published CLI #7149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bcd9f2e
fix(cli): refuse what the help already says is invalid
waleedlatif1 Aug 27, 2026
42e4f5a
fix(knowledge): report what a bulk document sweep did, and refuse tag…
waleedlatif1 Aug 27, 2026
aee6a90
fix(api): pin two authorization invariants, and say what these reads …
waleedlatif1 Aug 27, 2026
7697d7f
fix(v2): name the folder filter the same way on every list that has one
waleedlatif1 Aug 27, 2026
fe7995c
chore: regenerate the API reference, CLI surface, and CLI docs
waleedlatif1 Aug 27, 2026
6972149
fix(knowledge): check a tag slot under the lock that clears it
waleedlatif1 Aug 27, 2026
921b43c
fix: deliver the diagnostics this branch added, and say it readably
waleedlatif1 Aug 27, 2026
0b107f5
fix(knowledge): check the slot values actually being written, however…
waleedlatif1 Aug 27, 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
2 changes: 1 addition & 1 deletion apps/docs/content/docs/en/cli/billing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Show billing status and current-period credit usage (credits and storage require
sim billing logs [options]
```

List credit usage events (a personal API key reports only your own events; a workspace API key reports every member's)
List credit usage events (a personal API key reports only your own events; a workspace API key reports every member's in aggregate, unattributed)

**Options**

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 @@ -33,7 +33,7 @@ Disconnect Credential (personal API key required)

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this 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 <customToolId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down
16 changes: 8 additions & 8 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; @@value for a literal leading @). |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

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

</CommandTable>

## List folders
## List folders; returns the whole set, so there is no --limit and no paging

```bash
sim files folders list [options]
Expand All @@ -107,7 +107,7 @@ Also available as `sim files folders ls`.
| `--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`. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) returns live folders only; `archived` returns folders a recursive delete soft-deleted, which is how a caller finds a path to hand to the folder restore. Authorization is identical for both. Accepted values: `active`, `archived`. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) returns live folders only; `archived` returns folders soft-deleted by a recursive delete, which is how a caller finds a path to hand to the folder restore. Authorization is identical for both. Accepted values: `active`, `archived`. |

</CommandTable>

Expand Down Expand Up @@ -168,7 +168,7 @@ sim files delete <fileId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand All @@ -194,7 +194,7 @@ sim files describe <fileId> [options]

| 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 the file is restored. Authorization is identical for both. Accepted values: `active`, `archived`. |
| `--scope <value>` | No | Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file soft-deleted by a delete; `archived` also resolves soft-deleted files, so metadata stays readable before the file is restored. Authorization is identical for both. Accepted values: `active`, `archived`. |

</CommandTable>

Expand Down Expand Up @@ -260,7 +260,7 @@ sim files list [options]
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
| `--recursive` | No | Whether the folder filter includes files in subfolders. Defaults to true when a search is set, false otherwise, so listing a folder shows that folder while searching one looks through everything in it. Ignored when no folder filter is set, which already spans the workspace. |
| `--no-recursive` | No | Send --recursive as false. |
| `--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`. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live files, `archived` for files soft-deleted by a delete, which a restore can bring back. `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`. |
Expand Down Expand Up @@ -377,7 +377,7 @@ sim files unzip <fileId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down
26 changes: 13 additions & 13 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 @@ -120,7 +120,7 @@ Delete Tag (personal API key required)

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down Expand Up @@ -150,7 +150,7 @@ Remove tag definitions no document still uses (personal API key required)
| --- | --- | --- |
| `--unused` | No | Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable. |
| `--no-unused` | No | Send --unused as false. |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down Expand Up @@ -273,7 +273,7 @@ Enable, disable, or delete many chunks at once (personal API key required)
| --- | --- | --- |
| `--operation <value>` | Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. |
| `--chunk <value...>` | Yes | Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down Expand Up @@ -334,7 +334,7 @@ Delete Chunk (personal API key required)

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down Expand Up @@ -477,7 +477,7 @@ sim knowledge documents delete <knowledgeBaseId> <documentId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down Expand Up @@ -606,8 +606,8 @@ sim knowledge documents upload <knowledgeBaseId> <path> [options]
| --- | --- | --- |
| `--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. |
| `--recipe <name>` | No | Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`. |
| `--lang <code>` | No | Document language tag: hyphen-separated letter and digit subtags, for example en or en-US. |

</CommandTable>

Expand Down Expand Up @@ -689,7 +689,7 @@ Delete Knowledge Connector (personal API key required)
| --- | --- | --- |
| `--delete-documents` | No | Also permanently delete documents produced by this connector. |
| `--no-delete-documents` | No | Send --delete-documents as false. |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

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

</CommandTable>

## List folders
## List folders; returns the whole set, so there is no --limit and no paging

```bash
sim knowledge folders list [options]
Expand Down Expand Up @@ -969,7 +969,7 @@ sim knowledge delete <knowledgeBaseId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand All @@ -985,7 +985,7 @@ sim knowledge get <knowledgeBaseId>

| Argument | Required | Description |
| --- | --- | --- |
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |
| `knowledgeBaseId` | Yes | Knowledge base to read. Active knowledge bases only: an archived one answers 404 here, is listed by `scope=archived`, and is brought back by the restore endpoint. |

</CommandTable>

Expand All @@ -1001,7 +1001,7 @@ sim knowledge list [options]

| Option | Required | Description |
| --- | --- | --- |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases a `DELETE` archived and `POST /knowledge/&#123;knowledgeBaseId&#125;/restore` can bring back. `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`. |
| `--scope <value>` | No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases archived by a delete, which a restore can bring back. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
| `--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`. |
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 @@ -21,7 +21,7 @@ sim logs get <runId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `runId` | Yes | Unique workflow run identifier. |
| `runId` | Yes | Unique workflow run identifier. A run is addressed globally by this id: unlike the list and statistics routes, this route takes no workspace. The run carries its own workspace and the caller is authorized against that one, so a run the caller cannot reach is concealed as a 404 rather than filtered out. |

</CommandTable>

Expand All @@ -35,7 +35,7 @@ sim logs get <runId> [options]

</CommandTable>

## Summarize run counts, failures, and cost over a window
## Summarize run counts, failures and latency over a window

```bash
sim logs stats [options]
Expand Down
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 <mcpServerId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this destructive operation. |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

Expand Down
Loading
Loading