Skip to main content

Requirements

  • Python 3.10 or higher
  • pip or uv package manager

Standard Installation

pip install raxe

Optional Features

Install with additional capabilities:
# ML detection support (L2 classifier)
pip install raxe[ml]

# LLM client wrappers (OpenAI, Anthropic)
pip install raxe[wrappers]

# Interactive REPL mode
pip install raxe[repl]

# Everything
pip install raxe[all]

Initialize RAXE

After installation, initialize the configuration:
raxe init
This creates:
  • ~/.raxe/config.yaml - Configuration file
  • ~/.raxe/raxe.db - Local scan history database

Verify Installation

Run the health check:
raxe doctor
Expected output:
 Configuration file exists
 Rules loaded successfully (460 rules)
 Database initialized
 ML model available
 System ready

Troubleshooting

Add the Python scripts directory to your PATH:
export PATH="$HOME/.local/bin:$PATH"
Install the ML dependencies:
pip install raxe[ml]
Run initialization:
raxe init

Next Steps

Configuration

Configure RAXE for your use case