Quick Start

This guide assumes you already ran pip install ranex.

1. Go to your project

Run Ranex inside the root of the Python project you want to analyze.

2. Initialize Ranex config (Firewall)

This creates a default firewall policy file at:

• .ranex/firewall.yaml

Command:

ranex init

If the file already exists, use:

ranex init --force

3. Build an Atlas index

Command:

ranex atlas scan

Expected output includes:

• artifacts_found=...
• files_scanned=...

4. Search your codebase

ranex atlas search "payment"

Add JSON output:

ranex atlas search "payment" --json

Limit results:

ranex atlas search "payment" --limit 20

5. Check import safety (Dependency Firewall)

Single import:

ranex firewall check-import requests

Analyze a file:

ranex firewall analyze-file path/to/file.py

6. Optional: FastAPI scaling analysis

If the project is a FastAPI app, you can run:

ranex atlas fastapi-scaling-policy --json
ranex atlas fastapi-scaling-report --json

To customize the checks, create:

• .ranex/fastapi_scaling.yaml

7. Ignore directories/files you don't want indexed

Create a .ranexignore file in your project root. Ranex will respect it during scans.

Example entries:

tests/
migrations/
scripts/