Skip to content

Quickstart

Get Kontrua running on your first repository in under five minutes.

SaaS quickstart

  1. Create an account

    Sign up at /signup using GitHub OAuth or email and password.
  2. Connect your repository

    Install the Kontrua GitHub App on your organisation or personal account, or add a GitLab Personal Access Token. Kontrua syncs your accessible repositories automatically.
  3. Read your first verdict

    Connecting a repository audits it immediately: Kontrua resolves the commands and paths your context files state against the code and reports how many hold, how many broke, and what it declined to judge. The verdict is free, and it runs again on every push and every pull request.
  4. Review your context settings

    AGENTS.md and conventions are on by default; the codemap and machine-readable architecture facts are opt-in. Choose which human documents Kontrua maintains alongside them (README, architecture, changelog) and set output paths.
  5. Approve a pull request

    Approve a PR on your watch branch. That is what starts a correction: Kontrua receives the webhook, traces the diff, and commits the fix into the pull request that caused it - review and merge it like any other change.

CLI quickstart

  1. Install the CLI

    Run npm install -g kontrua to install globally.
  2. Initialize your repo

    Run cd your-repo && kontrua init to scaffold a .kontrua.yml config and install git hooks.
  3. Set your API key

    Export your Anthropic key: export ANTHROPIC_API_KEY=sk-ant-...
  4. Run the correction locally

    Run kontrua update to read recent git changes, regenerate the context artifacts Kontrua owns, and correct the false lines in the files you wrote. Add --dry-run to see the changes without writing them.
The verdict itself runs on the server, not in the CLI: Kontrua audits a connected repository when you connect it, when GitHub reports a push to your default branch, and on every pull request or merge request. Those audits are free and consume no plan quota.

Ready to prove your context is true?

Connect your first repository and Kontrua tells you how much of what your docs claim is still true, before it writes anything.