Back to home
Documentation

Get started with CodeOwl

Install the GitHub App and get AI-powered code reviews on every pull request in under 5 minutes — no config required.

codeowl-install-walkthrough.mp4

Installation walkthrough video

Comming Soon

01

Install the GitHub App

Click the button below to open the GitHub App installation page. You will be taken to GitHub where you can choose which repositories CodeOwl can access.

Install CodeOwl on GitHub

On the GitHub installation page:

  • Select the GitHub account or organization to install on
  • Choose "All repositories" or select specific repos
  • Click "Install" to grant CodeOwl access
02

Authorize & permissions

During installation GitHub will ask you to approve the permissions CodeOwl needs. Here is exactly what it requests and why:

PermissionAccess levelWhy it is needed
Pull requestsRead & writeRead diffs and post inline review comments
ContentsRead-onlyAccess repository files for review context
MetadataRead-onlyBasic repo info such as name and visibility
ChecksRead & writePublish review status to the PR checks tab

Note: CodeOwl never stores your source code beyond what is needed for an active review. All data is processed over TLS in isolated environments.

03

First review in minutes

Once installed, CodeOwl automatically triggers on every new or updated pull request. No additional configuration is required.

✓ Pull request opened by @dev
✓ CodeOwl triggered — analysing diff + context
✓ Review posted: 3 findings (1 critical, 2 warnings)
✓ Inline comments added to PR

Owl posts a summary comment and inline review comments directly on the pull request — no separate dashboard required.

04

Optional: custom rules

Add a .owl/rules.yml file to your repository root to define custom review rules for your team.

# .owl/rules.yml
version: 1

rules:
  - id: no-raw-sql
    severity: critical
    message: "Use parameterized queries to prevent SQL injection."

  - id: require-idempotency-key
    severity: warning
    paths: ["src/payments/**"]
    message: "Payment endpoints must include an idempotency key."

  - id: no-console-log
    severity: info
    paths: ["src/**"]
    message: "Remove console.log before merging to main."

Severities

critical · warning · info

Path filters

Target specific directories

Custom messages

Team-specific guidance

Common questions

Does CodeOwl review every PR automatically?

Yes. Once installed, Owl triggers on every new pull request and every subsequent push to that PR — no manual action needed.

Can I limit which repositories Owl reviews?

Yes. During installation you choose "All repositories" or pick specific ones. You can change this at any time in your GitHub App settings.

How do I remove CodeOwl?

Go to GitHub → Settings → Applications → Installed GitHub Apps and uninstall CodeOwl. All access is immediately revoked.

Is there a free plan?

Yes — the Free plan covers personal repositories with 50 PR reviews per month. No credit card required.

Ready to get started?

Start reviewing code

Questions? Email neeleshp212@gmail.com