Docs · CLI

AuditWalk CLI Documentation

Use this map to get productive quickly. Start with the workflow guide, jump to exact syntax when needed, and keep runtime terms one click away.

CLI Guide — Start Here

Quick Operator Flow

Run this sequence for a first pass from scan to drift review.

auditwalk scan run --profile full
auditwalk baseline set --scan-id <scan_id>
auditwalk preflight run
auditwalk compare run

CLI Guide — Start Here

Operator-first walkthrough for first run, baseline, preflight, compare, and doctor.

Open CLI Guide

CLI Reference — Exact Syntax

Exact CLI syntax, canonical forms, and aliases with copy/paste-ready command patterns.

Open CLI Reference

CLI Glossary — Runtime Terms

Lookup runtime terms used in commands, events, and output. Live terminology only.

Open CLI Glossary
Need future vocabulary status?
CLI Reserve Report Doc Issue

Which page should I use?

  • Learning the workflow from scratch: CLI Guide
  • Looking up exact syntax now: CLI Reference
  • Clarifying term meaning: CLI Glossary
  • Checking future vocabulary status: CLI Reserve

Documentation rules

  • CLI Reference is implemented-only and strict.
  • Glossary defines language; it does not redefine command behavior.
  • CLI Reserve is non-runtime and not current behavior.

Reference note: command reference content should be sourced from implemented runtime behavior (registry + rewrite normalization), not speculative future surface.

  1. Start with the CLI Guide for sequence and intent.
  2. Use the CLI Reference during command execution.
  3. Use the Glossary when terminology is unclear.
  4. Use CLI Reserve to separate future language from live runtime behavior.