Skip to content

Commit 2f85b5f

Browse files
committed
chore: regenerate the API reference, CLI surface, and CLI docs
The published reference still marked a secret value required and described the delete parameter as one that also creates, the CLI surface still lacked the marker that says which operations refuse a workspace key, and the reference rendered an empty sentence for every repeatable filter whose default is an empty list.
1 parent 8db2bd6 commit 2f85b5f

20 files changed

Lines changed: 324 additions & 182 deletions

apps/docs/content/docs/en/cli/audit-logs.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Every command below also accepts the [global options](/cli/commands#global-optio
1515
sim audit-logs get <auditLogId> [options]
1616
```
1717

18+
Get Audit Log (personal API key required)
19+
1820
**Arguments**
1921

2022
<CommandTable>
@@ -41,6 +43,8 @@ sim audit-logs get <auditLogId> [options]
4143
sim audit-logs list [options]
4244
```
4345

46+
List Audit Logs (personal API key required)
47+
4448
**Options**
4549

4650
<CommandTable>

apps/docs/content/docs/en/cli/billing.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Show billing status and current-period credit usage (credits and storage require
3131
sim billing logs [options]
3232
```
3333

34+
List credit usage events (a personal API key reports only your own events; a workspace API key reports every member's)
35+
3436
**Options**
3537

3638
<CommandTable>

apps/docs/content/docs/en/cli/credentials.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Every command below also accepts the [global options](/cli/commands#global-optio
1515
sim credentials delete <credentialId> [options]
1616
```
1717

18+
Disconnect Credential (personal API key required)
19+
1820
**Arguments**
1921

2022
<CommandTable>
@@ -78,6 +80,8 @@ sim credentials list [options]
7880
sim credentials update <credentialId> [options]
7981
```
8082

83+
Update Credential (personal API key required)
84+
8185
**Arguments**
8286

8387
<CommandTable>

apps/docs/content/docs/en/cli/files.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ sim files batch-delete [options]
2121

2222
| Option | Required | Description |
2323
| --- | --- | --- |
24-
| `--file-ids <value...>` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line). |
24+
| `--file-ids <value...>` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
2525
| `-y, --yes` | Yes | Confirm this destructive operation. |
2626

2727
</CommandTable>
@@ -107,7 +107,7 @@ Also available as `sim files folders ls`.
107107
| `--search <value>` | No | Case-insensitive substring match against the folder name. |
108108
| `--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`. |
109109
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
110-
| `--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 `POST /api/v2/files/folders/restore`. Authorization is identical for both. Accepted values: `active`, `archived`. |
110+
| `--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`. |
111111

112112
</CommandTable>
113113

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

195195
| Option | Required | Description |
196196
| --- | --- | --- |
197-
| `--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`. |
197+
| `--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`. |
198198

199199
</CommandTable>
200200

@@ -220,6 +220,8 @@ sim files share get <fileId>
220220
sim files share set <fileId> [options]
221221
```
222222

223+
Enable or disable sharing for a file (personal API key required)
224+
223225
**Arguments**
224226

225227
<CommandTable>
@@ -239,7 +241,7 @@ sim files share set <fileId> [options]
239241
| `--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`. |
240242
| `--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`. |
241243
| `--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. |
242-
| `--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). |
244+
| `--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; @@value for a literal leading @). |
243245

244246
</CommandTable>
245247

@@ -258,7 +260,7 @@ sim files list [options]
258260
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
259261
| `--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. |
260262
| `--no-recursive` | No | Send --recursive as false. |
261-
| `--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`. |
263+
| `--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`. |
262264
| `--search <value>` | No | Case-insensitive substring match against the file name. |
263265
| `--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`. |
264266
| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. |
@@ -280,7 +282,7 @@ Also available as `sim files mv`.
280282

281283
| Option | Required | Description |
282284
| --- | --- | --- |
283-
| `--file-ids <value...>` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line). |
285+
| `--file-ids <value...>` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
284286
| `--to <value>` | No | Destination folder path; omit for root. |
285287

286288
</CommandTable>

apps/docs/content/docs/en/cli/knowledge.mdx

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Every command below also accepts the [global options](/cli/commands#global-optio
1515
sim knowledge from-workspace-files create <knowledgeBaseId> [options]
1616
```
1717

18+
Index files the workspace already stores (personal API key required)
19+
1820
**Arguments**
1921

2022
<CommandTable>
@@ -31,7 +33,7 @@ sim knowledge from-workspace-files create <knowledgeBaseId> [options]
3133

3234
| Option | Required | Description |
3335
| --- | --- | --- |
34-
| `--file <value...>` | Yes | Workspace file ID or key (repeatable) (space-separated, or @path / @- with one value per line). |
36+
| `--file <value...>` | Yes | Workspace file ID or key (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
3537

3638
</CommandTable>
3739

@@ -41,6 +43,8 @@ sim knowledge from-workspace-files create <knowledgeBaseId> [options]
4143
sim knowledge tags save <knowledgeBaseId> [options]
4244
```
4345

46+
Declare the tag definitions a knowledge base needs (personal API key required)
47+
4448
**Arguments**
4549

4650
<CommandTable>
@@ -67,6 +71,8 @@ sim knowledge tags save <knowledgeBaseId> [options]
6771
sim knowledge tags create <knowledgeBaseId> [options]
6872
```
6973

74+
Create Tag (personal API key required)
75+
7076
**Arguments**
7177

7278
<CommandTable>
@@ -95,6 +101,8 @@ sim knowledge tags create <knowledgeBaseId> [options]
95101
sim knowledge tags delete <knowledgeBaseId> <tagId> [options]
96102
```
97103

104+
Delete Tag (personal API key required)
105+
98106
**Arguments**
99107

100108
<CommandTable>
@@ -122,6 +130,8 @@ sim knowledge tags delete <knowledgeBaseId> <tagId> [options]
122130
sim knowledge tags cleanup <knowledgeBaseId> [options]
123131
```
124132

133+
Remove tag definitions no document still uses (personal API key required)
134+
125135
**Arguments**
126136

127137
<CommandTable>
@@ -150,6 +160,8 @@ sim knowledge tags cleanup <knowledgeBaseId> [options]
150160
sim knowledge tags next-slot <knowledgeBaseId> [options]
151161
```
152162

163+
Show which tag slot a create would take for a field type (personal API key required)
164+
153165
**Arguments**
154166

155167
<CommandTable>
@@ -192,6 +204,8 @@ sim knowledge tags list <knowledgeBaseId>
192204
sim knowledge tags usage <knowledgeBaseId>
193205
```
194206

207+
Show how many documents and chunks carry each tag (personal API key required)
208+
195209
**Arguments**
196210

197211
<CommandTable>
@@ -208,6 +222,8 @@ sim knowledge tags usage <knowledgeBaseId>
208222
sim knowledge tags update <knowledgeBaseId> <tagId> [options]
209223
```
210224

225+
Update Tag (personal API key required)
226+
211227
**Arguments**
212228

213229
<CommandTable>
@@ -236,6 +252,8 @@ sim knowledge tags update <knowledgeBaseId> <tagId> [options]
236252
sim knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]
237253
```
238254

255+
Enable, disable, or delete many chunks at once (personal API key required)
256+
239257
**Arguments**
240258

241259
<CommandTable>
@@ -254,7 +272,7 @@ sim knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]
254272
| Option | Required | Description |
255273
| --- | --- | --- |
256274
| `--operation <value>` | Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. |
257-
| `--chunk <value...>` | Yes | Chunks to operate on, by identifier. Ids outside the document are ignored. (space-separated, or @path / @- with one value per line). |
275+
| `--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 @). |
258276
| `-y, --yes` | Yes | Confirm this destructive operation. |
259277

260278
</CommandTable>
@@ -265,6 +283,8 @@ sim knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]
265283
sim knowledge chunks create <knowledgeBaseId> <documentId> [options]
266284
```
267285

286+
Create Chunk (personal API key required)
287+
268288
**Arguments**
269289

270290
<CommandTable>
@@ -294,6 +314,8 @@ sim knowledge chunks create <knowledgeBaseId> <documentId> [options]
294314
sim knowledge chunks delete <knowledgeBaseId> <documentId> <chunkId> [options]
295315
```
296316

317+
Delete Chunk (personal API key required)
318+
297319
**Arguments**
298320

299321
<CommandTable>
@@ -322,6 +344,8 @@ sim knowledge chunks delete <knowledgeBaseId> <documentId> <chunkId> [options]
322344
sim knowledge chunks get <knowledgeBaseId> <documentId> <chunkId>
323345
```
324346

347+
Get Chunk (personal API key required)
348+
325349
**Arguments**
326350

327351
<CommandTable>
@@ -340,6 +364,8 @@ sim knowledge chunks get <knowledgeBaseId> <documentId> <chunkId>
340364
sim knowledge chunks list <knowledgeBaseId> <documentId> [options]
341365
```
342366

367+
List Chunks (personal API key required)
368+
343369
**Arguments**
344370

345371
<CommandTable>
@@ -371,6 +397,8 @@ sim knowledge chunks list <knowledgeBaseId> <documentId> [options]
371397
sim knowledge chunks update <knowledgeBaseId> <documentId> <chunkId> [options]
372398
```
373399

400+
Update Chunk (personal API key required)
401+
374402
**Arguments**
375403

376404
<CommandTable>
@@ -401,6 +429,8 @@ sim knowledge chunks update <knowledgeBaseId> <documentId> <chunkId> [options]
401429
sim knowledge documents batch-update <knowledgeBaseId> [options]
402430
```
403431

432+
Enable or disable every matching document (personal API key required)
433+
404434
**Arguments**
405435

406436
<CommandTable>
@@ -418,7 +448,7 @@ sim knowledge documents batch-update <knowledgeBaseId> [options]
418448
| Option | Required | Description |
419449
| --- | --- | --- |
420450
| `--operation <value>` | Yes | Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`. |
421-
| `--document <value...>` | No | Documents to update, by identifier. (space-separated, or @path / @- with one value per line). |
451+
| `--document <value...>` | No | Documents to update, by identifier. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
422452
| `--select-all` | No | Apply to every document in the knowledge base. |
423453
| `--enabled-filter <value>` | No | With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`. |
424454

@@ -505,6 +535,8 @@ sim knowledge documents list <knowledgeBaseId> [options]
505535
sim knowledge documents update <knowledgeBaseId> <documentId> [options]
506536
```
507537

538+
Update Document (personal API key required)
539+
508540
**Arguments**
509541

510542
<CommandTable>
@@ -604,6 +636,8 @@ sim knowledge create [options]
604636
sim knowledge connectors create <knowledgeBaseId> [options]
605637
```
606638

639+
Create Knowledge Connector (personal API key required)
640+
607641
**Arguments**
608642

609643
<CommandTable>
@@ -634,6 +668,8 @@ sim knowledge connectors create <knowledgeBaseId> [options]
634668
sim knowledge connectors delete <knowledgeBaseId> <connectorId> [options]
635669
```
636670

671+
Delete Knowledge Connector (personal API key required)
672+
637673
**Arguments**
638674

639675
<CommandTable>
@@ -663,6 +699,8 @@ sim knowledge connectors delete <knowledgeBaseId> <connectorId> [options]
663699
sim knowledge connectors get <knowledgeBaseId> <connectorId>
664700
```
665701

702+
Get Knowledge Connector (personal API key required)
703+
666704
**Arguments**
667705

668706
<CommandTable>
@@ -680,6 +718,8 @@ sim knowledge connectors get <knowledgeBaseId> <connectorId>
680718
sim knowledge connectors documents list <knowledgeBaseId> <connectorId> [options]
681719
```
682720

721+
List Knowledge Connector Documents (personal API key required)
722+
683723
**Arguments**
684724

685725
<CommandTable>
@@ -709,6 +749,8 @@ sim knowledge connectors documents list <knowledgeBaseId> <connectorId> [options
709749
sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [options]
710750
```
711751

752+
Update Knowledge Connector Documents (personal API key required)
753+
712754
**Arguments**
713755

714756
<CommandTable>
@@ -727,7 +769,7 @@ sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [optio
727769
| Option | Required | Description |
728770
| --- | --- | --- |
729771
| `--operation <value>` | Yes | Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`. |
730-
| `--document <value...>` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line). |
772+
| `--document <value...>` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
731773

732774
</CommandTable>
733775

@@ -737,6 +779,8 @@ sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [optio
737779
sim knowledge connectors list <knowledgeBaseId> [options]
738780
```
739781

782+
List Knowledge Connectors (personal API key required)
783+
740784
**Arguments**
741785

742786
<CommandTable>
@@ -765,6 +809,8 @@ sim knowledge connectors list <knowledgeBaseId> [options]
765809
sim knowledge connectors sync <knowledgeBaseId> <connectorId> [options]
766810
```
767811

812+
Queue a knowledge connector synchronization (personal API key required)
813+
768814
**Arguments**
769815

770816
<CommandTable>
@@ -793,6 +839,8 @@ sim knowledge connectors sync <knowledgeBaseId> <connectorId> [options]
793839
sim knowledge connectors update <knowledgeBaseId> <connectorId> [options]
794840
```
795841

842+
Update Knowledge Connector (personal API key required)
843+
796844
**Arguments**
797845

798846
<CommandTable>
@@ -990,7 +1038,7 @@ sim knowledge search [options]
9901038

9911039
| Option | Required | Description |
9921040
| --- | --- | --- |
993-
| `--kb <value...>` | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line). |
1041+
| `--kb <value...>` | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
9941042
| `--query <value>` | No | Text to search for. |
9951043
| `--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. |
9961044
| `--tag-filters <json\|@file>` | No | Tag filters as [&#123;"tagName":"...","operator":"...","value":"..."&#125;] (JSON, or @path / @- to read a file or stdin). |

0 commit comments

Comments
 (0)