MarketDeck docs
audit
Top-level CLI, plugin, safety, data, and ops audit bundle.
marketdeck audit is the top-level diagnostics and compliance surface. It does not implement new business logic. It orchestrates existing commands with --format json and turns their results into one machine-readable status shape for terminal users, WebUI, GNOME, and support bundles.
Usage#
marketdeck audit <summary|bundle|diff|cli|plugins|safety|data|ops> [flags]
| Subcommand | What it does |
|---|---|
summary | Compact status across every audit section. |
bundle | Full redacted support/compliance bundle with Audit v2 operator signals. |
diff | Compare two Audit Bundle v2 snapshots. |
cli | Command manifest and shell completion surface. |
plugins | Plugin doctor and installed plugin inventory. |
safety | Risk, safety, alerts, and secret health. |
data | Data doctor, Reconcile v2 summary, and data inventory. |
ops | Daemon, jobs, reports, and maintenance state. |
| Flag | What it does |
|---|---|
--out PATH | bundle only: write the full JSON bundle to a file. |
--no-redact | bundle only: keep raw command output fields. Redaction is enabled by default. |
--before PATH | diff only: previous Audit Bundle JSON. |
--after PATH | diff only: later Audit Bundle JSON. |
Examples#
marketdeck audit summary --format json
marketdeck audit cli
marketdeck audit safety --format json
marketdeck audit bundle --out audit.json
marketdeck audit diff --before before.json --after after.json
Audit Bundle V2#
audit bundle writes a versioned support bundle:
| Field | Meaning |
|---|---|
version | Bundle schema version. Audit Bundle v2 uses 2. |
redacted | Whether secret-like fields were redacted. Default is true. |
operator | Compact operator metrics: repair actions, kill-switch status, data failures, triggered alerts, and job health. |
sections | The classic audit sections and classified checks. |
support | Expanded grouped checks for Reconcile, Data Ops, Risk v2, Alerts, Jobs, Reports, Plugins, CLI, and Daemon. |
Redaction removes secret-like fields such as tokens, private keys, API keys, passwords, seeds, signatures, and mnemonics from the bundle.
Audit Diff#
audit diff compares two bundle files and reports:
| Area | Compared values |
|---|---|
| Operator | Repair actions, executable/blocked repairs, kill-switch, data failures, triggered alerts, failed/running jobs. |
| Checks | New, resolved, and changed warning/error checks across classic sections and support groups. |
| Reconcile | Changed Reconcile v2 signals. |
| Data Doctor | Changed, new, and resolved Data Ops checks. |
| Plugins | Added, removed, or status-changed plugins. |
| Jobs | Added, removed, or status-changed jobs. |
Sections#
The audit command intentionally shells out to the same CLI commands plugins and scripts already use:
| Section | Source commands |
|---|---|
cli | commands list, completion bash, completion zsh, completion fish |
plugins | plugin doctor, plugin list |
safety | risk summary, safety audit, alerts check, secrets doctor |
data | data doctor, reconcile summary, data status |
ops | daemon status, jobs list, reports schedule, maintenance status |
reconcile summary contributes Reconcile v2 consistency signals, including Data Ops warnings/failures and Risk v2 kill-switch status. audit summary also surfaces Audit v2 operator metrics: repair actions, executable and blocked repairs, triggered alerts, failed jobs, and kill-switch state. summary.ok is false only when at least one section has an error. Warnings remain visible but do not make the overall audit fail.