Install, deploy, and review PRs

Docker path: Docker and Docker Compose. Manual path: Node.js 20.9+ and npm. Desktop path: download an installer — no Docker required.

An API key from OpenRouter, Anthropic, Groq, or a local OpenAI-compatible server such as Ollama.

A GitHub App for GitHub reviews. GitLab and/or Bitbucket OAuth apps only if you use those providers.

Git providers must reach your instance to deliver PR events. Use your production domain, or a tunnel (ngrok, cloudflared) while developing locally.

The compose stack runs Postgres and the app. Migrations apply automatically on container start.

git clone https://github.com/Abhivera/gitclaw.git
cd gitclaw
cp .env.example .env
docker compose up --build

Open http://localhost:3000 when the containers are healthy. Skip to Configure to fill in .env.

1. Clone and install dependencies:

git clone https://github.com/Abhivera/gitclaw.git
cd gitclaw
npm install

2. Start Postgres (listens on port 5438, database gitclaw):

docker compose up -d postgres

3. Copy the example env file — you will edit it in the next section:

cp .env.example .env

4. Apply database migrations:

npm run db:migrate

5. Start the dev server (background workers start automatically):

npm run dev

Open http://localhost:3000.

1. Install and open GitClaw. The dashboard opens automatically.
2. Go to File → Open configuration folder and edit .env with your GitHub App and AI keys.
3. Restart the app after saving configuration.

The desktop app uses an embedded Postgres instance — no separate database setup. For webhooks, use a tunnel and set APP_URL plus ALLOWED_DEV_ORIGINS to your public hostname (see Deploy).

If you have not already: cp .env.example .env

Add GITLAB_CLIENT_ID and GITLAB_CLIENT_SECRET, or BITBUCKET_CLIENT_ID and BITBUCKET_CLIENT_SECRET, only if you connect those providers. Self-hosted GitLab: set GITLAB_BASE_URL.

Docker: run docker compose up -d --build on your server with APP_URL set to your public HTTPS URL.

Manual: build and start the production server behind your reverse proxy (nginx, Caddy, etc.):

npm run build
npm run start

Start a tunnel to your local port, then add the public hostname to your config.

ngrok http 3000

cloudflared tunnel --url http://127.0.0.1:3000

Set ALLOWED_DEV_ORIGINS to your tunnel hostname (e.g. abc123.ngrok-free.app). Update APP_URL if needed. GitClaw reloads configuration on save.

Git providers expect HTTPS webhook endpoints in production. Terminate TLS at your load balancer or reverse proxy before traffic reaches GitClaw.

1. Create a GitHub App with pull request and repository contents read permissions.
2. Set the webhook URL to https://<your-host>/api/github/webhook.
3. Set GITHUB_APP_SLUG in .env and restart if needed.
4. In the dashboard, click Connect GitHub and install the app on your repositories.

1. Create a GitLab OAuth application with callback https://<your-host>/api/gitlab/callback.
2. Authorize from the dashboard.
3. Add the webhook URL shown on the integration card to your project (merge request events).

1. Create a Bitbucket OAuth consumer with callback https://<your-host>/api/bitbucket/callback.
2. Authorize from the dashboard.
3. Add the webhook URL shown on the integration card to your repo (pull request events).

GitClaw listens for PR open and update webhooks. It diffs only what changed since the last review, so follow-up commits do not re-review the entire PR.

Findings appear as inline comments on the PR plus a summary. Categories include security, performance, and maintainability.

Mention @gitclaw in a PR comment to ask follow-up questions in context.

Add a .gitclaw.yaml in any repository to set ignore paths, review tone, and custom instructions. Track activity from the dashboard overview and analytics pages.