You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
|`--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 @). |
25
25
|`-y, --yes`| Yes | Confirm this destructive operation. |
26
26
27
27
</CommandTable>
@@ -107,7 +107,7 @@ Also available as `sim files folders ls`.
107
107
|`--search <value>`| No | Case-insensitive substring match against the folder name. |
108
108
|`--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`. |
|`--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`. |
|`--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/{fileId}/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`. |
198
198
199
199
</CommandTable>
200
200
@@ -220,6 +220,8 @@ sim files share get <fileId>
220
220
sim files share set<fileId> [options]
221
221
```
222
222
223
+
Enable or disable sharing for a file (personal API key required)
224
+
223
225
**Arguments**
224
226
225
227
<CommandTable>
@@ -239,7 +241,7 @@ sim files share set <fileId> [options]
239
241
|`--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`. |
240
242
|`--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`. |
241
243
|`--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 @). |
243
245
244
246
</CommandTable>
245
247
@@ -258,7 +260,7 @@ sim files list [options]
258
260
|`--folder <value>`| No | Folder path as shown in the app; the leading / is optional. |
259
261
|`--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. |
260
262
|`--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`. |
262
264
|`--search <value>`| No | Case-insensitive substring match against the file name. |
263
265
|`--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`. |
@@ -280,7 +282,7 @@ Also available as `sim files mv`.
280
282
281
283
| Option | Required | Description |
282
284
| --- | --- | --- |
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 @). |
284
286
|`--to <value>`| No | Destination folder path; omit for root. |
|`--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 @). |
|`--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 @). |
258
276
|`-y, --yes`| Yes | Confirm this destructive operation. |
|`--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 @). |
422
452
|`--select-all`| No | Apply to every document in the knowledge base. |
423
453
|`--enabled-filter <value>`| No | With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`. |
424
454
@@ -505,6 +535,8 @@ sim knowledge documents list <knowledgeBaseId> [options]
|`--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 @). |
|`--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 @). |
994
1042
|`--query <value>`| No | Text to search for. |
995
1043
|`--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. |
996
1044
|`--tag-filters <json\|@file>`| No | Tag filters as [{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin). |
0 commit comments