Set up with an agent
Letting a coding agent set up RelayRunner and route your jobs for you.
Install the skills
Section titled “Install the skills”Give your agent RelayRunner’s skills, so it knows the CLI, how to route jobs and how to read your CI:
npx skills add relayrunner/relayrunnerIt works with Claude Code, Codex, Cursor and most other coding agents, and asks which ones to install for. You get three skills:
| Skill | What your agent can do with it |
|---|---|
relayrunner |
Sign a machine in, put it online, size and isolate jobs on a Mac, set up relayrunner.yml. |
relayrunner-route-jobs |
Route a repo’s jobs with relayrunner init, and explain the jobs it skips. |
relayrunner-ci-insights |
Answer questions about your runners, runs and usage through the MCP server. |
Run npx skills update now and then to get the latest.
Set up with one prompt
Section titled “Set up with one prompt”Without the skills, your agent can still do the whole setup: sign the machine in, pick which jobs to route, edit the workflows and show you the diff. Paste this into your agent, inside the repo’s checkout:
Set up relayrunner in this checkout using https://raw.githubusercontent.com/relayrunner/relayrunner/main/docs/agent-install.mdThe agent guide tells the agent to:
- Check the machine is supported and install the CLI.
- Sign the machine in with
relayrunner login. You approve it in the browser. - Run
relayrunner init --plan --jsonand go over which jobs can be routed, and why some are skipped. - Route the jobs you pick with
relayrunner init --apply, then show yougit diff. It doesn’t commit or push unless you ask. - Put the machine online with
relayrunner connect, ideally in your own terminal so it keeps running after the agent’s session ends.
Every CLI command the agent uses has a --json flag, and every step is safe to retry.
Let the agent see your CI
Section titled “Let the agent see your CI”Agents can also read your workspace through the RelayRunner MCP server: runners, recent runs, where each job ran, and usage. It’s read-only. See MCP server to connect one.
These docs, for agents
Section titled “These docs, for agents”Every docs page is also available as Markdown. Add .md to a page’s URL, or ask for it with Accept: text/markdown. llms.txt lists every page, and llms-full.txt has them all in one file.