Quickstart

Prerequisites

• Python 3.13+

• uv for package management

• A GitHub Personal Access Token (PAT) with notifications scope

Local setup (tooling only)

1. Clone the repository and install dependencies:

   git clone https://github.com/renefritze/corvix.git
   cd corvix
   uv sync
   

   Build frontend assets:

   make frontend-build
   

2. Create your local config from the committed example:

   cp config/corvix.example.yaml config/corvix.yaml
   

Docker Compose setup (required for local runtime/testing)

1. Copy config and secret templates:

   cp config/corvix.example.yaml config/corvix.yaml
   cp secrets/github_token.txt.example secrets/github_token.txt
   cp secrets/postgres_password.txt.example secrets/postgres_password.txt
   cp secrets/database_url.txt.example secrets/database_url.txt
   

2. Fill in the secret files:

   • secrets/github_token.txt — your GitHub PAT

   • secrets/postgres_password.txt — a strong database password

   • secrets/database_url.txt — full SQLAlchemy PostgreSQL URL (must match the password above)

3. Start all services:

   docker compose up --build
   

4. Open http://localhost:8000.

Next steps

• Tune rules and scoring in config/corvix.yaml

• See Dashboards for the built-in dashboard descriptions

• Run uv run corvix --help to explore all CLI commands