Skip to content

docs: document af install into an AgentField setup #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbirAbbas merged 2 commits into from
Jul 8, 2026
Merged

docs: document af install into an AgentField setup #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
deb6a74
docs: document installing PR-AF into AgentField via `af install`
AbirAbbas Jul 8, 2026
ec90bf2
Merge remote-tracking branch 'origin/main' into docs/af-install-flow
AbirAbbas Jul 8, 2026
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,23 @@ There are excellent AI code review tools on the market. PR-AF is not designed to

## Quick Start

### Install into AgentField (`af install`)

Already running an [AgentField](https://github.com/Agent-Field/agentfield) control plane? Install PR-AF straight from GitHub — no clone, no local setup:

```bash
af install https://github.com/Agent-Field/pr-af
af run pr-af
```

`af install` clones the repo, provisions an isolated Python environment, and registers the `pr-af` node with your control plane. On first `af run` you're prompted for the required secrets — `OPENROUTER_API_KEY` and `GH_TOKEN` — which are stored encrypted and reused across every node, so you enter each only once. Then review a PR:

```bash
af call pr-af.review --in '{"pr_url": "https://github.com/owner/repo/pull/123"}'
```

New to AgentField? Install the control plane first with `curl -fsSL https://agentfield.ai/install.sh | bash`, or use one of the options below.

### Deploy with Railway (fastest)

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