Skip to main content

raxe scan

Scan text for threats.
raxe scan "text to scan"

Options

OptionDescription
--formatOutput format: text, json
--ciCI mode (JSON + exit code 1 on threats)
--explainShow detailed explanations
--ruleTest specific rule only

Examples

# Basic scan
raxe scan "Ignore all previous instructions"

# JSON output
raxe scan "text" --format json

# CI mode
raxe scan "text" --ci

# With explanations
raxe scan "text" --explain

raxe batch

Scan multiple prompts from file.
raxe batch prompts.txt

Options

OptionDescription
--formatOutput format: text, json, csv
--outputWrite results to file

Examples

# Scan from file
raxe batch prompts.txt

# Output to JSON file
raxe batch prompts.txt --format json --output results.json

# From stdin
cat prompts.txt | raxe batch -

raxe repl

Interactive scanning mode.
raxe repl

REPL Commands

CommandDescription
scan <text>Scan text
rulesList loaded rules
statsShow session stats
clearClear screen
helpShow help
quitExit REPL

raxe rules

Manage detection rules.
raxe rules list
raxe rules show <rule-id>

Subcommands

CommandDescription
listList all rules
show <id>Show rule details
search <query>Search rules

Examples

# List all rules
raxe rules list

# Filter by family
raxe rules list --family PI

# Show specific rule
raxe rules show pi-001

# Search rules
raxe rules search "injection"

raxe doctor

System health check.
raxe doctor

Output

RAXE Health Check

 Configuration file exists
 Rules loaded successfully (460 rules)
 Database initialized
 ML model available
 Telemetry endpoint reachable

System ready!

raxe stats

View scan statistics.
raxe stats

Options

OptionDescription
--periodTime period: today, week, month, all

Output

RAXE Statistics (This Week)

Scans: 1,234
Threats Detected: 56
Detection Rate: 4.5%

Top Rules:
  1. pi-001 (23 detections)
  2. jb-003 (12 detections)
  3. pii-042 (8 detections)

raxe config

Manage configuration.
raxe config show
raxe config set <key> <value>

Subcommands

CommandDescription
showShow current config
set <key> <value>Set config value
resetReset to defaults

Examples

# Show config
raxe config show

# Set log level
raxe config set log_level DEBUG

# Reset config
raxe config reset

raxe init

Initialize RAXE configuration.
raxe init
Creates:
  • ~/.raxe/config.yaml
  • ~/.raxe/raxe.db

raxe export

Export scan history.
raxe export --format json --output history.json

Options

OptionDescription
--formatOutput format: json, csv
--outputOutput file path
--sinceExport from date

raxe validate-rule

Validate a custom rule file.
raxe validate-rule path/to/rule.yaml

Output

Validating rule.yaml...

 YAML syntax valid
 Schema compliance OK
 Pattern compiles successfully
 No catastrophic backtracking
 Examples pass

Rule is valid!