Quick Start

From zero to your first scan in 60 seconds.

1. Install

Terminal
$ pip install sarix

2. Set your API key — or skip it

Fastest path: sign in with GitHub at sarix.avixosec.xyz/account.html to get a 3-day Pro trial key that runs on built-in models, no API key required. Then activate the CLI:

Terminal
$ sarix login <key>

Prefer your own provider? Set a key instead:

Terminal
$ export OPENAI_API_KEY="sk-..."

Or run sarix config for an interactive setup.

3. Review a file

Terminal
$ sarix review src/main.py

Structured report with severity-tagged issues, line numbers, and fixes.

4. Run a security audit

Terminal
$ sarix security src/auth.py

Returns CWE IDs, OWASP categories, and remediation code for every finding.

5. Scan a whole project

Terminal
$ sarix scan . --task security

Scans every source file in the directory with a progress bar. Summary includes token count and total cost.

6. Try different providers

Terminal
$ sarix review file.py --provider anthropic
$ sarix review file.py --provider ollama       # offline, no data leaves your machine
$ sarix review file.py --provider openrouter   # custom label saved via `sarix config`

OpenAI-compatible endpoints (OpenRouter, Groq, Together, Mistral, xAI, Azure AI Foundry, and more) are set up via sarix config. Pick Custom in the wizard, choose a preset or enter a base URL, save under any label.

Next steps