Overview
The pst command starts the Prompt Studio workbench and manages projects, sessions, workspaces, and extensions. Enabled extensions can add more command groups.
Run pst --help, pst <group> --help, or pst <group> <command> --help to see the options in your installed version.
Help and errors
- A command group without a subcommand, such as
pst agentsorpst auth tokens, prints the group’s help to standard output and exits with code 0. It does not start or need the runtime. - An unknown subcommand, such as
pst agents bogus, printsUnknown argument: bogusand the group’s help to standard error, then exits with code 1. An unknown top-level command does the same with the root help. - Output is complete for every reader: a terminal, a file (
> out.json), or a pipe (| tee out.json).pstwaits for the reader before it exits, also when it exits with code 1.
Extension actions are CLI-ready
An extension can expose the same command behind a button, toolbar action, or menu through pst. Agents can discover the generated help and call the command with explicit flags. They do not need to reproduce the screen interaction.
Run inside the project folder, or pass --project-id <project-id> to an extension command. The available extension commands come from that project’s enabled tools. For example, with Notes enabled:
pst pstdio.notes --help
pst pstdio.notes notes create --help
pst pstdio.notes notes create --title "Meeting notes" --json
Command and option descriptions use extension translations. The CLI reads LC_ALL, then
LC_MESSAGES, then LANG. It tries the full locale and language, then the extension default
locale and the declared fallback text. This also applies to parameter guidance in --help.
A successful extension command normally prints its returned value as JSON. --json prints the full execution response, including commandId and outcome; check outcome.ok and read outcome.value on success. A failed or rejected execution exits with code 1. Core commands have their own output formats; check each command’s help.
The extension author must declare CLI access and connect the UI action to the command. A custom webview button is not automatically a CLI command. See Make actions CLI-ready for authoring and Commands and processes for flags and namespaces.
Core commands
| Command | Purpose |
|---|---|
pst |
Start the API and dashboard, then open the workbench. |
pst serve |
Start or reuse the local API runtime. |
pst close |
Stop the background API runtime. |
pst logs |
Read the local runtime log. |
pst performance [snapshot] |
Print the desktop app’s local performance snapshot as JSON, including capture history, workbench frame rate (frameRate) and paused extensions (pausedExtensionIds). See Developer tools. |
pst performance recordings <directory> |
Export saved performance JSONL files without starting monitoring. |
pst update-channel [stable|nightly] |
Print or change which builds the desktop app on this computer updates to. See Install. |
pst projects |
Create, link, inspect, and remove projects. |
pst agents |
Discover harnesses and install skills. |
pst sessions |
Run and inspect agent sessions. |
pst workspaces |
Create, merge, and remove provider-backed workspaces. |
pst extensions |
Install, update, develop, and check extensions. add and dev accept a folder path such as ., .., ./tool, ~/tool, or an absolute path; any other value is a catalog name. Both need a linked project. From a folder outside one, the error names the absolute command to run from your project folder. See Scoped checks and versions for check. |
pst notifications |
Create and manage project notifications. |
pst inbox |
List pending project notifications. |
pst views |
Manage shared board views. |
pst auth tokens |
Issue, list, and revoke scoped machine tokens. |
pst automation |
Create and inspect durable automation runs. |
pst connections check |
Run an extension’s declared connection health check. |
Command pages
Extension commands are documented with their extensions:
Stream extension command output
Use pst <namespace> <command> [params] --stream for commands that declare streaming output. Standard output contains NDJSON: one { "type": "data", "data": ... } line per chunk, followed by { "type": "end", "outcome": ... }.
A success outcome exits with code 0. Other outcomes exit with code 1. Ctrl+C aborts the handler and exits with code 130. Without --stream, command output stays unchanged. A command without a stream declaration fails with command_not_streamable.
Resource discussion and structured implementation/review evidence are core commands under pst resources activity. The owner chooses which capabilities a resource supports; sessions keep their own conversation.
Updated at: 2026-11-12