Every studio command follows the same shape:
studio <resource> [sub-resource] <verb> [arguments] [options]Some resource groups also accept a singular alias: studio workflow get and
studio workflows get are the same command. knowledge also answers to kb.
Each group’s reference lists its supported aliases.
Global options
These apply to every command, and may be written before or after it.
| Option | Description |
|---|---|
-P, --profile <name> | Profile to use (env: STUDIO_PROFILE). |
--endpoint <url> | Studio deployment to talk to (env: STUDIO_ENDPOINT). |
-w, --workspace <id> | Workspace to target (env: STUDIO_WORKSPACE). |
--output <format> | Output format for this command. Accepted values: table, json, yaml, text. |
Command groups
| Group | Description |
|---|---|
studio profiles | List profiles or add a workspace profile that shares a stored login |
studio telemetry | Control anonymous usage reporting |
studio audit-logs | Manage audit logs |
studio billing | Manage billing |
studio blocks | Manage blocks |
studio chat-deployments | Manage chat deployments |
studio connector-types | Manage connector types |
studio credentials | Manage credentials |
studio custom-tools | Manage custom tools |
studio files | Manage files |
studio knowledge | Manage knowledge |
studio logs | Manage logs |
studio mcp-servers | Manage mcp servers |
studio meta | Manage meta |
studio sandboxes | Manage sandboxes |
studio secrets | Manage secrets |
studio selectors | Manage selectors |
studio skills | Manage skills |
studio tables | Manage tables |
studio tools | Manage tools |
studio workflow-mcp-servers | Manage workflow mcp servers |
studio workflows | Manage workflows |
studio workspaces | Manage workspaces |
Sign in through the browser and store the login for the profile
studio login [options]Options
| Option | Required | Description |
|---|---|---|
--method <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 <port> | No | Pin the local port the browser returns to. |
-y, --yes | No | Overwrite an existing API-key profile without prompting. |
Sign out and remove the profile's stored login
studio logout [options]Options
| Option | Required | Description |
|---|---|---|
--all | No | Remove the profile entirely, including its settings. |
Show the resolved profile, where each setting came from, and whether it works
studio whoami [options]Options
| Option | Required | Description |
|---|---|---|
--no-verify | No | Skip the API check and only print the resolved settings. |
Set a profile's endpoint, default workspace, or output format
studio configure [options]Options
| Option | Required | Description |
|---|---|---|
--set-endpoint <url> | No | Studio deployment to talk to. |
--set-workspace <id> | No | Default workspace for workspace-scoped commands. |
--set-output <format> | No | Default output format (table | json | yaml | text). |
--unset <key...> | No | Remove settings (endpoint, workspace, output). |
Update this global CLI installation to the newest release on its channel
studio update [options]Options
| Option | Required | Description |
|---|---|---|
--package-manager <manager> | No | Package manager that installed this copy. Accepted values: npm, pnpm, bun, yarn. |
Ask Studio and print the reply
studio chat <message> [options]Arguments
| Argument | Required | Description |
|---|---|---|
message | Yes | What to ask Studio |
Options
| Option | Required | Description |
|---|---|---|
-c, --conversation <id> | No | Continue the conversation with this ID. |