RelayRunner docs: Quickstart Page: https://relayrunner.app/docs/get-started/quickstart Markdown: https://relayrunner.app/docs/get-started/quickstart.md All pages: https://relayrunner.app/docs/llms.txt Other pages (Markdown): - Changelog: https://relayrunner.app/docs/changelog.md - CLI changelog: https://relayrunner.app/docs/changelog/cli.md - CI traces in your observability tool: https://relayrunner.app/docs/changelog/opentelemetry-traces.md - Platform changelog: https://relayrunner.app/docs/changelog/platform.md - Retries, queueing and provider usage: https://relayrunner.app/docs/changelog/retries-queueing-and-provider-usage.md - Optimized checks: https://relayrunner.app/docs/concepts/optimized-checks.md - Principles: https://relayrunner.app/docs/concepts/principles.md - Routing: https://relayrunner.app/docs/concepts/routing.md - Runner order: https://relayrunner.app/docs/concepts/runner-order.md - Add a provider: https://relayrunner.app/docs/contribute/add-provider.md - Feedback: https://relayrunner.app/docs/contribute/feedback.md - Activity and history: https://relayrunner.app/docs/dashboard/activity.md - Performance: https://relayrunner.app/docs/dashboard/performance.md - Remove RelayRunner: https://relayrunner.app/docs/dashboard/remove.md - Signals: https://relayrunner.app/docs/dashboard/signals.md - Telemetry: https://relayrunner.app/docs/dashboard/telemetry.md - Usage and savings: https://relayrunner.app/docs/dashboard/usage.md - Workspaces and members: https://relayrunner.app/docs/dashboard/workspaces.md - Set up with an agent: https://relayrunner.app/docs/get-started/agents.md - How it works with GitHub Actions: https://relayrunner.app/docs/get-started/github-actions.md - Install the CLI: https://relayrunner.app/docs/get-started/install.md - Move your workflows over: https://relayrunner.app/docs/get-started/move-over.md - Route GitHub Actions jobs to any runner: https://relayrunner.app/docs/get-started/overview.md - Quickstart: https://relayrunner.app/docs/get-started/quickstart.md (this page) - Keep up with coding agents: https://relayrunner.app/docs/guides/agent-surge.md - Run CI on your laptop while you work: https://relayrunner.app/docs/guides/laptop-ci.md - macOS and iOS builds on your Mac: https://relayrunner.app/docs/guides/mac-builds.md - Spend controls: https://relayrunner.app/docs/guides/spend-controls.md - Share your team's machines: https://relayrunner.app/docs/guides/team-machines.md - RelayRunner API: https://relayrunner.app/docs/reference/api.md - CLI: https://relayrunner.app/docs/reference/cli.md - Errors: https://relayrunner.app/docs/reference/errors.md - FAQ: https://relayrunner.app/docs/reference/faq.md - GitHub App: https://relayrunner.app/docs/reference/github-app.md - Runner labels: https://relayrunner.app/docs/reference/labels.md - MCP server: https://relayrunner.app/docs/reference/mcp.md - Data and privacy: https://relayrunner.app/docs/reference/privacy.md - relay.yml inputs: https://relayrunner.app/docs/reference/relay-inputs.md - Repo config: https://relayrunner.app/docs/reference/repo-config.md - Security: https://relayrunner.app/docs/reference/security.md - Troubleshooting: https://relayrunner.app/docs/reference/troubleshooting.md - GitHub-hosted: https://relayrunner.app/docs/runners/github.md - Hosted providers: https://relayrunner.app/docs/runners/hosted.md - Providers: https://relayrunner.app/docs/runners/providers.md - Your machines: https://relayrunner.app/docs/runners/self-hosted.md --- # Quickstart > Go from sign-up to a green GitHub Actions job on your own machine. You need a private GitHub repository, and a Mac or Linux computer with Node.js 22 or newer. ## 1. Connect your machine In a terminal on the computer you want CI on, run: ```sh npx relayrunner connect ``` The first run shows a code and opens the dashboard. Continue with GitHub to sign up and install the [RelayRunner GitHub App](https://github.com/apps/relayrunner) on your organization or personal account in one trip. The install is your workspace. Then check the code matches and approve the machine. Leave `connect` running. While it runs, the machine is online and takes jobs. Ctrl-C takes it offline. ## 2. Route a job In another terminal, inside a checkout of your repository, run: ```sh npx relayrunner init ``` `init` lists the repo's jobs and lets you pick which to route. For each one it adds a relay job in front and points the job's `runs-on` at the relay's answer. The job's old label, such as `ubuntu-latest`, becomes the fallback. It only edits `.github/workflows/` and never commits. See [Move your workflows over](/docs/get-started/move-over) for what it changes and what it skips. > **Tip:** If you run `connect` inside the repository, it offers to do this step for you. ## 3. Push and watch Commit the change and push. In the workflow run on GitHub you'll see `relay- / RelayRunner` finish in about a second, then your job start. The terminal running `connect` shows the job as it runs. Open **Activity** in the [dashboard](https://app.relayrunner.app) to see where the job ran and why. Stop `connect`, push again, and the same job runs on its old label instead. ## Next - [Runner order](/docs/concepts/runner-order): choose what's tried first. - [Run CI on your laptop while you work](/docs/guides/laptop-ci): the full laptop setup. - [Set up with an agent](/docs/get-started/agents): let a coding agent do all of this.