Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.66 KB

File metadata and controls

78 lines (59 loc) · 2.66 KB
title Quickstart
description Install the GitHub App and get your first review in under five minutes.
Visit [github.com/apps/instalog](https://github.com/apps/instalog) and click **Install**. Pick the repositories you want reviewed.
Instalog requests read access to code and pull requests, plus write access to PR comments and the `instalog/review` check. It does **not** request write access to your code.
Push a branch and open a PR. Instalog picks it up within seconds and the `instalog/review` check appears in the PR.
Time to first comment is typically 60 to 90 seconds. Large PRs (over 2000 lines) can take 3 to 5 minutes in agentic mode.
Instalog posts:
- One **summary comment** with the count of findings, drop rate, and a link to the dashboard.
- Zero to N **inline comments** at the lines that survived filtering.

If you see no inline comments, that is fine. Defaults are tuned for precision. The summary will tell you how many candidate findings were dropped and why.
Drop `instalog-ai.yaml` at the repo root for per repo behavior:
```yaml
version: "1.0"

analysis:
  confidence_threshold: 0.75
  max_suggestions_per_file: 5

rules:
  triggers:
    ignore_keywords: ["wip", "draft"]
  filters:
    exclude_authors: ["dependabot[bot]", "renovate[bot]"]
```

See [Configuration](/configuration) for the full schema.
Sign in at [beta.instalog.dev](https://beta.instalog.dev/dashboard) with the same GitHub account. The dashboard shows:
- Every review the bot has done.
- Every finding it dropped, with the reason.
- Acceptance rate over time.

See [Dashboard](/dashboard) for what each view is for.

Next steps

Semgrep grounding, embedding context, multi pass validation. Every knob in `instalog-ai.yaml`, with defaults. Tune the comment cap and threshold to earn team trust. Run the reviewer inside your VPC. No code leaves the network.

Mobile SDKs

If you got here looking for the mobile event logging and crash reporting SDKs, head to Mobile SDKs.