Quickstart

From signup to your first PR analysis in 5 minutes.

1

Create your account

Sign up at codedig.ai/auth/signup with your email address, or authenticate via GitHub OAuth for instant access.

2

Install the GitHub App

After signing in, you are guided through the GitHub App installation flow. Click Connect GitHub and choose which organizations or personal repositories CodeDig should have access to. You can restrict access to specific repositories if you prefer.

The app requests only the minimum permissions needed: read access to code and pull requests, and write access to post check-run statuses and PR comments.

3

Select repositories

After installation, you land on the repository selector. Choose the repos you want CodeDig to monitor. CodeDig will immediately begin indexing each selected repository to build its knowledge graph — this typically takes 1–5 minutes depending on repository size.

You can add or remove repositories at any time from Settings → Repositories.

4

Open or push to a pull request

Open a new pull request (or push a commit to an existing one) in any connected repository. CodeDig detects the event via GitHub webhook, runs a full analysis of the diff, and posts a GitHub check-run status and inline PR comment within approximately 60 seconds.

The check passes or fails based on the thresholds in your .codedig.yml file (defaults apply if none is present).

5

Review findings inline

Expand the CodeDig comment on your PR to see findings broken down by severity (critical, high, medium, low). Each finding links to the relevant file and line, includes a description of the issue, and suggests a remediation.

You can also view the full analysis on the CodeDig dashboard for richer visualisation, historical trends, and architectural drift reports.