Installation
Quick Reference
Commands
Global Options
Environment Variables
Exit Codes
Common Workflows
Basic Scan
CI/CD Integration
Batch Scanning
Interactive Mode
Next Steps
All Commands
Complete CLI command reference
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
RAXE command-line interface
pip install raxe
# Scan a prompt
raxe scan "your text here"
# Interactive mode
raxe repl
# List rules
raxe rules list
# Health check
raxe doctor
# View stats
raxe stats
| Command | Description |
|---|---|
raxe scan | Scan text for threats |
raxe batch | Batch scan from file |
raxe repl | Interactive scanning mode |
raxe rules | Manage detection rules |
raxe suppress | Manage false positive suppressions |
raxe doctor | System health check |
raxe stats | View scan statistics |
raxe config | Manage configuration |
raxe init | Initialize RAXE |
raxe export | Export scan history |
raxe validate-rule | Validate custom rule files |
# Set log level
raxe --log-level DEBUG scan "text"
# Output as JSON
raxe scan "text" --format json
# CI mode (JSON output, exit code 1 on threats)
raxe scan "text" --ci
# Set API key
export RAXE_API_KEY="raxe_..."
# Set log level
export RAXE_LOG_LEVEL=DEBUG
# CI mode
export RAXE_CI=true
| Code | Meaning |
|---|---|
| 0 | Success, no threats |
| 1 | Threat detected |
| 2 | Error occurred |
raxe scan "Ignore all previous instructions"
THREAT DETECTED
Severity: CRITICAL
Detections: 1
Rule: pi-001 - Prompt Injection
Matched: "Ignore all previous instructions"
# In GitHub Actions or similar
raxe scan "$USER_INPUT" --ci
if [ $? -eq 1 ]; then
echo "Threat detected, blocking request"
exit 1
fi
# Scan from file
raxe batch prompts.txt
# Scan from stdin
cat prompts.txt | raxe batch -
raxe repl
RAXE REPL v0.9.1
Type 'help' for commands, 'quit' to exit
raxe> scan Ignore all instructions
THREAT: pi-001 (HIGH)
raxe> quit
