CodeOtter Docs

Quickstart

Run CodeOtter locally with Node 22 and pnpm, then review your first pull request.

You need Node 22 or later and pnpm. For GitHub repositories, authenticate the GitHub CLI (gh auth status). Forgejo and Gitea use their REST APIs and do not need gh.

Clone the repository

git clone https://github.com/dharmeshgurnani/CodeOtter.git
cd CodeOtter

Start CodeOtter

pnpm dev

Starts the backend, PocketBase and the Vite dev server with HMR. Open http://localhost:5173 (proxied to :4747).

Review a pull request

  1. Paste a GitHub, Forgejo or Gitea PR URL, or pick one of your repositories in the sidebar.
  2. Choose a provider under Settings → System → Model provider (see BYOK provider config), or download an offline model under Settings → System → Local models (see Local GGUF & sidecars).
  3. Get a calibrated review in seconds, or query /api/score?pr=<url|number> for JSON.

Zero-config storage

PocketBase is detected and started locally for authentication and persistent storage. To customise superuser credentials or model keys, create a .env file from .env.example.

Next steps

  • Deploy for your team with Docker.
  • Connect Forgejo or Gitea next to GitHub.
  • Review from your terminal with the CLI.

On this page