From deb6a74678d5d0e835beff3ed365e1d6cf33adac Mon Sep 17 00:00:00 2001 From: Abir Abbas Date: Wed, 8 Jul 2026 13:17:05 -0400 Subject: [PATCH] docs: document installing PR-AF into AgentField via `af install` 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) --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 08af6c8..2b25f40 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,25 @@ 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 the Docker option below. + +### Local (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