Command Reference | BCTRL Docs

This reference is generated from the CLI command tree, so command names, arguments, and flags stay aligned with the installed bctrl binary.

For command-specific help in a terminal, run:

bctrl --help
bctrl <command> --help
bctrl <command> <subcommand> --help

Global output flags

Most data commands return JSON by default and support these formatting flags:

Flag	Description
`--json [fields]`	Output JSON with optional comma-separated field projection.
`--jq <expression>`	Filter JSON output using a jq expression.
`--template <template>`	Format JSON output using a Handlebars template.
`--no-color`	Disable color output.

Pagination (-L, --limit and --cursor), confirmation (-y, --yes), and request override flags (--params, --body) appear on the generated command pages where supported.

Command groups

Group	Commands	Description
version	`version`	Show bctrl version
auth	`auth`	Manage BCTRL authentication
account	`account`	Manage account
agents	`agents`	Manage agents
ai	`ai`	Manage ai
api-keys	`api-keys`	Manage api-keys
browser	`browser`	Manage browser
browsers	`browsers`	Manage browsers
conversations	`conversations`	Manage conversations
drains	`drains`	Manage drains
events	`events`	Manage events
files	`files`	Manage files
help	`help`	Return global API, SDK, and CLI help, or help for one named topic. Use query parameters so help is easy to call from browsers, CLI tools, SDKs, and plain HTTP clients.
locations	`locations`	Manage locations
notification-recipients	`notification-recipients`	Manage notification-recipients
proxies	`proxies`	Manage proxies
runs	`runs`	Manage runs
sandboxes	`sandboxes`	Manage sandboxes
secrets	`secrets`	Manage secrets
spaces	`spaces`	Manage spaces
subaccounts	`subaccounts`	Manage subaccounts
tasks	`tasks`	Manage tasks
tool-calls	`tool-calls`	Manage tool-calls
tools	`tools`	Manage tools
traces	`traces`	Manage traces
usage	`usage`	Manage usage
views	`views`	Manage views
webhooks	`webhooks`	Manage webhooks

Top-level commands

version, auth, account, agents, ai, api-keys, browser, browsers, conversations, drains, events, files, help, locations, notification-recipients, proxies, runs, sandboxes, secrets, spaces, subaccounts, tasks, tool-calls, tools, traces, usage, views, webhooks