Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,26 @@ There are excellent AI code review tools on the market. PR-AF is not designed to

## Quick Start

### Deploy with Railway (fastest)

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/pr-af)

One click deploys PR-AF + the AgentField control plane + PostgreSQL. Set two environment variables in Railway:

- `OPENROUTER_API_KEY` — your [OpenRouter](https://openrouter.ai/keys) key (routes to the review models)
- `GH_TOKEN` — GitHub personal access token with `repo` scope, for reading PRs and posting reviews

Once deployed, trigger a review against the control plane (the public endpoint requires the `X-API-Key` header set to your `AGENTFIELD_API_KEY`):

```bash
curl -X POST https://<control-plane>.up.railway.app/api/v1/execute/async/pr-af.review \
-H "Content-Type: application/json" \
-H "X-API-Key: <AGENTFIELD_API_KEY>" \
-d '{"input": {"pr_url": "https://github.com/owner/repo/pull/123"}}'
```

### Run locally (Docker Compose)

```bash
git clone https://github.com/Agent-Field/pr-af.git && cd pr-af
cp .env.example .env # Add OPENROUTER_API_KEY, GH_TOKEN
Expand Down
Loading