Install, authenticate, and run Aevrin from your terminal.

Use this focused setup guide for the CLI and Claude Code hook. The complete documentation covers every scanner, target, dashboard workflow, usage event, report, API contract, and troubleshooting path.

Open complete documentation Contact support

CLI and CI

Commands, flags, JSON, exit codes, device login, and automation gates.

Coverage

What every scanner catches, what it skips, and how incomplete results behave.

Dashboard

History, usage, scan sources, findings, false positives, and exports.

API and hooks

Endpoint contracts, hook cache decisions, overrides, auth, and safe execution.

Install and verify

Set up Aevrin from a real terminal, not a marketing checklist.

Use the exact commands the current product supports. Device login is the default path for developers. API keys are for CI and other non-interactive automation.

macOS install

brew install pipx
pipx ensurepath
pipx install aevrin

Verify and sign in

aevrin --version
aevrin login

AI agent install prompt

Paste this into Claude Code or another agent when you want it to install the CLI for you.

Set up the Aevrin CLI on this machine and verify the installation end to end.

1. Detect the operating system and shell. Do not use sudo and do not modify the system Python.
2. Choose exactly one installation path. If Node.js 18+ and npm are already available, run: npm install --global aevrin. Otherwise use pipx and install it with the matching command:
   - macOS: brew install pipx && pipx ensurepath
   - Linux: python3 -m pip install --user pipx && python3 -m pipx ensurepath
   - Windows PowerShell: py -m pip install --user pipx; py -m pipx ensurepath
3. For pipx, install or upgrade Aevrin with: pipx install aevrin (use pipx upgrade aevrin if already installed). For npm, use: npm install --global aevrin@latest. Do not install both variants in the same run.
4. Run: aevrin --version
5. Run: aevrin login
6. Pause while I approve the browser device-login page. Never ask me to paste a password, API key, or browser token into the terminal.
7. After approval, show me how to run a local check with: aevrin scan . --no-upload --fail-on high

Report every command you executed and its result. If a command fails, stop at that command, preserve the full non-secret error, and explain the smallest corrective action.

AI agent hook prompt

Paste this into Claude Code when you want the MCP pre-install hook configured in a project.

Configure Aevrin's Claude Code PreToolUse security hook for this project without overwriting existing settings.

1. Verify the CLI first with: aevrin --version
2. Run: aevrin hook setup
3. Pause while I approve the browser device-login page. Never request or print the resulting credential.
4. Copy the exact PreToolUse JSON printed by Aevrin.
5. Open this project's .claude/settings.json. If it exists, preserve every existing key and hook; merge the new Bash and Write matcher entries instead of replacing the file. If it does not exist, create it.
6. Validate that the finished file is valid JSON.
7. Confirm that Bash commands using claude mcp add and full writes to .mcp.json or claude_desktop_config.json are covered. Do not claim partial Edit operations are covered.
8. Show me the final non-secret hook configuration and the file path changed.

Stop if setup fails, JSON cannot be merged safely, or an existing matcher conflicts. Do not invent paths or credentials and do not run an MCP server as part of setup.