Aegis

docs · setup

From zero to your first verdictin about two minutes

Aegis rides on top of the CI you already run. There's nothing to host and no test suite to write by hand — connect a repo, point your pipeline at the upload endpoint, and open a pull request.

  1. 01

    Connect GitHub or GitLab

    Sign in with the account that owns the repositories you want reviewed. Aegis uses OAuth — you approve the connection on GitHub's or GitLab's own screen, and you can revoke it there any time.

  2. 02

    Choose the repositories to watch

    Pick the repos Aegis should review. From then on it reads every new pull request, writes the missing tests, and posts a verdict as a status check. Repos you don't select stay invisible to it.

  3. 03

    Wire your CI to upload coverage

    Aegis reads coverage, duplication, and analysis from your existing CI. Grab the repository's upload token from its settings, then add one step to your pipeline that posts your coverage report after tests run.

    example — coverage upload from CI
    curl -X POST https://app.aegis.dev/api/coverage/upload \
  -H "Content-Type: application/json" \
  -d '{
    "repository": "your-org/your-repo",
    "token": "$AEGIS_TOKEN",
    "commit": "$CI_COMMIT_SHA",
    "branch": "$CI_COMMIT_BRANCH",
    "buildId": "$CI_JOB_ID",
    "coverage": "'"$(base64 -w0 coverage/lcov.info)"'"
  }'
  4. 04

    Open a pull request

    That's the whole setup. Open a PR and Aegis reviews it end to end — tests, coverage, security, duplication — and rolls the result into a single verdict: safe to deploy, or exactly what's blocking it.

Wiring up more than coverage?

Duplication, static analysis, and vulnerability reports upload the same way, each with its own endpoint. The full request and response shapes live in the API reference.

Read the API reference