AXguard quickstart

Get from zero to a full audit in a few minutes.

Prerequisites

Python 3.10+
git
A repository you are authorized to scan

Steps

Clone and install the plugin

git clone https://github.com/Awarexone/AXguard.git
cd AXguard
chmod +x install.sh uninstall.sh
./install.sh                      # or: ./install.sh --agent all

Install the CLI

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

axguard help

Run an audit

On this repo (or point at your app):

axguard audit .

Or try the bundled vulnerable app:

axguard scan fixtures/vuln_app
axguard audit fixtures/vuln_app --no-banner

Open the report

Full audits write:

.findings/axguard/axguard-report.html
.findings/axguard/axguard-report.md
.findings/axguard/axguard-report.json

Open the HTML report in a browser. Analysis is read-only: no source mutation and no outbound requests from the report.

Fast path while coding

axguard scan .                 # quick findings, no full report suite

Gate a release

axguard audit . --fail-on high --no-banner

Exit 1 when anything at or above the threshold is found. See CI / CD.

Goal	Page
Wire an AI agent	AI agents · skill `axguard-security`
Understand findings	Evidence · Judge · Adversary
Full command list	CLI

Get started

Understand

Analyze

Investigate

AI agents

Ship

Help

Prerequisites

Steps

Fast path while coding

Gate a release

Next

​Prerequisites

​Steps

​Fast path while coding

​Gate a release

​Next

Prerequisites

Steps

Fast path while coding

Gate a release

Next