Skip to main content

CLI reference

Every flag brs replay accepts, and the exit codes a CI pipeline can key off.

Usage

Terminal
brs replay --tsdb <path> --rules <path> [--alertmanager <path>]
brs replay --datadog <path>

Flags

FlagVendorMeaning
--tsdb <path>PrometheusA TSDB snapshot: a directory holding snapshot.json, or the file itself.
--rules <path>PrometheusA Prometheus rules.yml — recording and alerting rules.
--alertmanager <path>PrometheusAn Alertmanager config. Optional — omitted means empty routing and no inhibits.
--datadog <path>DatadogOne export bundle: monitors and metric series together. Cannot combine with the Prometheus flags — a scenario comes from one vendor.

Exit codes

CodeMeaning
0No critical root-cause finding.
1A critical alert has a root-cause failure, or the inputs could not be read.
2Invalid command-line usage.

Global flags

-h / --help and -v / --version are checked before any command is dispatched, anywhere in the argument list — so brs replay --help prints usage and exits 0 without touching a scenario on disk.