Output formats
Pick a structured output mode for scripting, or stick with the colored default for terminals.
Modes
$ beam --format <mode> ...
| Mode | When to use |
|---|---|
default |
Interactive terminal use. Color, spinners, friendly errors. |
json |
Scripting, agent loops, anything piped into jq. |
yaml |
Same data as JSON, YAML-encoded. |
markdown |
Markdown table output for some commands. |
compact |
Single-line, minimal text. |
quiet |
Print only the essential value — e.g. just a tx hash. Ideal for shell pipelines. |
Examples
$ beam --format json balance
$ beam --format yaml chains list
$ beam --format markdown privacy incoming list
$ beam --format quiet transfer alice.eth 0.01
$ beam --format compact txn 0xabc...
Side effects on other output
- In
defaultmode, RPC-backed commands show a loader spinner while requests are in flight. PressCtrl-Cduring a read-only RPC loader to cancel the in-flight request. - Non-interactive update notices are only printed in
defaultoutput mode and use the cached update status instead of waiting on GitHub. - Successful write commands print the confirmed transaction hash and block in every mode so you can verify the result immediately. Interrupted waits print the submitted hash regardless of mode.
Color
$ beam --color auto # default
$ beam --color always
$ beam --color never
Beam writes color codes when the destination is a terminal. Override the heuristic with --color.
In the REPL, the chain segment of the prompt is tinted per network brand in color-capable terminals — Payy networks use #E0FF32.