Skip to content

docs: add Railway template to Quick Start #5

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 3 commits into from
Feb 18, 2026
Merged

docs: add Railway template to Quick Start #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a3db74
docs: add Railway one-click deploy to Quick Start section
AbirAbbas Feb 18, 2026
60b3484
docs: add X-API-Key header to Railway trigger example
AbirAbbas Feb 18, 2026
dc01b60
docs: fix Railway curl placeholder to control-plane URL
AbirAbbas Feb 18, 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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,25 @@ This is the core factory-control behavior: control agents supervise worker agent

## Quick Start

### 1. Requirements
### Deploy with Railway (fastest)

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

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

- `CLAUDE_CODE_OAUTH_TOKEN` — run `claude setup-token` in [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) (uses Pro/Max subscription credits)
- `GH_TOKEN` — GitHub personal access token with `repo` scope for draft PR creation

Once deployed, trigger a build:

```bash
curl -X POST https://<control-plane>.up.railway.app/api/v1/execute/async/swe-planner.build \
-H "Content-Type: application/json" \
-H "X-API-Key: this-is-a-secret" \
-d '{"input": {"goal": "Add JWT auth", "repo_url": "https://github.com/user/my-repo"}}'
```

### 1. Requirements (local)

- Python 3.12+
- AgentField control plane (`af`)
Expand Down
Loading