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]
SubcommandWhat it does
summaryCompact status across every audit section.
bundleFull redacted support/compliance bundle with Audit v2 operator signals.
diffCompare two Audit Bundle v2 snapshots.
cliCommand manifest and shell completion surface.
pluginsPlugin doctor and installed plugin inventory.
safetyRisk, safety, alerts, and secret health.
dataData doctor, Reconcile v2 summary, and data inventory.
opsDaemon, jobs, reports, and maintenance state.
FlagWhat it does
--out PATHbundle only: write the full JSON bundle to a file.
--no-redactbundle only: keep raw command output fields. Redaction is enabled by default.
--before PATHdiff only: previous Audit Bundle JSON.
--after PATHdiff 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:

FieldMeaning
versionBundle schema version. Audit Bundle v2 uses 2.
redactedWhether secret-like fields were redacted. Default is true.
operatorCompact operator metrics: repair actions, kill-switch status, data failures, triggered alerts, and job health.
sectionsThe classic audit sections and classified checks.
supportExpanded 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:

AreaCompared values
OperatorRepair actions, executable/blocked repairs, kill-switch, data failures, triggered alerts, failed/running jobs.
ChecksNew, resolved, and changed warning/error checks across classic sections and support groups.
ReconcileChanged Reconcile v2 signals.
Data DoctorChanged, new, and resolved Data Ops checks.
PluginsAdded, removed, or status-changed plugins.
JobsAdded, removed, or status-changed jobs.

Sections#

The audit command intentionally shells out to the same CLI commands plugins and scripts already use:

SectionSource commands
clicommands list, completion bash, completion zsh, completion fish
pluginsplugin doctor, plugin list
safetyrisk summary, safety audit, alerts check, secrets doctor
datadata doctor, reconcile summary, data status
opsdaemon 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.