Download

Docs · CLI Reference

CLI Command Reference

Exact syntax for currently implemented AuditWalk CLI commands. Canonical forms appear first; compatibility aliases and default rewrites are shown where relevant.

CLI Guide

Workflow learning, first-run setup, and operator sequence.

Open CLI Guide

Use Cases

Scenario-driven workflows for baseline, compare, and follow-through.

Open Use Cases

Quick operator flow

auditwalk scan run --profile full
auditwalk baseline confirm <scan_id>
auditwalk preflight run
auditwalk compare run --format json
auditwalk doctor run --format json

Note: doctor run is a licensed extension.

  • Implemented commands only; planned and reserved vocabulary is excluded.
  • Availability markers: FreePaidPaid · v0.2
  • watch config is nested and requires <action:show|set>.
  • Canonical baseline promotion command: auditwalk baseline confirm <scan_id>; auditwalk baseline set --scan-id <scan_id> is a compatibility alias.
  • Initialization rewrite: auditwalk init resolves to auditwalk init run.

scan

CommandCanonicalTierNotes
auditwalk scan runauditwalk scan runFreePrimary scan execution command.
auditwalk scan quickauditwalk scan run --profile quickFreeAlias profile form.
auditwalk scan fullauditwalk scan run --profile fullFreeAlias profile form.
auditwalk scan paranoidauditwalk scan run --profile paranoidFreeAlias profile form.

baseline

CommandCanonicalTierNotes
auditwalk baseline confirm <scan_id>auditwalk baseline confirm <scan_id>FreeCanonical trusted baseline promotion command.
auditwalk baseline set --scan-id <scan_id>auditwalk baseline confirm <scan_id>FreeCompatibility alias for baseline confirm.
auditwalk baseline review <scan_id>auditwalk baseline review <scan_id>FreeReview baseline candidate details.
auditwalk baseline showauditwalk baseline showFreeShow active baseline.
auditwalk baseline lastauditwalk baseline showFreeAlias of show.
auditwalk baseline historyauditwalk baseline historyFreeShow baseline history.
auditwalk baseline exportauditwalk baseline exportFreeExport baseline data.
auditwalk baseline reportauditwalk baseline reportFreeRender baseline report output.

preflight

CommandCanonicalTierNotes
auditwalk preflight runauditwalk preflight runFreeDefault rewrite: auditwalk preflight -> run.
auditwalk preflight showauditwalk preflight showFreeShow latest preflight result.
auditwalk preflight lastauditwalk preflight showFreeAlias of show.
auditwalk preflight exportauditwalk preflight exportFreeExport preflight result.
auditwalk preflight reportauditwalk preflight reportFreeRender report output.
auditwalk preflight initauditwalk preflight initFreeInitialize preflight context.

compare + doctor

CommandCanonicalTierNotes
auditwalk compare runauditwalk compare runFreeDefault rewrite: auditwalk compare -> run.
auditwalk compare showauditwalk compare showFreeShow latest compare output.
auditwalk compare lastauditwalk compare showFreeAlias of show.
auditwalk compare exportauditwalk compare exportFreeExport compare output.
auditwalk compare reportauditwalk compare reportFreeRender compare report.
auditwalk doctor runauditwalk doctor runPaidDefault rewrite: auditwalk doctor -> run.
auditwalk doctor showauditwalk doctor showPaidShow latest doctor output.
auditwalk doctor lastauditwalk doctor showPaidAlias of show.
auditwalk doctor exportauditwalk doctor exportPaidExport doctor output.
auditwalk doctor reportauditwalk doctor reportPaidRender doctor report output.

attention + report + status

CommandCanonicalTierNotes
auditwalk attention showauditwalk attention showPaidShow attention items.
auditwalk attention inspectauditwalk attention inspectPaidInspect specific attention finding.
auditwalk attention exportauditwalk attention exportPaidExport attention output.
auditwalk report showauditwalk report showFreeShow report summary.
auditwalk report exportauditwalk report exportFreeExport report artifact.
auditwalk report bundleauditwalk report bundleFreeCreate bundled report package.
auditwalk report renderauditwalk report renderFreeRender selected report format.
auditwalk status showauditwalk status showPaidPrimary status view.
auditwalk status exportauditwalk status exportPaidExport status output.
auditwalk status reportauditwalk status reportPaidRender status report.

watch + repair + retain

CommandCanonicalTierNotes
auditwalk watch runauditwalk watch runPaidForeground watch loop.
auditwalk watch startauditwalk watch startPaidBackground daemon start.
auditwalk watch stopauditwalk watch stopPaidDaemon stop.
auditwalk watch statusauditwalk watch statusPaidDaemon status query.
auditwalk watch config show|setauditwalk watch config <action>PaidNested command surface.
auditwalk repair showauditwalk repair showPaid · v0.2Show repair plan state.
auditwalk repair planauditwalk repair planPaid · v0.2Create repair plan artifact.
auditwalk repair applyauditwalk repair applyPaid · v0.2Apply plan (supports --dry-run).
auditwalk retain dry-runauditwalk retain dry-runPaidRetention simulation only.

diagnostic + init + license + trust

CommandCanonicalTierNotes
auditwalk diagnostic runauditwalk diagnostic runPaidDiagnostic execution surface.
auditwalk diagnostic reviewauditwalk diagnostic reviewPaidDiagnostic review output.
auditwalk diagnostic showauditwalk diagnostic showPaidShow diagnostic artifact.
auditwalk diagnostic listauditwalk diagnostic listPaidList diagnostic artifacts.
auditwalk diagnostic explainauditwalk diagnostic explainPaidExplain diagnostic finding.
auditwalk diagnostic repair-previewauditwalk diagnostic repair-previewPaidPreview repair from diagnostic.
auditwalk diagnostic repair-applyauditwalk diagnostic repair-applyPaidApply repair from diagnostic path.
auditwalk diagnostic restore-previewauditwalk diagnostic restore-previewPaidPreview restore path.
auditwalk diagnostic restore-applyauditwalk diagnostic restore-applyPaidApply restore path.
auditwalk diagnostic doctorauditwalk diagnostic doctorPaidDiagnostic-to-doctor bridge command.
auditwalk initauditwalk init runFreeDefault rewrite: auditwalk init -> auditwalk init run.
auditwalk init runauditwalk init runFreeInitialization command.
auditwalk license statusauditwalk license statusPaidLicense status output.
auditwalk trust statusauditwalk trust statusPaidTrust status output.