CLI and agent skills

The Guardix CLI (guardix) connects your terminal — or a coding agent — to the same audits and findings you see in the web app. Guardix also ships agent skills that teach tools like Claude Code how to read results, start audits, and compare reports from multiple providers.

Install the CLI

macOS and Linux (recommended)

curl -fsSL https://github.com/guardixdev/guardix/releases/latest/download/install.sh | sh

The installer picks the right binary, verifies checksums, and places guardix on your PATH (typically /usr/local/bin or ~/.local/bin).

Pin a version or custom install directory:

curl -fsSL https://github.com/guardixdev/guardix/releases/latest/download/install.sh | GUARDIX_VERSION=v0.2.0 sh
curl -fsSL https://github.com/guardixdev/guardix/releases/latest/download/install.sh | GUARDIX_INSTALL_DIR="$HOME/bin" sh

Manual download

Download a release archive from github.com/guardixdev/guardix/releases, extract, and add the guardix binary to your PATH.

Verify

guardix --version
guardix doctor

Authenticate

Browser pairing (interactive)

guardix auth login

The CLI prints a URL (for example https://guardix.io/cli/auth?s=…) and opens your browser. Sign in with GitHub or Google if needed, approve the pairing, and the CLI stores a key locally. Revoke CLI keys anytime under User menu → API keys in the app.

API key (automation / CI)

guardix auth login --api-key gdx_ak_...

Or set GUARDIX_API_KEY in the environment. See API keys for creating keys in the dashboard.

Check status:

guardix auth status

Everyday commands

Inside a connected git checkout, many commands infer the repository from git remote:

guardix status                    # latest audit summary + open findings
guardix finding list              # findings for the latest audit
guardix finding get VAU-3         # one finding by short code
guardix audit start --ref main    # start a full audit
guardix audit wait --audit '#2'   # block until completion (CI-friendly)

Add --json for machine-readable output. Run guardix manifest --quiet for the full command surface — do not guess flag names.

Useful audit flags mirror the web wizard: --contract (repeatable scope), --doc-url, --doc-text, --doc-file, and --include-repo-docs.

Agent skills (Claude Code plugin)

The Guardix CLI plugin bundles three skills for coding agents:

Skill	Use when
`guardix`	Reading audit results — status, findings, finding codes like `VAU-3`, review state.
`running-audits`	Starting and monitoring audits (`audit start`, `wait`, `get`, `logs`).
`cross-audit-triage`	Comparing findings from multiple sources (Guardix + external firm reports or tool output), correlating duplicates, and adjudicating true vs false positives locally.

Install the plugin

From Claude Code:

/plugin marketplace add guardixdev/guardix
/plugin install guardix-cli@guardix

Skills live in the plugin package; each skill file describes when the agent should invoke it and which CLI commands to run. Agents should prefer guardix manifest over inventing flags.

Cross-audit triage

The cross-audit-triage skill expects report files plus a checkout of the audited commit on disk so findings can be validated against real source. It produces a comparison matrix and optional cross-audit-triage.json artifact. You can sync adjudications back with guardix finding review when ready.

Team context

guardix team list
guardix team switch <team-slug>

The active team filters which repositories and audits are visible — match the workspace you use in the browser.

API keys — Bearer tokens for HTTP and CI
Authentication — web sign-in
Your first audit — browser-first walkthrough