| description |
Every bxp-cli command-line flag, its argument and what it does. |
All flags are optional. Without arguments, bxp-cli reads bxp-cli.json from the current directory.
| Flag |
Argument |
Description |
--config |
<path> |
load custom config instead of default bxp-cli.json |
--template |
<id> |
choose single template |
--data |
<path> |
override templates's data_dir (requires --template) |
--fresh |
|
skip files whose output already exists (atomic O_EXCL) |
--dry-run |
|
run the pipeline in memory without writing output files (preview / validation); independent of --trace |
--trace |
|
emit the binary BXTB trace stream on stdout, consumed by bxp-gui's dry-run debugger (forces --quiet; conflicts with --debug) |
--trace-file |
<path> |
write a full binary trace (every row, every event) to <path>; independent of --trace; useful for offline GUI drill-down |
--debug |
|
prints rows that match no rule as JSON on stdout when row_rules_debug_missing is set (conflicts with --quiet and --trace) |
--debug=json |
|
emit ONE machine-readable JSON run summary on stdout (per-template + overall counts, captured warnings/errors) instead of human stdout+stderr output; conflicts with --trace/--quiet/--debug |
--quiet |
|
suppress the informational stdout summaries (errors still go to stderr; the exit code still reflects the result) |
--check-fs |
<n> |
opt-in: validate data_dir + input-file existence before any processing, with N-second total timeout (e.g. --check-fs 5). Default off. |
--version |
|
print version and exit |
--help |
|
print this help and exit |