Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Install the AXguard CLI, agent plugin, MCP server, and optional local API (Python 3.10+).
git clone https://github.com/Awarexone/AXguard.git
cd AXguard
chmod +x install.sh uninstall.sh
./install.sh # Claude Code, global (~/.claude)
./install.sh --agent cursor # Cursor
./install.sh --agent opencode # OpenCode
./install.sh --agent codex # Codex
./install.sh --agent agents # shared Agent Skills (~/.agents)
./install.sh --agent all # every supported agent
./install.sh --agent claude --project # this repo only (./.claude)
--agent | Global destination | --project destination |
|---|---|---|
claude (default) | ~/.claude | .claude |
cursor | ~/.cursor | .cursor |
opencode | $OPENCODE_CONFIG_DIR or ~/.config/opencode | .opencode |
codex | $CODEX_HOME or ~/.codex | .codex |
agents | ~/.agents | .agents |
all | all of the above | all of the above |
--global is the default. The agents target installs skills only (no slash-command concept).
Uninstall with the same flags via ./uninstall.sh.
python3 -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e .
axguard help
axguard audit .
axguard version should print axguard 0.2.0.
pip install -e '.[mcp]' # MCP server for AI agents
pip install -e '.[api]' # local Security Intelligence API
pip install -e '.[dev]' # pytest, for contributing
pip install -e '.[mcp]'
axguard mcp doctor
axguard mcp serve
pip install -e '.[api]'
axguard api start
# → http://127.0.0.1:8787 · /openapi.json
axguard version
axguard help
axguard scan fixtures/vuln_app # bundled vulnerable app — expect findings