Download

Help

User Guide

Install quickly, confirm expected CLI output, then use targeted troubleshooting when a run does not behave as expected.

Download and install the Linux CLI

Use the official installer first. This handles package placement and command registration for your shell.

CLI input

curl -sSL https://auditwalk.com/install.sh | sudo bash
  1. Open a terminal as a user with sudo access.
  2. Run the installer command above once.
  3. Wait for the install summary before closing the terminal.

Expected output cues

[OK] auditwalk binary installed
[OK] shell path updated
[DONE] installation complete

Activate your Pro license (Pro only — skip if using Free)

Your license key is in your purchase confirmation email. Activate it once on this machine before running Pro commands.

CLI input

auditwalk license activate AW-XXXXX-XXXXX-XXXXX-XXXXX
  1. Copy your key exactly from the purchase email — do not retype.
  2. Run the command above, replacing the placeholder with your actual key.
  3. Confirm the success message before continuing.

Expected output cues

License activated.
Plan: Pro
Expires: YYYY-MM-DD

Key not in your email? Contact help@auditwalk.com with your purchase reference and we'll resend it.

Verify command access and run preflight

Confirm the CLI is visible in your current shell, then run the first readiness check.

CLI input

auditwalk --version
auditwalk preflight
  1. Run auditwalk --version and confirm auditwalk 0.1.3 prints.
  2. Run auditwalk preflight to create the first readiness report.
  3. Confirm the output includes a verdict and next steps.

Expected output cues

auditwalk 0.1.3
AuditWalk PreFlight
Verdict: PASS

Run your first scan and confirm what success looks like

After preflight, run a scan so AuditWalk writes a concrete artifact for review.

CLI input

auditwalk scan
auditwalk status

Expected output cues

AuditWalk Scan
Scan ID: scan_...
Files: ... (...%)
AuditWalk Status

Confirm license status

Use the license status command after activation to confirm the CLI sees the expected plan.

CLI input

auditwalk license status

Expected output cues

AuditWalk License
Plan: Pro
Status: active

Need more detail?

Use diagnostics when support asks for environment details or when output does not match this guide.

CLI input

auditwalk doctor
auditwalk status

Troubleshooting

Open the issue that matches what you are seeing. Each section includes a problem description and concrete best-practice checks.

Not scanning the right directory

Problem: Compare results look incomplete or unrelated because the initial baseline/scan was run in the wrong path.

Best-practice example

pwd
auditwalk scan --profile forensic_local
  • Confirm directory with pwd before any scan command.
  • Use an explicit profile so the scan scope is reproducible.
  • Save the scan ID printed by the command for support or follow-up checks.
Compare command is missing the baseline ID

Problem: Compare requires a baseline ID. If it is missing or incorrect, the command cannot resolve the target reference state.

Best-practice example

auditwalk status
auditwalk compare <baseline_id>
  • Run auditwalk status first and confirm which trusted snapshot is available.
  • Pass the baseline ID as the positional argument to auditwalk compare.
  • Use auditwalk compare --help if you need JSON output or a specific scan ID.
Preflight or scan output is unclear

Problem: The CLI produced output, but you are not sure what to do next.

Best-practice example

auditwalk preflight
auditwalk doctor
auditwalk status
  • Read the Verdict and Next steps lines from preflight first.
  • Use auditwalk doctor when support needs environment details.
  • Email support with the report path printed by the CLI if the next step is still unclear.
Troubleshooting Support CLI Guide Terms of Use Privacy Policy
Troubleshoot Contact Support Browse Docs