Skip to content

Commit d4fa3ee

Browse files
AbirAbbasclaude
andauthored
docs: document installing PR-AF into AgentField via af install (#52)
Add an 'Install into AgentField' subsection at the top of Quick Start showing the one-command install path for users who already run an AgentField control plane: `af install https://github.com/Agent-Field/pr-af` then `af run` / `af call`. Notes that required secrets are prompted once, stored encrypted, and reused across nodes. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 353461a commit d4fa3ee

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,23 @@ There are excellent AI code review tools on the market. PR-AF is not designed to
190190

191191
## Quick Start
192192

193+
### Install into AgentField (`af install`)
194+
195+
Already running an [AgentField](https://github.com/Agent-Field/agentfield) control plane? Install PR-AF straight from GitHub — no clone, no local setup:
196+
197+
```bash
198+
af install https://github.com/Agent-Field/pr-af
199+
af run pr-af
200+
```
201+
202+
`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:
203+
204+
```bash
205+
af call pr-af.review --in '{"pr_url": "https://github.com/owner/repo/pull/123"}'
206+
```
207+
208+
New to AgentField? Install the control plane first with `curl -fsSL https://agentfield.ai/install.sh | bash`, or use one of the options below.
209+
193210
### Deploy with Railway (fastest)
194211

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

0 commit comments

Comments
 (0)