help Commands | BCTRL Docs

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.

Output formatting flags (--json, --jq, and --template) are documented once in Output Formatting and are omitted from the tables below.

`bctrl 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.

bctrl help [flags]

Flag	Description
`--query <json>`	Query object: inline JSON, @file, or - for stdin
`--params <json>`	Alias for —query
`--topic <value>`	Query parameter topic
`--audience <value>`	Query parameter audience
`--headers <json>`	API headers: inline JSON, @file, or - for stdin
`--api-version <date>`	Dated API contract (default: 2026-10-03)
`--space <id-or-name>`	Select an authorized Space (BCTRL-Space)
`--subaccount-id <id>`	Effective subaccount context (BCTRL-Subaccount-Id)