Files
sim files is also spelled sim file.
Every command below also accepts the global options.
Delete several files at once
sim files batch-delete [options]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. |
Create file
sim files create [options]Options
| 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. |
Create a file folder at a path
sim files folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Delete folder
sim files folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
List folders
sim files folders list [options]Also available as sim files folders ls.
Options
| 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. |
Rename or move a file folder
sim files folders move <path> <destination>Also available as sim files folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
Delete file
sim files delete <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
Show file metadata and sharing status
sim files describe <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
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 POST /files/{fileId}/restore. Authorization is identical for both. Accepted values: active, archived. |
Show a file’s share settings
sim files share get <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Enable or disable sharing for a file
sim files share set <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| 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). |
List files
sim files list [options]Options
| 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. |
Move files into another folder
sim files move [options]Also available as sim files mv.
Options
| 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. |
Rename a file
sim files rename <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | New file name, including its extension. |
Restore file
sim files restore create <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Replace a file’s contents
sim files set-content <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| 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. |
Upload a file to the workspace
sim files upload <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Local file to upload |
Options
| Option | Required | Description |
|---|---|---|
--folder <path> | No | Destination folder path (defaults to /). |
--name <name> | No | Store it under a different name. |
Get a file’s content
sim files get <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File whose content to read |
Options
| 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. |
List file resources and child folders together
sim files ls [path] [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | No | Folder path to list; defaults to the root folder |
Options
| 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. |
Create a file directory at a path
sim files mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |