Skip to content
Argus
Start free

Getting started

Argus compares the code in your repositories with the architecture you approved, on every pull request, and shows the result in one dashboard. Getting there takes four steps.

1. Sign in with GitHub

Open https://app.argusadr.dev/signin and choose Sign in with GitHub. There is no separate sign-up: your account is created the first time you sign in.

  • You can sign in when you’re a member of a GitHub organisation where Argus’s GitHub App is installed.
  • You see only the repositories of the organisations you belong to. Your membership is checked again every hour.
  • A session lasts seven days. Only a hash of its ID is stored, and an admin can end it at any time.

Who becomes the first admin of a new organisation: to be confirmed.

2. Connect your organisation

Argus reads GitHub through a GitHub App installed on your organisation: pull requests, reviews and labels, CODEOWNERS, deployments, and the results your CI keeps for each pull request.

How you install the App on your organisation: to be confirmed.

3. Add your architecture model

The check compares your code with a model of your architecture, kept as code in Git:

  • Components, each with its source paths, its layer, its owner and the interfaces it declares (an OpenAPI file, for example).
  • Relationships between components: which component may import which.
  • Architecture decision records (ADRs) that the model and the code cite.

Each repository keeps a pinned slice of the model, the part that describes it, at architecture/index.json. The check reads that file, so it never needs the network. For Python repositories, the import boundaries the model allows are also written into pyproject.toml as Import Linter contracts.

How the model and each repository’s slice are set up for a new organisation: to be confirmed.

The check supports Python repositories today. JavaScript, TypeScript and Go are coming soon.

4. Check every pull request

Add the check to each repository’s CI with the GitHub Action, or run the CLI in any CI. The dashboard picks up each pull request’s results within about ten minutes.

Then

  • Connect your coding agents through MCP, so they ask what the model allows before they change code and report what they did: Agents (MCP).
  • Learn what each finding means: Rules and findings.