Public beta — not for production use. Data may be wiped at any time. Questions? Contact us.
Documentation menu

axiom doctor

Check the local toolchain needed to build and test Axiom packages

View as Markdown
<!-- GENERATED by docs/scripts/gen-cli-reference — DO NOT EDIT. Source of truth: the cobra command definitions in cmd/axiom/cmd/. Regenerate from the repo root with: go run ./docs/scripts/gen-cli-reference -->

axiom doctor

Check the local toolchain needed to build and test Axiom packages

Check the local toolchain needed to build and test Axiom packages.

Inside an Axiom package directory, checks the requirements for that package's language and exits non-zero if anything is missing. Outside a package, surveys all supported languages (informational; always exits zero).

With --fix, runs the missing project-local installs for the package language: go mod download, go install of protoc plugins (to GOBIN), npm install in the project, or pip install -r requirements.txt into an ACTIVE virtualenv. System tools such as protoc and language runtimes are only advised — axiom never invokes a system package manager (apt, brew, …) and never escalates privileges.

Usage

axiom doctor [flags]

Flags

FlagShorthandTypeDefaultDescription
--fixboolRun missing project-local installs (never system package managers)
--help-hboolhelp for doctor

See also

  • axiom — Axiom CLI — build and push node packages
Related