Skip to main content

Configuration File

RAXE uses YAML configuration at ~/.raxe/config.yaml:
# Detection settings
detection:
  l1_enabled: true      # Rule-based detection
  l2_enabled: true      # ML-based detection
  block_on_threat: false # Block threats (vs monitor)

# Telemetry (anonymous detection metadata)
telemetry:
  enabled: true         # Disabling requires Pro+ tier

# Performance
performance:
  mode: balanced        # fast | balanced | thorough

Environment Variables

Override any setting with environment variables:
# Detection
export RAXE_L1_ENABLED=true
export RAXE_L2_ENABLED=true

# Logging
export RAXE_LOG_LEVEL=INFO  # DEBUG, INFO, WARNING, ERROR

# Database
export RAXE_DB_PATH=~/.raxe/raxe.db

Programmatic Configuration

Configure via the SDK:
from raxe import Raxe

raxe = Raxe(
    l1_enabled=True,
    l2_enabled=True,
    log_level="DEBUG"
)

Performance Modes

ModeL1 RulesL2 MLLatencyUse Case
fastCore onlyOff~0.3msHigh-throughput APIs
balancedAllOn~2msGeneral use
thoroughAll + customOn~5msMaximum security
# Set via SDK
raxe = Raxe(performance_mode="fast")

# Or via config
# performance:
#   mode: fast

Telemetry

RAXE collects anonymous detection metadata to improve the engine: What we collect:
  • Detection counts and severity levels
  • Performance metrics (scan latency)
  • Rule IDs that triggered
  • SHA-256 hash of prompts (not reversible)
What we NEVER collect:
  • Raw prompts or responses
  • Matched text content
  • Personal information
  • Your API keys
Telemetry is enabled by default in Community Edition. Disabling telemetry requires a Pro+ tier license.

Next Steps