Configuration Reference

Ranex is designed to work with minimal configuration.

Project directory

Ranex stores project-local state under:

• .ranex/

Typical files:

• .ranex/atlas.sqlite (Atlas index database)
• .ranex/firewall.yaml (Dependency Firewall policy)
• .ranex/fastapi_scaling.yaml (FastAPI scaling policy; optional)
• .ranex/config.toml (Ranex config; optional)

Ignore file

Ranex also supports a project-root ignore file:

• .ranexignore

This is used to exclude files/directories from scanning.

.ranex/config.toml

If present, Ranex reads settings from .ranex/config.toml. If missing, defaults are used.

Sections

[atlas]

• ignore_patterns (list of glob-ish patterns)
• max_file_size (bytes)
• parallel_workers
• db_filename (stored under .ranex/)
• incremental (configuration knob; current releases may still perform a full re-scan)
• extract_docstrings
• detect_endpoints
• detect_contracts
• auto_scan_on_first_search
• track_git_commit

[security]

Controls which files are allowed/denied for indexing/reading. Useful when you run Ranex via an AI assistant to prevent accidentally exposing secrets.

[logging]

• level and format

[firewall]

High-level toggles for firewall behavior.

[governance]

Fail-closed controls for automation.

.ranex/firewall.yaml

Created by ranex init.

This YAML policy controls:

• Allowed third-party packages
• Blocked patterns
• Typosquatting detection
• Which internal import prefixes should be treated as "your code"

See Dependency Firewall for details.

.ranex/fastapi_scaling.yaml

Optional.

If present, it customizes FastAPI scaling analysis.

See FastAPI Scaling Analysis for details.

Environment variables

• RANEX_PROJECT_ROOT
  • Used by ranex-mcp-server to select which project it analyzes.
• RANEX_LOG
  • Used by ranex-mcp-server to set log level.