Skip to content

Workspace Diagnostics and Support Bundles

Manit Arora edited this page Oct 21, 2026 · 1 revision

Workspace Diagnostics and Support Bundles

AXIOM's CLI and Control Center share read-only workspace checks. The goal is to surface actionable environment problems without silently rewriting a project.

Commands

axiom doctor
axiom doctor --json
axiom status --json
axiom roadmap audit
axiom roadmap audit --json
axiom support-bundle --output ./axiom-support-bundle.zip
axiom support-bundle --output ./axiom-support-bundle.zip --force --json

Use --force only when intentionally replacing an existing output file. Without it, the CLI refuses to overwrite the existing output. Output symlinks are rejected.

What the doctor checks

The workspace checks cover:

  • workspace discovery and basic workspace readiness;
  • axiom.yaml parsing;
  • unsafe symlink entries;
  • filesystem read/write access;
  • free disk space;
  • Python compatibility;
  • required Python package imports.

Results use stable identifiers so the GUI, scripts, and tests can interpret them without parsing human prose. Diagnostic output is a report, not an automatic repair operation.

Set AXIOM_WORKSPACE=/path/to/project to select a workspace. --workspace explicitly overrides it for doctor and support-bundle. Otherwise, discovery selects the nearest parent containing a regular axiom.yaml, then falls back to the current directory. Caller-provided workspace symlinks are rejected.

Roadmap audit

The audit reads the scoped 120-item section in ROADMAP.md. It checks R001–R120 coverage and reports duplicate IDs, missing IDs, unexpected IDs, and unknown statuses. It reports recorded status labels; it does not infer completion from source-file existence or update the roadmap automatically.

Only update a roadmap item after the corresponding implementation, UI/CLI/API behavior, regression tests, documentation, and applicable platform checks have been verified in a real checkout.

Support-bundle contents

The generated ZIP is documented to contain only:

  • diagnostics.json;
  • environment.json;
  • a static README.txt.

It excludes configuration file contents, environment-variable values, credentials, full/absolute paths, model weights, datasets, logs, experiment records, and user-authored data. It may include aggregate check results, application/Python versions, OS family, and required dependency versions.

This is a minimization measure, not a guarantee that every metadata combination is anonymous. Open and inspect the archive before sharing it. Redact or remove anything inappropriate for the target issue or recipient.

Bundle generation does not write diagnostic output into the workspace. The HTTP download endpoint uses Cache-Control: no-store, a fixed download name, and X-Content-Type-Options: nosniff.

When filing a bug

Include the AXIOM version, operating system, Python version, the exact command or GUI path, and a small reproducible example. Share the relevant diagnostic check IDs and sanitized output. Never include API-key values, passwords, private data rows, proprietary model weights, or an unreviewed support ZIP.

Related pages: Troubleshooting, Local API and Security, beta.4 release notes.

Clone this wiki locally