Documentation Index
Fetch the complete documentation index at: https://developer.bron.org/llms.txt
Use this file to discover all available pages before exploring further.
bron is the public command-line client for the Bron API. A single static binary, regenerated from the OpenAPI spec on every API release — every endpoint and every request/response field reachable from the shell, 1:1 with the spec.
The CLI is designed to be a first-class surface for both humans and LLM agents:
- Every command speaks both
--help(humans) and--schema(machines). - Stable exit codes, structured error output with a trace ID on every 4xx/5xx.
- JSON / YAML / JSONL / table output, projected with
--columnsor filtered with--query. - Profiles for multi-workspace setups, env-var overrides for CI, HTTP/HTTPS proxy support.
- Live updates over WebSocket via
bron tx subscribe— same filters asbron tx list, server replays the snapshot then streams forever with transparent auto-reconnect.
Install
darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-amd64.exe. Every release ships SHA256 checksums on the releases page.
Quickstart
How commands are shaped
Every endpoint in the OpenAPI spec becomes a command:<resource>— first URL segment, lowercased and shortened where useful (txfortransactions,address-bookforaddress-book-records, etc.)<verb>— remaining path segments verbatim (list,get,create,accept-deposit-offer,create-signing-request, …){workspaceId}is implicit (from the active profile or--workspace); other path params are positional in URL order.- Query parameters become
--<name>flags; body fields become--<field>/--<a>.<b>flags.
Special case: bron tx <type>
bron tx withdrawal, bron tx allowance, bron tx stake-delegation, and other type-specific subcommands are shortcuts for bron tx create --transactionType <type>, with the type-specific body fields exposed as --params.<field>. Per-type --help shows exactly which params each transaction shape expects.
bron tx --help.
Common commands
Where to next
Authentication & profiles
Keypair lifecycle, multiple profiles, env-var overrides, proxy setup, rotation.
Output & schema
json / yaml / jsonl / table, --columns, --query, --schema, --embed, working with jq.Live updates (`tx subscribe`)
Filters, snapshot semantics, auto-reconnect contract,
--debug, JSONL piping recipes.Cookbook
Five real-world flows: bulk approvals, deposit watcher, treasury rebalance, audit export, agent automation.
LLM agent integration
Discovery via
--schema, prompts, exit-code-driven flows, idempotency, dry-runs.Errors & exit codes
Mapping HTTP → exit, error envelope shape, correlation IDs, retry strategy.
