# Complete reference (/cli/reference) Every command on one page, generated from the CLI itself. Start at the [overview](/cli/commands) to browse; this page is for searching and for tools. Append `.mdx` to any page for its raw Markdown — [`/cli/reference.mdx`](/cli/reference.mdx) is this page as plain text. The docs are also published as [`/llms.txt`](/llms.txt) and [`/llms-full.txt`](/llms-full.txt). ## Global options [#global-options] These apply to every command, and may be written before or after it. | Option | Description | | ---------------------- | --------------------------------------------------------------------------------- | | `-P, --profile ` | Profile to use (env: STUDIO\_PROFILE). | | `--endpoint ` | Studio deployment to talk to (env: STUDIO\_ENDPOINT). | | `-w, --workspace ` | Workspace to target (env: STUDIO\_WORKSPACE). | | `--output ` | Output format for this command. Accepted values: `table`, `json`, `yaml`, `text`. | ## studio login [#studio-login] Sign in through the browser and store the login for the profile ```bash studio login [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--method ` | No | Credential to obtain: oauth requires OAuth support; api-key creates a permanent key through pairing (auto-selects when omitted). Accepted values: `oauth`, `api-key`. | | `--no-browser` | No | Print the approval URL without opening it (either login method). | | `--read-only` | No | Ask only for permission to read, never to change anything. | | `--callback-port ` | No | Pin the local port the browser returns to. | | `-y, --yes` | No | Overwrite an existing API-key profile without prompting. | ## studio logout [#studio-logout] Sign out and remove the profile's stored login ```bash studio logout [options] ``` **Options** | Option | Required | Description | | ------- | -------- | ---------------------------------------------------- | | `--all` | No | Remove the profile entirely, including its settings. | ## studio whoami [#studio-whoami] Show the resolved profile, where each setting came from, and whether it works ```bash studio whoami [options] ``` **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------------------------- | | `--no-verify` | No | Skip the API check and only print the resolved settings. | ## studio configure [#studio-configure] Set a profile's endpoint, default workspace, or output format ```bash studio configure [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------ | | `--set-endpoint ` | No | Studio deployment to talk to. | | `--set-workspace ` | No | Default workspace for workspace-scoped commands. | | `--set-output ` | No | Default output format (table \| json \| yaml \| text). | | `--unset ` | No | Remove settings (endpoint, workspace, output). | ## studio update [#studio-update] Update this global CLI installation to the newest release on its channel ```bash studio update [options] ``` **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------- | | `--package-manager ` | No | Package manager that installed this copy. Accepted values: `npm`, `pnpm`, `bun`, `yarn`. | ## studio chat [#studio-chat] Ask Studio and print the reply ```bash studio chat [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------ | | `message` | Yes | What to ask Studio | **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------- | | `-c, --conversation ` | No | Continue the conversation with this ID. | ## studio profiles [#studio-profiles] Also spelled `studio profile`. ### studio profiles list [#studio-profiles-list] List configured profiles ```bash studio profiles list ``` ### studio profiles add [#studio-profiles-add] Add a workspace profile that shares the active stored login ```bash studio profiles add [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------ | | `name` | Yes | Name for the new profile | **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------- | | `-w, --workspace ` | No | Existing workspace to use; omit for an interactive picker. | ## studio telemetry [#studio-telemetry] ### studio telemetry status [#studio-telemetry-status] Show whether usage reporting is on, and why not if it is off ```bash studio telemetry status ``` ### studio telemetry enable [#studio-telemetry-enable] Turn usage reporting on for this machine ```bash studio telemetry enable ``` ### studio telemetry disable [#studio-telemetry-disable] Turn usage reporting off for this machine ```bash studio telemetry disable ``` ## studio audit-logs [#studio-audit-logs] Also spelled `studio audit-log`. ### studio audit-logs get [#studio-audit-logs-get] Get Audit Log (OAuth login or personal API key required) ```bash studio audit-logs get [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `auditLogId` | Yes | Audit-log entry identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | No | Organization ID; defaults to your only organization, and is required when your account belongs to more than one (OAuth login or personal API key required). | ### studio audit-logs list [#studio-audit-logs-list] List Audit Logs (OAuth login or personal API key required) ```bash studio audit-logs list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--action ` | No | Filter by exact action name. | | `--resource-type ` | No | Filter by resource type. Accepts a comma-separated set; members are trimmed and deduplicated, and member order affects neither the result nor the cursor. | | `--resource-id ` | No | Filter by exact resource identifier. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--include-departed` | No | Include actions by users who have left the organization. | | `--no-include-departed` | No | Send --include-departed as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--organization ` | No | Organization ID; defaults to your only organization, and is required when your account belongs to more than one (OAuth login or personal API key required). | | `--actor-email ` | No | Filter by actor email address. | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ## studio billing [#studio-billing] ### studio billing status [#studio-billing-status] Show billing status and current-period credit usage (credits and storage require an OAuth login or personal API key) ```bash studio billing status [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------- | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ### studio billing logs [#studio-billing-logs] List credit usage events (an OAuth login or personal API key reports only your events; a workspace API key reports every member's in aggregate, unattributed) ```bash studio billing logs [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--source ` | No | Filter by usage source; studio-chat combines Copilot and workspace chat. Accepted values: `workflow`, `wand`, `studio-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`. | | `--period ` | No | Billing period. Accepted values: `1d`, `7d`, `30d`, `all`, `custom`. | | `--start-date ` | No | Custom period start (ISO 8601). | | `--end-date ` | No | Custom period end (ISO 8601). | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ## studio blocks [#studio-blocks] ### studio blocks get [#studio-blocks-get] Get Block ```bash studio blocks get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------ | | `blockId` | Yes | Block type identifier. An unversioned base type resolves to the newest version, and the response echoes the resolved id. | ### studio blocks list [#studio-blocks-list] List Blocks ```bash studio blocks list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the block id, name, and description. | | `--category ` | No | Restrict to one toolbar category. Accepted values: `blocks`, `tools`, `triggers`. | | `--capability ` | No | Restrict to blocks that can start a workflow — the `triggers` category, blocks declaring `triggerAllowed`, and blocks with trigger-mode fields. Accepted values: `trigger`. | | `--source ` | No | Restrict to built-in blocks or this workspace's deployed custom blocks. Accepted values: `builtin`, `custom`. | | `--sort-by ` | 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: `id`, `name`, `category`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## studio chat-deployments [#studio-chat-deployments] ### studio chat-deployments list [#studio-chat-deployments-list] List Chat Deployments ```bash studio chat-deployments list [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------- | | `--workflow-id ` | No | Restrict to deployments of one workflow. | | `--is-active` | No | Restrict to active or inactive deployments. | | `--no-is-active` | No | Send --is-active as false. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `identifier`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## studio connector-types [#studio-connector-types] ### studio connector-types list [#studio-connector-types-list] List Connector Types ```bash studio connector-types list [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------ | | `--search ` | No | Case-insensitive substring match against the connector name. | ## studio credentials [#studio-credentials] Also spelled `studio credential`. ### studio credentials delete [#studio-credentials-delete] Disconnect Credential (OAuth login or personal API key required) ```bash studio credentials delete [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------- | | `credentialId` | Yes | Credential to disconnect. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio credentials providers list [#studio-credentials-providers-list] List Credential Providers ```bash studio credentials providers list [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ---------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the credential provider name. | ### studio credentials list [#studio-credentials-list] List Credentials ```bash studio credentials list [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------- | | `--type ` | No | Restrict results to this credential type. Accepted values: `oauth`, `service_account`. | | `--provider-id ` | No | Restrict results to credentials for this integration provider. | | `--search ` | No | Case-insensitive substring match against the credential display name. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `displayName`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio credentials update [#studio-credentials-update] Update Credential (OAuth login or personal API key required) ```bash studio credentials update [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | --------------------- | | `credentialId` | Yes | Credential to update. | **Options** | Option | Required | Description | | -------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `--display-name ` | No | New name shown for the credential in Studio. | | `--description ` | No | New credential description. Send null to clear the stored one. (--description null sends the word, not JSON null). | | `--service-account-json ` | No | Write-only Google service-account JSON key. | | `--api-token ` | No | Write-only provider API token. | | `--domain ` | No | Provider account domain. | | `--atlassian-product ` | No | Atlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: `jira`, `confluence`. | | `--signing-secret ` | No | Write-only webhook signing secret. | | `--bot-token ` | No | Write-only bot token. | | `--client-id ` | No | OAuth client identifier. | | `--client-secret ` | No | Write-only OAuth client secret. | | `--certificate-id ` | No | Provider certificate mapping identifier. | | `--org-id ` | No | Provider organization ID. | | `--data-center ` | No | Provider data center. | | `--auth-method ` | No | Provider authentication method. | | `--private-key ` | No | Write-only PEM private key. | | `--username ` | No | Provider run-as username. | | `--name ` | No | Alias for --display-name. | ### studio credentials create [#studio-credentials-create] Create a service-account credential using its discovered provider schema (OAuth login or personal API key required) ```bash studio credentials create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------------------------------- | | `providerId` | Yes | Service-account provider to create a credential for | **Options** | Option | Required | Description | | ----------------------------- | -------- | --------------------------------------------------------------------- | | `--name ` | Yes | Name shown for the credential in Studio. | | `--credentials ` | Yes | Provider credentials as JSON (or @path / @- to read a file or stdin). | | `--description ` | No | Optional credential description. | | `--id ` | No | Client-generated credential ID when provider discovery requires it. | ### studio credentials connect [#studio-credentials-connect] Create a short-lived link for connecting an OAuth provider (OAuth login or personal API key required) ```bash studio credentials connect [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------- | | `providerId` | Yes | OAuth provider to connect | **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------- | | `--name ` | Yes | Name shown for the new credential in Studio. | ### studio credentials reconnect [#studio-credentials-reconnect] Create a short-lived link for reconnecting an OAuth credential (OAuth login or personal API key required) ```bash studio credentials reconnect ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ----------------------------------------- | | `credentialId` | Yes | Existing OAuth credential to re-authorize | ## studio custom-tools [#studio-custom-tools] Also spelled `studio custom-tool`. ### studio custom-tools create [#studio-custom-tools-create] Create Custom Tool ```bash studio custom-tools create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--title ` | Yes | Display title, unique within the workspace. | | `--schema ` | Yes | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). | | `--code ` | Yes | Tool implementation executed in the sandboxed function runtime. | ### studio custom-tools delete [#studio-custom-tools-delete] Delete Custom Tool ```bash studio custom-tools delete [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio custom-tools get [#studio-custom-tools-get] Get Custom Tool ```bash studio custom-tools get ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | ### studio custom-tools list [#studio-custom-tools-list] List Custom Tools ```bash studio custom-tools list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the tool title. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `title`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio custom-tools update [#studio-custom-tools-update] Update Custom Tool ```bash studio custom-tools update [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--title ` | No | New display title for the tool. | | `--schema ` | No | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). | | `--code ` | No | Replacement tool implementation. | ## studio files [#studio-files] Also spelled `studio file`. ### studio files batch-delete [#studio-files-batch-delete] Delete several files at once ```bash studio files batch-delete [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | `--file-ids ` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### studio files create [#studio-files-create] Create File ```bash studio files create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | File name, including its extension. Path separators and dot segments are rejected. | | `--content-type ` | No | MIME type. When omitted, it is inferred from the file extension. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--content ` | 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 ` | No | Encoding of the content field. Accepted values: `utf-8`, `base64`. | ### studio files folders create [#studio-files-folders-create] Create a file folder at a path ```bash studio files folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio files folders delete [#studio-files-folders-delete] Delete Folder ```bash studio files folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### studio files folders list [#studio-files-folders-list] List folders ```bash studio files folders list [options] ``` Also available as `studio files folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--scope ` | 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`. | | `--recursive ` | No | Whether parentPath includes every descendant instead of direct children only. Accepted values: `true`, `1`, `yes`, `on`, `y`, `enabled`, `false`, `0`, `no`, `off`, `n`, `disabled`. | | `--depth ` | No | Deepest level below parentPath to include when recursive is true. | ### studio files folders move [#studio-files-folders-move] Rename or move a file folder ```bash studio files folders move ``` Also available as `studio files folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `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 | ### studio files folders restore [#studio-files-folders-restore] Restore an archived file folder ```bash studio files folders restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio files delete [#studio-files-delete] Delete File ```bash studio files delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio files edit [#studio-files-edit] Apply one exact or anchor-based edit to a text file ```bash studio files edit [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--edit ` | Yes | One edit object: \{"mode":"search\_replace","search":"old","content":"new","replaceAll":false}, \{"mode":"replace\_between","beforeAnchor":"start line","afterAnchor":"end line","content":"new"}, \{"mode":"insert\_after","anchor":"line","content":"new"}, or \{"mode":"delete\_between","startAnchor":"first line deleted","endAnchor":"ending line kept"}. Anchored modes also accept occurrence starting at 1 (JSON, or @path / @- to read a file or stdin). | ### studio files describe [#studio-files-describe] Show file metadata and sharing status ```bash studio files describe [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--scope ` | 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`. | ### studio files share get [#studio-files-share-get] Show a file’s share settings ```bash studio files share get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | ### studio files share set [#studio-files-share-set] Enable or disable sharing for a file (OAuth login or personal API key required) ```bash studio files share set [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--is-active ` | 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 ` | 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 ` | 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 ` | 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 @). | ### studio files list [#studio-files-list] List Files ```bash studio files list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--recursive` | No | Include subfolders in the folder filter. Defaults to true when searching and false otherwise. Ignored without a folder filter. | | `--no-recursive` | No | Send --recursive as false. | | `--scope ` | 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 ` | No | Case-insensitive substring match against the file name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio files move [#studio-files-move] Move files into another folder ```bash studio files move [options] ``` Also available as `studio files mv`. **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | `--file-ids ` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | No | Destination folder path; omit for root. | ### studio files read [#studio-files-read] Read a file’s text content ```bash studio files read [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | --------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--max-bytes ` | No | Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit. | | `--offset ` | No | First line to return, 1-based. Absent starts at the first line. | | `--limit ` | No | How many lines to return from `offset`. Absent reads to the end. | ### studio files rename [#studio-files-rename] Rename a file ```bash studio files rename [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ---------------- | -------- | --------------------------------------- | | `--name ` | Yes | New file name, including its extension. | ### studio files restore [#studio-files-restore] Restore an archived file ```bash studio files restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | ### studio files search [#studio-files-search] Search File Content ```bash studio files search [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--query ` | Yes | Regular expression, or exact text when `mode` is `exact`. | | `--mode ` | No | How `query` is read. Accepted values: `exact`, `regex`. | | `--max-results ` | No | Maximum matching lines to return. | | `--folder ` | No | Folders to search, by path as shown in the app; omit to search the whole workspace (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-subfolders` | No | Whether each folder scope includes nested folders; on by default. | | `--no-include-subfolders` | No | Send --include-subfolders as false. | ### studio files unzip [#studio-files-unzip] Unzip an archive into a new folder beside it ```bash studio files unzip [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio files set-content [#studio-files-set-content] Replace a file’s contents ```bash studio files set-content [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--content ` | 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 ` | No | Content encoding. Accepted values: `utf-8`, `base64`. | ### studio files upload [#studio-files-upload] Upload a file to the workspace ```bash studio files upload [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------- | | `path` | Yes | Local file to upload | **Options** | Option | Required | Description | | ----------------- | -------- | ------------------------------------------------------------- | | `--folder ` | No | Folder path as shown in the app; defaults to the root folder. | | `--name ` | No | Store it under a different name. | ### studio files get [#studio-files-get] Get a file’s content ```bash studio files get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------------- | | `fileId` | Yes | File whose content to read | **Options** | Option | Required | Description | | -------------------------- | -------- | --------------------------------------------- | | `-o, --output-file ` | No | Write content to a file instead of stdout. | | `--force` | No | Overwrite --output-file if it already exists. | ### studio files ls [#studio-files-ls] List file resources and child folders together ```bash studio files ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### studio files mkdir [#studio-files-mkdir] Create a file directory at a path ```bash studio files mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## studio knowledge [#studio-knowledge] Also spelled `studio kb`. ### studio knowledge from-workspace-files create [#studio-knowledge-from-workspace-files-create] Index files the workspace already stores (OAuth login or personal API key required) ```bash studio knowledge from-workspace-files create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | | `--file ` | Yes | Workspace file ID or key (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### studio knowledge tags save [#studio-knowledge-tags-save] Declare the tag definitions a knowledge base needs (OAuth login or personal API key required) ```bash studio knowledge tags save [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `--definitions ` | Yes | Tag definitions: \[\{"tagSlot":"tag1","displayName":"category","fieldType":"text"}] (JSON, or @path / @- to read a file or stdin). | ### studio knowledge tags create [#studio-knowledge-tags-create] Create Tag (OAuth login or personal API key required) ```bash studio knowledge tags create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--display-name ` | Yes | Name tag filters and document reads use for this tag. | | `--field-type ` | No | Value type stored in the slot; it decides which slots are usable and which filter operators apply. Defaults to text, so a number, date, or boolean slot must name its type here. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`. | | `--tag-slot ` | No | Slot to store the tag in. Omit to take the next free slot for the field type; a slot that does not belong to the field type, or one already in use, is rejected. Accepted values: `tag1`, `tag2`, `tag3`, `tag4`, `tag5`, `tag6`, `tag7`, `number1`, `number2`, `number3`, `number4`, `number5`, `date1`, `date2`, `boolean1`, `boolean2`, `boolean3`. | ### studio knowledge tags delete [#studio-knowledge-tags-delete] Delete Tag (OAuth login or personal API key required) ```bash studio knowledge tags delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `tagId` | Yes | Unique tag definition identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio knowledge tags cleanup [#studio-knowledge-tags-cleanup] Remove tag definitions no document still uses (OAuth login or personal API key required) ```bash studio knowledge tags cleanup [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--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 operation. | ### studio knowledge tags next-slot [#studio-knowledge-tags-next-slot] Show which tag slot a create would take for a field type (OAuth login or personal API key required) ```bash studio knowledge tags next-slot [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--field-type ` | Yes | Value type stored in the slot; it decides which slots are usable and which filter operators apply. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`. | ### studio knowledge tags list [#studio-knowledge-tags-list] List Tags ```bash studio knowledge tags list ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### studio knowledge tags usage [#studio-knowledge-tags-usage] Show how many documents and chunks carry each tag (OAuth login or personal API key required) ```bash studio knowledge tags usage ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### studio knowledge tags update [#studio-knowledge-tags-update] Update Tag (OAuth login or personal API key required) ```bash studio knowledge tags update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `tagId` | Yes | Unique tag definition identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------- | | `--display-name ` | No | New tag display name. | | `--field-type ` | No | New value type for the tag. Accepted values: `text`, `number`, `date`, `boolean`. | ### studio knowledge chunks batch-update [#studio-knowledge-chunks-batch-update] Enable, disable, or delete many chunks at once (OAuth login or personal API key required) ```bash studio knowledge chunks batch-update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--operation ` | Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. | | `--chunk ` | 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 operation. | ### studio knowledge chunks create [#studio-knowledge-chunks-create] Create Chunk (OAuth login or personal API key required) ```bash studio knowledge chunks create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | ------------------------------------------------------------------------------- | | `--content ` | Yes | Text to embed. It is embedded on write, so the chunk is searchable immediately. | | `--enabled` | No | Whether the new chunk participates in search. | | `--no-enabled` | No | Send --enabled as false. | ### studio knowledge chunks delete [#studio-knowledge-chunks-delete] Delete Chunk (OAuth login or personal API key required) ```bash studio knowledge chunks delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio knowledge chunks get [#studio-knowledge-chunks-get] Get Chunk (OAuth login or personal API key required) ```bash studio knowledge chunks get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | ### studio knowledge chunks list [#studio-knowledge-chunks-list] List Chunks (OAuth login or personal API key required) ```bash studio knowledge chunks list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against chunk content. | | `--enabled ` | No | Restrict to enabled or disabled chunks. `all` returns both. Accepted values: `true`, `false`, `all`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `chunkIndex`, `tokenCount`, `enabled`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### studio knowledge chunks update [#studio-knowledge-chunks-update] Update Chunk (OAuth login or personal API key required) ```bash studio knowledge chunks update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | ------------------------------------------------------------------------------------------------ | | `--content ` | No | Replacement text. Changing it re-embeds the chunk and re-derives its token and character counts. | | `--enabled` | No | Whether the chunk participates in search. Disabling keeps it indexed. | | `--no-enabled` | No | Send --enabled as false. | ### studio knowledge documents batch-update [#studio-knowledge-documents-batch-update] Enable or disable every matching document (OAuth login or personal API key required) ```bash studio knowledge documents batch-update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | `--operation ` | Yes | Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`. | | `--document ` | No | Documents to update, by identifier. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--select-all` | No | Apply to every document in the knowledge base. | | `--enabled-filter ` | No | With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`. | ### studio knowledge documents delete [#studio-knowledge-documents-delete] Delete Document ```bash studio knowledge documents delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio knowledge documents get [#studio-knowledge-documents-get] Get Document ```bash studio knowledge documents get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | ### studio knowledge documents list [#studio-knowledge-documents-list] List Documents ```bash studio knowledge documents list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--search ` | No | Case-insensitive substring match against the document filename. | | `--enabled-filter ` | No | Filter by whether documents are enabled for search. Accepted values: `all`, `enabled`, `disabled`. | | `--sort-by ` | No | Field used to sort the result. Sorting by `filename` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--tag-filters ` | No | A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[{"tagName":"category","operator":"eq","value":"billing"}]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored. | ### studio knowledge documents update [#studio-knowledge-documents-update] Update Document (OAuth login or personal API key required) ```bash studio knowledge documents update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filename ` | No | New filename for the document. | | `--enabled` | No | Whether the document participates in search. Disabling keeps it indexed. | | `--no-enabled` | No | Send --enabled as false. | | `--tag1 ` | No | New value for tag slot 1. | | `--tag2 ` | No | New value for tag slot 2. | | `--tag3 ` | No | New value for tag slot 3. | | `--tag4 ` | No | New value for tag slot 4. | | `--tag5 ` | No | New value for tag slot 5. | | `--tag6 ` | No | New value for tag slot 6. | | `--tag7 ` | No | New value for tag slot 7. | | `--number1 ` | No | New value for number tag slot 1. | | `--number2 ` | No | New value for number tag slot 2. | | `--number3 ` | No | New value for number tag slot 3. | | `--number4 ` | No | New value for number tag slot 4. | | `--number5 ` | No | New value for number tag slot 5. | | `--date1 ` | No | New value for date tag slot 1, formatted YYYY-MM-DD. | | `--date2 ` | No | New value for date tag slot 2, formatted YYYY-MM-DD. | | `--boolean1` | No | New value for boolean tag slot 1. | | `--no-boolean1` | No | Send --boolean1 as false. | | `--boolean2` | No | New value for boolean tag slot 2. | | `--no-boolean2` | No | Send --boolean2 as false. | | `--boolean3` | No | New value for boolean tag slot 3. | | `--no-boolean3` | No | Send --boolean3 as false. | | `--retry-processing` | No | Requeue a failed or stuck document for processing. Send it alone — no other field may accompany it — and it answers with a queue acknowledgement rather than the document. | ### studio knowledge documents upload [#studio-knowledge-documents-upload] Upload a document to a knowledge base ```bash studio knowledge documents upload [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ----------------------------- | | `knowledgeBaseId` | Yes | Knowledge base to upload into | | `path` | Yes | Local file to upload | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------------ | | `--name ` | No | Store it under a different name. | | `--tag ` | No | Document tags, in tag1 through tag7 order. | | `--recipe ` | No | Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`. | | `--lang ` | No | Document language tag: hyphen-separated letter and digit subtags, for example en or en-US. | ### studio knowledge create [#studio-knowledge-create] Create Knowledge Base ```bash studio knowledge create [options] ``` **Options** | Option | Required | Description | | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Human-readable knowledge base name. | | `--description ` | No | Optional knowledge base description. | | `--chunking-config ` | No | Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio knowledge connectors create [#studio-knowledge-connectors-create] Create Knowledge Connector (OAuth login or personal API key required) ```bash studio knowledge connectors create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | `--connector-type ` | Yes | Registered connector type. | | `--credential-id ` | No | OAuth credential identifier for connectors that require OAuth. | | `--api-key ` | No | Write-only API key for connectors that use API-key authentication. | | `--source-config ` | Yes | Connector-specific source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin). | | `--sync-interval-minutes ` | No | Scheduled synchronization interval in minutes; zero disables scheduling. | ### studio knowledge connectors delete [#studio-knowledge-connectors-delete] Delete Knowledge Connector (OAuth login or personal API key required) ```bash studio knowledge connectors delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------- | | `--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 operation. | ### studio knowledge connectors get [#studio-knowledge-connectors-get] Get Knowledge Connector (OAuth login or personal API key required) ```bash studio knowledge connectors get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | ### studio knowledge connectors documents list [#studio-knowledge-connectors-documents-list] List Knowledge Connector Documents (OAuth login or personal API key required) ```bash studio knowledge connectors documents list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | -------------------------------------------------------------- | | `--include-excluded` | No | Include documents explicitly excluded by a user. | | `--no-include-excluded` | No | Send --include-excluded as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### studio knowledge connectors documents update [#studio-knowledge-connectors-documents-update] Update Knowledge Connector Documents (OAuth login or personal API key required) ```bash studio knowledge connectors documents update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `--operation ` | Yes | Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`. | | `--document ` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### studio knowledge connectors list [#studio-knowledge-connectors-list] List Knowledge Connectors (OAuth login or personal API key required) ```bash studio knowledge connectors list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------ | | `--sort-by ` | No | Field used to sort the result. Accepted values: `connectorType`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio knowledge connectors sync [#studio-knowledge-connectors-sync] Queue a knowledge connector synchronization (OAuth login or personal API key required) ```bash studio knowledge connectors sync [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ---------------- | -------- | -------------------------------------------------------- | | `--rehydrate` | No | Re-fetch and re-index every existing connector document. | | `--no-rehydrate` | No | Send --rehydrate as false. | ### studio knowledge connectors update [#studio-knowledge-connectors-update] Update Knowledge Connector (OAuth login or personal API key required) ```bash studio knowledge connectors update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | --------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--source-config ` | No | Replacement source selection and filtering configuration. Updating a runnable connector queues synchronization; paused connectors remain paused. (JSON, or @path / @- to read a file or stdin). | | `--sync-interval-minutes ` | No | New scheduled synchronization interval in minutes. | | `--status ` | No | New connector state. Accepted values: `active`, `paused`. | ### studio knowledge folders create [#studio-knowledge-folders-create] Create a knowledge folder at a path ```bash studio knowledge folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio knowledge folders delete [#studio-knowledge-folders-delete] Delete Folder ```bash studio knowledge folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### studio knowledge folders list [#studio-knowledge-folders-list] List knowledge folders ```bash studio knowledge folders list [options] ``` Also available as `studio knowledge folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### studio knowledge folders move [#studio-knowledge-folders-move] Rename or move a knowledge folder ```bash studio knowledge folders move ``` Also available as `studio knowledge folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `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 | ### studio knowledge delete [#studio-knowledge-delete] Delete Knowledge Base ```bash studio knowledge delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio knowledge get [#studio-knowledge-get] Get Knowledge Base ```bash studio knowledge get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### studio knowledge list [#studio-knowledge-list] List Knowledge Bases ```bash studio knowledge list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Lifecycle scope: active or archived knowledge bases. Use Restore Knowledge Base to recover archived entries. Folder paths resolve only active folders, so filtering by an archived folder returns no matches. Accepted values: `active`, `archived`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio knowledge restore [#studio-knowledge-restore] Restore an archived knowledge base ```bash studio knowledge restore ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### studio knowledge search [#studio-knowledge-search] Search Knowledge ```bash studio knowledge search [options] ``` **Options** | Option | Required | Description | | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--kb ` | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--query ` | No | Text to search for. | | `--top-k ` | No | Maximum number of search results to return. Must be a whole number between 1 and 100. | | `--tag-filters ` | No | Tag filters as \[\{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin). | | `--search-mode ` | No | Search algorithm. Accepted values: `vector`, `hybrid`. | | `--reranker-enabled` | No | Re-order retrieved chunks with a reranking model before truncating to `topK`. Ignored for a tag-only search, and billed as an additional search unit. Reranking is best-effort — a provider failure falls back to vector ordering, so check `rerankerStatus` on the response. | | `--no-reranker-enabled` | No | Send --reranker-enabled as false. | | `--reranker-model ` | No | Reranking model to use when `rerankerEnabled` is true. Defaults to `rerank-v4.0-fast`. Accepted values: `rerank-v4.0-pro`, `rerank-v4.0-fast`, `rerank-v3.5`. | | `--reranker-input-count ` | No | How many candidate chunks to retrieve before reranking. Defaults to four times `topK`, capped at 100. A larger pool costs more retrieval work but gives the reranker more to choose from. | ### studio knowledge update [#studio-knowledge-update] Update Knowledge Base ```bash studio knowledge update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | --------------------------------- | -------- | ----------------------------------------------------------------------------------- | | `--name ` | No | New knowledge base name. | | `--description ` | No | New knowledge base description. | | `--chunking-config ` | No | New document chunking configuration. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio knowledge mv [#studio-knowledge-mv] Move a knowledge base to a folder ```bash studio knowledge mv ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ---------------------------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### studio knowledge export [#studio-knowledge-export] Export a knowledge base as a .simkb.zip bundle ```bash studio knowledge export [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------ | | `knowledgeBaseId` | Yes | Knowledge base to export | **Options** | Option | Required | Description | | -------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `-o, --output-file ` | No | Write the bundle to this path instead of the name the server suggests; pass - to stream it to stdout. | | `--force` | No | Overwrite --output-file if it already exists. | | `--no-vectors` | No | Leave chunk vectors out of the bundle, so an import re-embeds every chunk. | ### studio knowledge ls [#studio-knowledge-ls] List knowledge resources and child folders together ```bash studio knowledge ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### studio knowledge mkdir [#studio-knowledge-mkdir] Create a knowledge directory at a path ```bash studio knowledge mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## studio logs [#studio-logs] Also spelled `studio log`. ### studio logs get [#studio-logs-get] Show run diagnostics ```bash studio logs get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | --------- | -------- | ------------------------------------------------------------------------- | | `--trace` | No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. | ### studio logs stats [#studio-logs-stats] Summarize run counts, failures and latency over a window ```bash studio logs stats [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | No | Comma-separated workflow identifiers to include. At most 200 entries. An empty entry is rejected. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--trigger ` | No | Comma-separated trigger types to include. An empty entry is rejected. The vocabulary is open, so an unrecognized member selects no runs; the literal `all` disables this filter. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--level ` | No | Severity level to include. Accepted values: `info`, `error`. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--segment-count ` | No | Number of time buckets, up to 500. Exactly this many are returned, each at least one minute wide. Short windows extend past the requested end and include empty trailing buckets. | ### studio logs list [#studio-logs-list] List Logs ```bash studio logs list [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | No | Comma-separated workflow identifiers to include. An empty entry is rejected. At most 200 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--trigger ` | No | Comma-separated, lowercase trigger types or webhook provider IDs. Matching is exact and case-sensitive; unknown values select no runs. An empty entry is rejected. The sentinel `all` disables this filter, even when listed with other values. At most 100 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--level ` | No | Severity level to include. Accepted values: `info`, `error`. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--min-duration-ms ` | No | Minimum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected. | | `--max-duration-ms ` | No | Maximum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected. | | `--min-cost ` | 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 ` | 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 ` | No | AI model used during execution. | | `--details ` | 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 ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--status ` | No | Comma-separated execution statuses to include, from `pending` \| `running` \| `paused` \| `redacting` \| `completed` \| `failed` \| `cancelled`. An empty entry is rejected. ANDed with `level`, which reports severity rather than lifecycle. | | `--workflow-name ` | No | Case-insensitive substring match against the run's workflow name. Runs whose workflow has been deleted match nothing, because the name is no longer joinable. | | `--include-job-runs` | No | Include Chat and Studio-agent jobs alongside workflow runs. Jobs use `kind: "job"` and have no workflow or cost ledger. Workflow, folder, model, or status filters exclude jobs. This option is valid only when sorting by `startedAt`. | | `--no-include-job-runs` | No | Send --include-job-runs as false. | | `--run-id ` | No | Exact run identifier to match. | | `--sort-by ` | No | Field used to sort the result. `durationMs` and `cost` are null until a run settles; those runs sort before recorded values in ascending order and after them in descending order. Only `startedAt` can order Chat and Studio-agent job runs, so any other value is rejected when job runs are included. Accepted values: `startedAt`, `durationMs`, `cost`, `status`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### studio logs follow [#studio-logs-follow] Watch runs as they arrive, printing each new run once ```bash studio logs follow [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ | | `--workflow ` | No | Only follow runs of this workflow (repeatable). | | `--folder ` | No | Only follow runs of workflows in this folder (repeatable). | | `--trigger ` | No | Only follow runs with this trigger type (repeatable). | | `--level ` | No | Only follow runs at this severity. Accepted values: `info`, `error`. | | `--details ` | No | Response detail level; full names each run’s workflow. Accepted values: `basic`, `full`. Defaults to `full`. | | `-n, --lines ` | No | Recent runs to print before watching. Defaults to `10`. | | `--interval ` | No | Seconds between polls. Defaults to `3`. | ## studio mcp-servers [#studio-mcp-servers] Also spelled `studio mcp-server`. ### studio mcp-servers create [#studio-mcp-servers-create] Create MCP Server ```bash studio mcp-servers create [options] ``` **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Server display name. | | `--description ` | No | Optional server description. | | `--transport ` | No | Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`. | | `--url ` | Yes | Absolute HTTP or HTTPS endpoint URL without `{{ENV_VAR}}` references. It determines server identity and is immutable: delete and recreate the server to change endpoints. | | `--auth-type ` | No | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. | | `--headers ` | No | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin). | | `--timeout ` | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. | | `--retries ` | No | Number of retries per request. Defaults to 3 on creation. | | `--enabled` | No | Whether workflows can use the server's tools. Defaults to true on creation. | | `--no-enabled` | No | Send --enabled as false. | | `--oauth-client-id ` | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. | | `--oauth-client-secret ` | No | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null). | ### studio mcp-servers delete [#studio-mcp-servers-delete] Delete MCP Server ```bash studio mcp-servers delete [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio mcp-servers get [#studio-mcp-servers-get] Get MCP Server ```bash studio mcp-servers get ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | ### studio mcp-servers list [#studio-mcp-servers-list] List MCP Servers ```bash studio mcp-servers list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the server name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio mcp-servers tools list [#studio-mcp-servers-tools-list] List MCP Server Tools (OAuth login or personal API key required) ```bash studio mcp-servers tools list [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `--refresh` | No | Refresh tools using your credentials. Otherwise results may reuse another workspace member's recent discovery and omit newly added tools. | | `--no-refresh` | No | Send --refresh as false. | ### studio mcp-servers update [#studio-mcp-servers-update] Update MCP Server ```bash studio mcp-servers update [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Server display name. | | `--description ` | No | Optional server description. | | `--transport ` | No | Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`. | | `--url ` | No | Immutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints. | | `--auth-type ` | No | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. | | `--headers ` | No | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin). | | `--timeout ` | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. | | `--retries ` | No | Number of retries per request. Defaults to 3 on creation. | | `--enabled` | No | Whether workflows can use the server's tools. Defaults to true on creation. | | `--no-enabled` | No | Send --enabled as false. | | `--oauth-client-id ` | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. | | `--oauth-client-secret ` | No | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null). | ## studio meta [#studio-meta] ### studio meta status [#studio-meta-status] Show what this API supports and which limits apply ```bash studio meta status ``` ## studio sandboxes [#studio-sandboxes] Also spelled `studio sandbox`. ### studio sandboxes create [#studio-sandboxes-create] Create Sandbox (OAuth login or personal API key required) ```bash studio sandboxes create [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Display name, unique within the workspace; 1 to 64 characters. | | `--language ` | Yes | Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`. | | `--dependencies ` | No | Package specifiers installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | | `--cli-tools ` | No | Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--system-packages ` | No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | ### studio sandboxes delete [#studio-sandboxes-delete] Delete Sandbox (OAuth login or personal API key required) ```bash studio sandboxes delete [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio sandboxes get [#studio-sandboxes-get] Get Sandbox ```bash studio sandboxes get ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | ### studio sandboxes list [#studio-sandboxes-list] List Sandboxes ```bash studio sandboxes list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the sandbox name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio sandboxes update [#studio-sandboxes-update] Update Sandbox (OAuth login or personal API key required) ```bash studio sandboxes update [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | New display name, unique within the workspace; 1 to 64 characters. | | `--language ` | No | Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`. | | `--dependencies ` | No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | | `--cli-tools ` | No | Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--system-packages ` | No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | ## studio secrets [#studio-secrets] Also spelled `studio secret`. ### studio secrets delete [#studio-secrets-delete] Delete Secret (OAuth login or personal API key required) ```bash studio secrets delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ----------------- | | `name` | Yes | Secret to delete. | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Whether the secret belongs to the workspace or to the caller. A personal secret belongs to the caller across every workspace, not to one workspace. Accepted values: `workspace`, `personal`. | | `-y, --yes` | Yes | Confirm this operation. | ### studio secrets list [#studio-secrets-list] List Secrets (OAuth login or personal API key required) ```bash studio secrets list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Restrict results to one ownership scope. Accepted values: `workspace`, `personal`. | | `--search ` | No | Case-insensitive substring match against the secret name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio secrets set [#studio-secrets-set] Create or replace a named secret (OAuth login or personal API key required) ```bash studio secrets set [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------------------------------- | | `name` | Yes | Secret name, as referenced in workflows | **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Secret ownership scope. Accepted values: `workspace`, `personal`. | | `--value ` | No | Secret value. Passing it inline exposes it to shell history and process listings; @path reads it from a file and @- from stdin, verbatim — a trailing newline is part of the value, so write the file with printf rather than echo. Prefix a literal leading @ with a second one. | | `--description ` | No | What the secret is for, shown to teammates; workspace scope only. Omit to leave an existing description unchanged. | | `--unredacted` | No | Opt the workspace secret out of redaction: its value then appears in plaintext in run logs, model-visible content, and files, including publicly shared log links. Workspace scope only — sending it for a personal secret is rejected. Omit it to leave the current setting untouched. Pass --no-unredacted to restore redaction. | | `--no-unredacted` | No | Send --unredacted as false. | ## studio selectors [#studio-selectors] ### studio selectors get [#studio-selectors-get] Get Selector Option (OAuth login or personal API key required) ```bash studio selectors get [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--selector-key ` | Yes | Registered selector key for discovering this field’s destination options. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `studio.workflows`, `table.columns`, `table.outputColumns`, `meta.pages`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. (JSON, or @path / @- to read a file or stdin). | | `--id ` | Yes | Resource identifier. | ### studio selectors list [#studio-selectors-list] List Selector Options (OAuth login or personal API key required) ```bash studio selectors list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--selector-key ` | Yes | Registered selector key for discovering this field’s destination options. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `studio.workflows`, `table.columns`, `table.outputColumns`, `meta.pages`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. (JSON, or @path / @- to read a file or stdin). | | `--search ` | No | Provider option search text. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | ## studio skills [#studio-skills] Also spelled `studio skill`. ### studio skills create [#studio-skills-create] Create Skill (OAuth login or personal API key required) ```bash studio skills create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------- | | `--name ` | Yes | Kebab-case name, unique within the workspace and not reserved by a built-in skill. | | `--description ` | Yes | One-line summary of when the skill applies. | | `--content ` | Yes | Skill body containing the instructions given to the agent. | ### studio skills delete [#studio-skills-delete] Delete Skill (OAuth login or personal API key required) ```bash studio skills delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio skills get [#studio-skills-get] Get Skill ```bash studio skills get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | ### studio skills editors create [#studio-skills-editors-create] Grant Skill Editor (OAuth login or personal API key required) ```bash studio skills editors create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------- | -------- | -------------------------------------------- | | `--email ` | Yes | Email address of a current workspace member. | ### studio skills editors list [#studio-skills-editors-list] List Skill Editors ```bash studio skills editors list [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | 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: `email`, `name`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio skills editors delete [#studio-skills-editors-delete] Revoke Skill Editor (OAuth login or personal API key required) ```bash studio skills editors delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------- | -------- | -------------------------------------------- | | `--email ` | Yes | Email address of a current workspace member. | | `-y, --yes` | Yes | Confirm this operation. | ### studio skills list [#studio-skills-list] List Skills ```bash studio skills list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the skill name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio skills update [#studio-skills-update] Update Skill (OAuth login or personal API key required) ```bash studio skills update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------------------------- | | `--name ` | No | New kebab-case skill name. | | `--description ` | No | New one-line summary of when the skill applies. | | `--content ` | No | Replacement skill body. | ## studio tables [#studio-tables] Also spelled `studio table`. ### studio tables columns create [#studio-tables-columns-create] Add Column ```bash studio tables columns create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------ | | `--column ` | Yes | Column definition to add. (JSON, or @path / @- to read a file or stdin). | ### studio tables columns delete [#studio-tables-columns-delete] Delete Column ```bash studio tables columns delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------- | | `--column-name ` | Yes | Name of the column to delete. | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables columns update [#studio-tables-columns-update] Update Column ```bash studio tables columns update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------- | | `--column-name ` | Yes | Current name of the column to update. | | `--updates ` | Yes | Mutable column fields. (JSON, or @path / @- to read a file or stdin). | ### studio tables groups create [#studio-tables-groups-create] Add Workflow Group ```bash studio tables groups create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | `--group ` | Yes | Workflow or enrichment producer definition. (JSON, or @path / @- to read a file or stdin). | | `--output-columns ` | Yes | Columns created for producer outputs. (JSON, or @path / @- to read a file or stdin). | | `--auto-run` | No | Whether to schedule existing rows after group creation. | | `--no-auto-run` | No | Send --auto-run as false. | ### studio tables groups delete [#studio-tables-groups-delete] Delete Workflow Group ```bash studio tables groups delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------- | | `--group-id ` | Yes | Workflow group to delete. | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables groups list [#studio-tables-groups-list] List Workflow Groups ```bash studio tables groups list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### studio tables groups update [#studio-tables-groups-update] Update Workflow Group ```bash studio tables groups update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--group-id ` | Yes | Workflow group to update. | | `--workflow-id ` | No | Replacement backing workflow identifier. | | `--name ` | No | Replacement workflow-group display name. | | `--dependencies ` | No | Replacement input dependencies. (JSON, or @path / @- to read a file or stdin). | | `--outputs ` | No | Replacement producer outputs. (JSON, or @path / @- to read a file or stdin). | | `--new-output-columns ` | No | Columns to add for new outputs. (JSON, or @path / @- to read a file or stdin). | | `--mapping-updates ` | No | Existing output-column mapping changes. (JSON, or @path / @- to read a file or stdin). | | `--input-mappings ` | No | Replacement workflow input mappings. (JSON, or @path / @- to read a file or stdin). | | `--deployment-mode ` | No | Replacement workflow execution mode. Accepted values: `live`, `deployed`. | | `--type ` | No | Workflow-group producer type. Must match the group's stored type — a group's producer cannot be changed after creation. Accepted values: `manual`, `enrichment`. | | `--auto-run` | No | Replacement automatic-run setting. | | `--no-auto-run` | No | Send --auto-run as false. | ### studio tables batch-delete [#studio-tables-batch-delete] Bulk Delete Tables and Folders ```bash studio tables batch-delete [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `--table-ids ` | No | Tables to archive, by identifier. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables rows update-each [#studio-tables-rows-update-each] Apply a distinct patch to each listed row ```bash studio tables rows update-each [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | | `--updates ` | Yes | One merge patch per row. Each row identifier may appear at most once. (JSON, or @path / @- to read a file or stdin). | ### studio tables rows create [#studio-tables-rows-create] Create Rows ```bash studio tables rows create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------- | | `--data ` | No | One row keyed by column name (JSON, or @path / @-; choose exactly one body flag). | | `--rows ` | No | Several rows keyed by column name (JSON, or @path / @-; choose exactly one body flag). | ### studio tables rows delete [#studio-tables-rows-delete] Delete Row ```bash studio tables rows delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables rows batch-delete [#studio-tables-rows-batch-delete] Delete rows matching a filter, or an explicit list of ids ```bash studio tables rows batch-delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum matching rows to delete. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted). | | `--row ` | No | Explicit row identifiers to delete. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables rows get [#studio-tables-rows-get] Get Row ```bash studio tables rows get [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------- | | `--include-run-state` | No | Include per-workflow-group run state on the returned row. Off by default. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### studio tables rows list [#studio-tables-rows-list] List Rows ```bash studio tables rows list [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--include-run-state` | No | Include per-workflow-group run state on every returned row. Off by default: run state is a separate sidecar read and its `blockErrors` are unbounded, so a full page carries it only when asked. Caps `limit` at 200. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### studio tables rows query [#studio-tables-rows-query] Query Rows ```bash studio tables rows query [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--filter ` | No | Condition: \{"field":"status","op":"eq","value":"active"}. Groups: \{"all":\[\{"field":"status","op":"eq","value":"active"}]} or \{"any":\[\{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--sort ` | No | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--include-run-state` | No | Include per-workflow-group run state on every returned row. Off by default: run state is a separate sidecar read and its `blockErrors` are unbounded, so a full page carries it only when asked. Incompatible with `limit: 0`, and caps `limit` at 200. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### studio tables rows count [#studio-tables-rows-count] Count rows matching a filter ```bash studio tables rows count [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--filter ` | No | Condition: \{"field":"status","op":"eq","value":"active"}. Groups: \{"all":\[\{"field":"status","op":"eq","value":"active"}]} or \{"any":\[\{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | ### studio tables rows enrich [#studio-tables-rows-enrich] Run one row’s enrichment group ```bash studio tables rows enrich ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------ | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | | `groupId` | Yes | Workflow or enrichment group to run. | ### studio tables rows search [#studio-tables-rows-search] Search cells for a value and return their coordinates ```bash studio tables rows search [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--query ` | Yes | Value to search for. | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--sort ` | No | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin). | ### studio tables rows batch-update [#studio-tables-rows-batch-update] Update every row matching a filter ```bash studio tables rows batch-update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filter ` | Yes | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--data ` | Yes | Row-data patch applied to every matching row. (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum matching rows to update. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted). | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables rows update [#studio-tables-rows-update] Update Row ```bash studio tables rows update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------- | | `--data ` | Yes | Partial row-data patch keyed by column name. (JSON, or @path / @- to read a file or stdin). | ### studio tables dispatches cancel [#studio-tables-dispatches-cancel] Cancel a running dispatch ```bash studio tables dispatches cancel [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `dispatchId` | Yes | Unique table run-dispatch identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables dispatches create [#studio-tables-dispatches-create] Start a column or enrichment run ```bash studio tables dispatches create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--group-ids ` | Yes | Workflow or enrichment groups to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--run-mode ` | No | Whether to run all or only incomplete cells. Accepted values: `all`, `incomplete`. | | `--row-ids ` | No | Explicit row subset to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--exclude-row-ids ` | No | Rows excluded from a select-all run scope. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--max-rows ` | No | Stop after this many eligible rows have run (1-1,000,000). Omit for an unbounded run. | ### studio tables dispatches get [#studio-tables-dispatches-get] Get Run Dispatch ```bash studio tables dispatches get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `dispatchId` | Yes | Unique table run-dispatch identifier. | ### studio tables dispatches list [#studio-tables-dispatches-list] List Active Run Dispatches ```bash studio tables dispatches list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### studio tables exports cancel [#studio-tables-exports-cancel] Stop a running export ```bash studio tables exports cancel ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### studio tables exports create [#studio-tables-exports-create] Create Table Export ```bash studio tables exports create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | --------------------------------------------------- | | `--format ` | No | Export file format. Accepted values: `csv`, `json`. | ### studio tables exports get [#studio-tables-exports-get] Get Table Export ```bash studio tables exports get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### studio tables exports download [#studio-tables-exports-download] Get the download URL for a finished export ```bash studio tables exports download ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### studio tables imports cancel [#studio-tables-imports-cancel] Stop a running import ```bash studio tables imports cancel [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `importId` | Yes | Unique table-import identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables imports get [#studio-tables-imports-get] Get Table Import ```bash studio tables imports get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `importId` | Yes | Unique table-import identifier. | ### studio tables cancel-runs [#studio-tables-cancel-runs] Stop every running column job ```bash studio tables cancel-runs [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Whether to cancel across the table or one row. Accepted values: `all`, `row`. | | `--row-id ` | No | Row whose runs should be canceled for row scope. | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--exclude-row-ids ` | No | Rows excluded from an all-scope cancellation. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables create [#studio-tables-create] Create Table ```bash studio tables create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Identifier: letters, numbers, and underscores; cannot start with a number. | | `--description ` | No | Optional table description. | | `--schema ` | Yes | Table schema: \{"columns":\[\{"name":"email","type":"string"}]} (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio tables folders create [#studio-tables-folders-create] Create a table folder at a path ```bash studio tables folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio tables folders delete [#studio-tables-folders-delete] Delete Folder ```bash studio tables folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables folders list [#studio-tables-folders-list] List table folders ```bash studio tables folders list [options] ``` Also available as `studio tables folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### studio tables folders move [#studio-tables-folders-move] Rename or move a table folder ```bash studio tables folders move ``` Also available as `studio tables folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `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 | ### studio tables folders restore [#studio-tables-folders-restore] Restore an archived table folder ```bash studio tables folders restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio tables views create [#studio-tables-views-create] Create View ```bash studio tables views create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Saved-view display name. | | `--config ` | Yes | Saved filter, sort, and column-layout configuration. (JSON, or @path / @- to read a file or stdin). | ### studio tables views delete [#studio-tables-views-delete] Delete View ```bash studio tables views delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables views get [#studio-tables-views-get] Get View ```bash studio tables views get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | ### studio tables views list [#studio-tables-views-list] List Views ```bash studio tables views list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### studio tables views update [#studio-tables-views-update] Update View ```bash studio tables views update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------ | | `--name ` | No | Replacement saved-view display name. | | `--config ` | No | Complete replacement saved-view configuration. (JSON, or @path / @- to read a file or stdin). | | `--config-patch ` | No | Saved-view configuration fields to shallow-merge. (JSON, or @path / @- to read a file or stdin). | | `--is-default` | No | Whether to promote this view to the table default. | | `--no-is-default` | No | Send --is-default as false. | ### studio tables delete [#studio-tables-delete] Delete Table ```bash studio tables delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio tables enrichment get [#studio-tables-enrichment-get] Get Enrichment Run Detail ```bash studio tables enrichment get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------ | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | | `groupId` | Yes | Workflow or enrichment group to run. | ### studio tables get [#studio-tables-get] Get Table ```bash studio tables get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### studio tables list [#studio-tables-list] List Tables ```bash studio tables list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Which lifecycle set to list: `active` (default) for live tables, `archived` for tables a delete archived and a table 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`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio tables move [#studio-tables-move] Move Tables and Folders ```bash studio tables move [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--table-ids ` | No | Tables to move, by identifier. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Table folders to move, by path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | No | Destination folder path; omit for root. | ### studio tables restore [#studio-tables-restore] Restore an archived table ```bash studio tables restore ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### studio tables update [#studio-tables-update] Update Table ```bash studio tables update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------- | | `--name ` | No | Identifier: letters, numbers, and underscores; cannot start with a number. | | `--description ` | No | Replacement table description, or null to clear it. (--description null sends the word, not JSON null). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio tables mv [#studio-tables-mv] Move a table to a folder ```bash studio tables mv ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### studio tables upsert [#studio-tables-upsert] Insert a row, or update the one that conflicts on a unique column ```bash studio tables upsert [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--data ` | Yes | Complete set of row cells keyed by column name. On the update branch this REPLACES the matched row: any column not present here is cleared, unlike a single-row update, which merges. (JSON, or @path / @- to read a file or stdin). | | `--on ` | No | Unique column to resolve the conflict against. | ### studio tables import [#studio-tables-import] Import a CSV, into a new table by default ```bash studio tables import [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------------------------------------------- | | `path` | No | Local CSV file to import; omit when using --file-id | **Options** | Option | Required | Description | | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `--name ` | No | Identifier for the new table: letters, numbers, and underscores; defaults to the sanitized file name. | | `--table-id ` | No | Import into this existing table instead of creating one. | | `--mode ` | No | How to write into --table-id (default: append). Accepted values: `append`, `replace`. | | `--folder ` | No | Folder path for the new table, as shown in the app. | | `--file-id ` | No | Import a file already in the workspace instead of a local path. | | `--mapping ` | No | Column mapping (--table-id only). | | `--create-columns ` | No | Columns to create (--table-id only). | | `--timezone ` | No | Timezone for date parsing, e.g. America/New\_York. | | `-y, --yes` | No | Confirm this destructive operation (required with --mode replace). | | `--no-wait` | No | Return once the import is queued instead of watching it. | ### studio tables ls [#studio-tables-ls] List table resources and child folders together ```bash studio tables ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### studio tables mkdir [#studio-tables-mkdir] Create a table directory at a path ```bash studio tables mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## studio tools [#studio-tools] ### studio tools execute [#studio-tools-execute] Run one built-in tool and print what it produced (OAuth login or personal API key required) ```bash studio tools execute [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `toolId` | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. | **Options** | Option | Required | Description | | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `--input ` | No | Tool arguments as JSON, keyed by the parameter ids `studio tools get <toolId>` lists (JSON, or @path / @- to read a file or stdin). | | `--credential-id ` | No | Credential to authenticate with, required for OAuth tools. | | `--timeout ` | No | Seconds to wait before abandoning the call. | ### studio tools get [#studio-tools-get] Get Tool ```bash studio tools get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `toolId` | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. | ### studio tools list [#studio-tools-list] List Tools ```bash studio tools list [options] ``` **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the tool id, name, and description. | | `--hosted-api-key ` | No | Restrict to tools by how their API key is supplied. Accepted values: `always`, `conditional`, `none`. | | `--oauth-provider ` | No | Restrict to tools that authenticate against this OAuth service. | | `--sort-by ` | 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: `id`, `name`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## studio workflow-mcp-servers [#studio-workflow-mcp-servers] ### studio workflow-mcp-servers create [#studio-workflow-mcp-servers-create] Create Workflow MCP Server (OAuth login or personal API key required) ```bash studio workflow-mcp-servers create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Server display name, shown to connecting MCP clients. | | `--description ` | No | Optional server description. | | `--is-public` | No | Whether the server answers MCP clients without a Studio API key. Defaults to false — a public server executes the workflows it publishes for anyone holding its URL. | | `--no-is-public` | No | Send --is-public as false. | | `--workflow ` | No | Deployed workflows to publish as tools on the new server. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### studio workflow-mcp-servers delete [#studio-workflow-mcp-servers-delete] Delete Workflow MCP Server (OAuth login or personal API key required) ```bash studio workflow-mcp-servers delete [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflow-mcp-servers tools create [#studio-workflow-mcp-servers-tools-create] Publish Workflow As MCP Tool (OAuth login or personal API key required) ```bash studio workflow-mcp-servers tools create [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow-id ` | Yes | Deployed workflow to publish. The workflow must already be deployed. | | `--tool-name ` | No | Name MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted. | | `--tool-description ` | No | Description shown to MCP clients. Derived from the workflow name when omitted. | | `--parameter-descriptions ` | No | Per-field description overrides applied to the schema generated from the deployed workflow inputs, as \[\{"name":"email","description":"Customer email address"}]. A name matching no input field is ignored (JSON, or @path / @- to read a file or stdin). | ### studio workflow-mcp-servers tools list [#studio-workflow-mcp-servers-tools-list] List Workflow MCP Tools (OAuth login or personal API key required) ```bash studio workflow-mcp-servers tools list ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | ### studio workflow-mcp-servers tools delete [#studio-workflow-mcp-servers-tools-delete] Unpublish Workflow MCP Tool (OAuth login or personal API key required) ```bash studio workflow-mcp-servers tools delete [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | -------------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | | `workflowId` | Yes | Workflow published as a tool on this server. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflow-mcp-servers get [#studio-workflow-mcp-servers-get] Get Workflow MCP Server (OAuth login or personal API key required) ```bash studio workflow-mcp-servers get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | ### studio workflow-mcp-servers list [#studio-workflow-mcp-servers-list] List Workflow MCP Servers (OAuth login or personal API key required) ```bash studio workflow-mcp-servers list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio workflow-mcp-servers update [#studio-workflow-mcp-servers-update] Update Workflow MCP Server (OAuth login or personal API key required) ```bash studio workflow-mcp-servers update [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------ | | `--name ` | No | Server display name, shown to connecting MCP clients. | | `--description ` | No | New server description, or null to clear it. (--description null sends the word, not JSON null). | | `--is-public` | No | Whether the server answers MCP clients without a Studio API key. | | `--no-is-public` | No | Send --is-public as false. | ## studio workflows [#studio-workflows] Also spelled `studio workflow`. ### studio workflows activate create [#studio-workflows-activate-create] Activate Workflow Version (OAuth login or personal API key required) ```bash studio workflows activate create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows operations apply [#studio-workflows-operations-apply] Apply Workflow Operations (OAuth login or personal API key required) ```bash studio workflows operations apply [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--dry-run` | No | Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified. | | `--no-dry-run` | No | Send --dry-run as false. | | `--operations ` | Yes | Edits to apply, in a single batch, keyed by operation\_type: \[\{"operation\_type":"add","block\_id":"my-fn","params":\{"type":"function","name":"My Fn","inputs":\{"code":"return \{ok:true}"}}},\{"operation\_type":"edit","block\_id":"\","params":\{"name":"Renamed","connections":\{"success":"my-fn"}}},\{"operation\_type":"delete","block\_id":"\"}]. Also extract\_from\_subflow, whose params carry \{"subflowId":"\"}, and insert\_into\_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). | | `--atomic` | No | Fail the whole batch when any operation is declined or any block input would be dropped. The default applies what it can and reports the rest in `skipped` and `inputValidationErrors`; `true` writes nothing and answers `409` instead. | | `--no-atomic` | No | Send --atomic as false. | | `--layout ` | No | Whether to reposition blocks the batch touched. `targeted` (default) nudges only the affected subgraph; `none` leaves every position exactly as supplied. Accepted values: `targeted`, `none`. | | `--set-block-enabled ` | No | Blocks to enable or disable, applied after --operations: \[\{"block\_id":"\","enabled":false}]. Disabling a loop or parallel cascades to its unlocked descendants; enabling a block whose container is disabled is declined (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | No | Confirm this operation (required unless --dry-run). | ### studio workflows variables update [#studio-workflows-variables-update] Update Workflow Variables ```bash studio workflows variables update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--operations ` | Yes | Variable changes to apply in order, keyed by operation: \[\{"operation":"add","name":"my\_var","type":"string","value":"hello"},\{"operation":"edit","name":"my\_var","value":"updated"},\{"operation":"delete","name":"my\_var"}] (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows runs cancel [#studio-workflows-runs-cancel] Cancel a running workflow run ```bash studio workflows runs cancel [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | ------------ | | `--workflow ` | Yes | Workflow ID. | ### studio workflows runs get [#studio-workflows-runs-get] Show run status (requested outputs are included in JSON or YAML output) ```bash studio workflows runs get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ---------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--include-output` | No | Include the final output in JSON or YAML output. | | `--select-output ` | No | Include blockId or blockId.path values in JSON or YAML output; block names are not resolved on a finished run (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-file-base64` | No | Inline each produced file's bytes as base64. Requires `includeOutput`. A file above the inline ceiling answers `413` naming its download path; fetch large files from `downloadPath` instead. | | `--no-include-file-base64` | No | Send --include-file-base64 as false. | | `--base64-max-bytes ` | No | Per-file inline ceiling, lowering but never raising the server limit of 16 MiB. | ### studio workflows runs list [#studio-workflows-runs-list] List runs for a workflow ```bash studio workflows runs list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--status ` | No | Filter by run status. Accepted values: `pending`, `running`, `completed`, `failed`, `cancelled`, `paused`. | | `--trigger ` | No | Filter by trigger type. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--order ` | No | Sort direction by run start time. This list is sortable only by run start time, so it takes `order` in place of `sortBy`/`sortOrder`, which it rejects. Accepted values: `asc`, `desc`. | ### studio workflows runs resume [#studio-workflows-runs-resume] Resume a paused run (output is included in JSON or YAML output) ```bash studio workflows runs resume [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | ------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--context ` | Yes | Pause context ID returned by run status. | | `--input ` | No | Resume input as JSON (JSON, or @path / @- to read a file or stdin). | ### studio workflows runs wait [#studio-workflows-runs-wait] Wait for a run to reach a terminal state, then show it ```bash studio workflows runs wait [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--wait-timeout ` | No | Give up after this many seconds, or 0 to wait indefinitely (default: 3600). Bounds the whole wait; STUDIO\_TIMEOUT\_SECONDS bounds one request. | ### studio workflows create [#studio-workflows-create] Create Workflow ```bash studio workflows create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------------------------------------- | | `--name ` | Yes | Workflow name. | | `--description ` | No | Optional workflow description. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio workflows folders create [#studio-workflows-folders-create] Create a workflow folder at a path ```bash studio workflows folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### studio workflows folders delete [#studio-workflows-folders-delete] Delete Workflow Folder ```bash studio workflows folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows folders list [#studio-workflows-folders-list] List workflow folders ```bash studio workflows folders list [options] ``` Also available as `studio workflows folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### studio workflows folders move [#studio-workflows-folders-move] Rename or move a workflow folder ```bash studio workflows folders move ``` Also available as `studio workflows folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `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 | ### studio workflows delete [#studio-workflows-delete] Delete Workflow ```bash studio workflows delete [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows chat unpublish [#studio-workflows-chat-unpublish] Take a workflow’s chat deployment offline (OAuth login or personal API key required) ```bash studio workflows chat unpublish [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows chat status [#studio-workflows-chat-status] Show a workflow’s chat deployment (OAuth login or personal API key required) ```bash studio workflows chat status ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### studio workflows chat publish [#studio-workflows-chat-publish] Publish or replace a workflow’s chat deployment (OAuth login or personal API key required) ```bash studio workflows chat publish [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--identifier ` | Yes | URL slug the deployed chat answers on. Must be free across live deployments. | | `--title ` | Yes | Title shown to visitors. | | `--description ` | No | Description shown to visitors. Omitted clears it. | | `--customizations ` | No | Presentation overrides. Omitted fields take platform defaults. (JSON, or @path / @- to read a file or stdin). | | `--auth-type ` | No | How visitors are gated. `public` leaves the chat open to anyone holding the URL. Accepted values: `public`, `password`, `email`, `sso`. | | `--password ` | No | Write-only password. Required whenever `authType` is `password`, and rejected otherwise. Never readable back. | | `--allowed-emails ` | No | Email addresses or domains admitted under `email` and `sso` gating. At least one is required for those modes. (JSON, or @path / @- to read a file or stdin). | | `--output-configs ` | No | Block outputs to surface to visitors. Omitted surfaces none. (JSON, or @path / @- to read a file or stdin). | | `--include-thinking` | No | Allow visitors to receive provider thinking events. | | `--no-include-thinking` | No | Send --include-thinking as false. | | `--include-tool-calls` | No | Allow visitors to receive tool lifecycle events. | | `--no-include-tool-calls` | No | Send --include-tool-calls as false. | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows deploy [#studio-workflows-deploy] Deploy Workflow (OAuth login or personal API key required) ```bash studio workflows deploy [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------- | | `--name ` | No | Optional label for the deployment version. | | `--description ` | No | Optional release note for the deployment version. | ### studio workflows duplicate create [#studio-workflows-duplicate-create] Duplicate Workflow ```bash studio workflows duplicate create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------- | | `--name ` | No | Name for the copy. Defaults to the source name, deduplicated within the folder. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio workflows run [#studio-workflows-run] Run a deployed workflow or execute saved state manually ```bash studio workflows run [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--input ` | No | Trigger input as JSON (JSON, or @path / @- to read a file or stdin). | | `--async` | No | Queue the run and return immediately. | | `--execution-timeout-seconds ` | No | Maximum duration of an asynchronous run, in seconds, capped by the plan's execution timeout. Requires `async: true`; otherwise returns `400`. | | `--select-output ` | No | Return streamed outputs as blockName.path or childWorkflowId.blockName.path; selecting a child workflow applies to every invocation, requires --follow (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-file-base64` | No | Inline eligible output files as base64 content. Rejected when `async` is true. | | `--no-include-file-base64` | No | Send --include-file-base64 as false. | | `--base64-max-bytes ` | No | Maximum total bytes of file content to inline as base64, lowering but never raising the server limit of 16 MiB. Rejected when `async` is true. | | `--run-id ` | No | One-shot identifier for this run; NOT an idempotency key — reusing a claimed value fails with RUN\_ID\_CONFLICT instead of replaying the first result, and a fresh value starts another run. | | `--manual` | No | Run the current saved workflow state instead of the active deployment. | | `--trigger ` | No | Enter a manual run through this runnable trigger (requires --manual). | | `--mock-payload` | No | Use the selected trigger's server-derived mock payload (requires --manual). | | `--from-block ` | No | Run manually from this saved workflow block. | | `--source-run ` | No | Prior run whose persisted state supplies upstream outputs (requires --from-block). | | `--follow` | No | Stream the run as it happens; progress on stderr, result on stdout. The stream reports only success and output, so the result omits the run id and timings a non-streaming run returns. | | `--include-thinking` | No | Show model reasoning while following (requires --follow). | | `--include-tool-calls` | No | Show tool calls while following (requires --follow). | ### studio workflows export [#studio-workflows-export] Print a workflow as a portable JSON document ```bash studio workflows export [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------- | | `--include-references` | No | Include non-secret resource identities for mapped import. | ### studio workflows get [#studio-workflows-get] Get Workflow ```bash studio workflows get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### studio workflows deployment status [#studio-workflows-deployment-status] Show a workflow’s current deployment ```bash studio workflows deployment status ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### studio workflows deployment update [#studio-workflows-deployment-update] Update Workflow Public API Access (OAuth login or personal API key required) ```bash studio workflows deployment update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | | `--is-public-api ` | Yes | Whether the deployed workflow should accept unauthenticated public API execution. Accepted values: `true`, `false`. | ### studio workflows state get [#studio-workflows-state-get] Get Workflow State ```bash studio workflows state get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### studio workflows state replace [#studio-workflows-state-replace] Replace Workflow State (OAuth login or personal API key required) ```bash studio workflows state replace [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--dry-run` | No | Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified. | | `--no-dry-run` | No | Send --dry-run as false. | | `--blocks ` | Yes | Blocks keyed by block id. (JSON, or @path / @- to read a file or stdin). | | `--edges ` | Yes | Directed connections between blocks. (JSON, or @path / @- to read a file or stdin). | | `--loops ` | No | Ignored on write: loop containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin). | | `--parallels ` | No | Ignored on write: parallel containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin). | | `--variables ` | No | Replacement variable set. Omit to leave the stored variables untouched. (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | No | Confirm this operation (required unless --dry-run). | ### studio workflows versions get [#studio-workflows-versions-get] Get Workflow Version ```bash studio workflows versions get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | ### studio workflows versions list [#studio-workflows-versions-list] List Workflow Versions ```bash studio workflows versions list [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | -------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### studio workflows versions update [#studio-workflows-versions-update] Update Workflow Version ```bash studio workflows versions update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | New label for the deployment version. | | `--description ` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). | ### studio workflows import [#studio-workflows-import] Import Workflow ```bash studio workflows import [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--name ` | No | Override for the imported workflow name. | | `--description ` | No | Override for the imported workflow description. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--bindings ` | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | No | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | No | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | ### studio workflows list [#studio-workflows-list] List Workflows ```bash studio workflows list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Which lifecycle set to list: `active` (default) for live workflows, `archived` for workflows a `DELETE` archived. 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 ` | No | Folder path as shown in the app; the leading / is optional. | | `--deployed-only` | No | Return only workflows with an active deployment when true. | | `--no-deployed-only` | No | Send --deployed-only as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | 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: `position`, `name`, `createdAt`, `updatedAt`, `runCount`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### studio workflows move [#studio-workflows-move] Move Workflows ```bash studio workflows move [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflows to move. Duplicates are collapsed. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | Yes | Destination folder path; / moves the workflows to the workspace root. | ### studio workflows import-preview [#studio-workflows-import-preview] Preview Workflow Import ```bash studio workflows import-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--name ` | No | Override for the imported workflow name. | | `--description ` | No | Override for the imported workflow description. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--bindings ` | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | ### studio workflows restore [#studio-workflows-restore] Restore an archived workflow ```bash studio workflows restore ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### studio workflows revert create [#studio-workflows-revert-create] Revert Workflow To Version (OAuth login or personal API key required) ```bash studio workflows revert create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ----------------------------------------------------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version, or `active` for the currently live version. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows rollback [#studio-workflows-rollback] Rollback Workflow (OAuth login or personal API key required) ```bash studio workflows rollback [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------- | | `--to-version ` | No | Deployment version to reactivate. Omit to select the previous active version. | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows undeploy [#studio-workflows-undeploy] Take a workflow out of deployment (OAuth login or personal API key required) ```bash studio workflows undeploy [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### studio workflows update [#studio-workflows-update] Update Workflow ```bash studio workflows update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `--name ` | No | Replacement workflow name. | | `--description ` | No | Replacement workflow description; null clears it. (--description null sends the word, not JSON null). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### studio workflows mv [#studio-workflows-mv] Move a workflow to a folder ```bash studio workflows mv ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ---------------------------------------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### studio workflows ls [#studio-workflows-ls] List workflow resources and child folders together ```bash studio workflows ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### studio workflows mkdir [#studio-workflows-mkdir] Create a workflow directory at a path ```bash studio workflows mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## studio workspaces [#studio-workspaces] Also spelled `studio workspace`. ### studio workspaces fork [#studio-workspaces-fork] Fork Workspace (OAuth login or personal API key required) ```bash studio workspaces fork [options] ``` **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Display name of the workflow or workspace. | | `--copy ` | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | ### studio workspaces get [#studio-workspaces-get] Get Workspace ```bash studio workspaces get ``` ### studio workspaces fork-availability [#studio-workspaces-fork-availability] Get Workspace Fork Availability (OAuth login or personal API key required) ```bash studio workspaces fork-availability ``` ### studio workspaces lineage [#studio-workspaces-lineage] Get Workspace Fork Lineage (OAuth login or personal API key required) ```bash studio workspaces lineage ``` ### studio workspaces mappings get [#studio-workspaces-mappings-get] Get Workspace Fork Mappings (OAuth login or personal API key required) ```bash studio workspaces mappings get [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--direction ` | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: `push`, `pull`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`. | ### studio workspaces mappings update [#studio-workspaces-mappings-update] Update Workspace Fork Mappings (OAuth login or personal API key required) ```bash studio workspaces mappings update [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--direction ` | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: `push`, `pull`. | | `--mappings ` | Yes | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | ### studio workspaces operations get [#studio-workspaces-operations-get] Get Workspace Operation ```bash studio workspaces operations get ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ------------------------------------------------ | | `operationId` | Yes | Durable operation identifier to use for polling. | ### studio workspaces operations list [#studio-workspaces-operations-list] List Workspace Operations ```bash studio workspaces operations list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------ | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--request-id ` | No | Stable client request ID for reconciliation and identical retries. | ### studio workspaces operations wait [#studio-workspaces-operations-wait] Wait for copy and deployment readiness; exit 3 for configuration, 1 for failure, or 4 for timeout ```bash studio workspaces operations wait [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------- | | `operationId` | Yes | Operation ID returned by import, fork, push, or pull | **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------- | | `--wait-timeout ` | No | Maximum total wait (default 3600; 0 waits indefinitely). | ### studio workspaces children [#studio-workspaces-children] List Workspace Fork Children (OAuth login or personal API key required) ```bash studio workspaces children [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `createdAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `desc`. | ### studio workspaces fork-resources [#studio-workspaces-fork-resources] List Workspace Fork Resources (OAuth login or personal API key required) ```bash studio workspaces fork-resources [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--kind ` | Yes | Resource or operation kind. Accepted values: `files`, `tables`, `knowledgeBases`, `customTools`, `skills`, `mcpServers`, `workflowMcpServers`. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`. | ### studio workspaces members [#studio-workspaces-members] List workspace members ```bash studio workspaces members [options] ``` **Options** | Option | Required | Description | | ------------- | -------- | ------------------------------------------------------------ | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio workspaces list [#studio-workspaces-list] List Workspaces ```bash studio workspaces list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | 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 ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### studio workspaces fork-preview [#studio-workspaces-fork-preview] Preview Workspace Fork (OAuth login or personal API key required) ```bash studio workspaces fork-preview [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Display name of the workflow or workspace. | | `--copy ` | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). | ### studio workspaces pull-preview [#studio-workspaces-pull-preview] Preview Workspace Pull (OAuth login or personal API key required) ```bash studio workspaces pull-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | ### studio workspaces push-preview [#studio-workspaces-push-preview] Preview Workspace Push (OAuth login or personal API key required) ```bash studio workspaces push-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | ### studio workspaces pull [#studio-workspaces-pull] Pull Workspace (OAuth login or personal API key required) ```bash studio workspaces pull [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | | `-y, --yes` | Yes | Confirm this operation. | ### studio workspaces push [#studio-workspaces-push] Push Workspace (OAuth login or personal API key required) ```bash studio workspaces push [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | | `-y, --yes` | Yes | Confirm this operation. | ### studio workspaces fork-rollback [#studio-workspaces-fork-rollback] Rollback Workspace Fork (OAuth login or personal API key required) ```bash studio workspaces fork-rollback [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ---------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `-y, --yes` | Yes | Confirm this operation. | ### studio workspaces unlink [#studio-workspaces-unlink] Unlink Workspace Fork (OAuth login or personal API key required) ```bash studio workspaces unlink [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ---------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `-y, --yes` | Yes | Confirm this operation. | ### studio workspaces sync-exclusions [#studio-workspaces-sync-exclusions] Update Workspace Fork Exclusions (OAuth login or personal API key required) ```bash studio workspaces sync-exclusions [options] ``` **Options** | Option | Required | Description | | ------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow identifiers in the current workspace. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--fork-sync-excluded ` | Yes | Whether the named workflows should be skipped as sync sources and targets. Accepted values: `true`, `false`. |