Get started

Five steps, about five minutes. Your GitHub Actions jobs then run on your own Mac instead of GitHub's machines.

Try it without touching your CI: use the template.

What you need

  • A Mac with Apple silicon, on macOS 14 or later. (Linux? See Add a Linux server.)
  • A GitHub account that can add runners to the repo: a repo admin, or an organization owner.

Five steps

  1. Install

    Download Codemany, drag it to Applications and open it.

  2. Sign in with GitHub

    Choose Sign in with GitHub and enter the code the app shows on github.com. Your 14-day free trial starts by itself, with no card; if your account already has a plan, you join it. Your token stays on your Mac.

  3. Pick repositories

    Choose repositories, or a whole organization, then Continue. Public repos are off unless you turn them on for that repo (why). Each machine runs as many jobs at once as it has room for.

  4. Install the Codemany Runners App, if asked

    Only when an account you picked doesn't have it yet: choose Install… and approve it on GitHub. Then Open Codemany.

  5. Change one line

    In your workflow file, set runs-on to Codemany:

    jobs:
      build:
        runs-on: [self-hosted, codemany]

Done

Push a commit. The job runs on your Mac, and GitHub shows the logs as usual. You can also watch it in the Codemany app (Overview and Runs), the menu bar, or at http://codemany.local:8825 from any device on your network. The last setup screen has Add test workflow if you want to try it first.

No workflow to try? Download the sample workflow and push it to your repo.

Find your way around

  • Mac main window: what is happening. Overview shows running jobs, your machines and your repositories; Runs lists every run. The button at the top right is the page's main action, such as Pause New Jobs.
  • Mac Settings (⌘,): how it is set up. Machines, This Mac, Repositories, Plan & Billing, Account, General, Updates and Troubleshooting.
  • Linux app: one window with the same places: Overview, Runs, Machines, Repositories, Plan & Billing, This machine and Account. Updates and Troubleshooting are in This machine.
  • Menu bar (Mac) or tray (Linux): the status, Open Codemany, Pause New Jobs (or Resume New Jobs), Settings…, Send Feedback… and Quit Codemany.

Good to know

  • Keep the app closed if you like. Codemany's background service keeps running jobs.
  • Each job gets a fresh runner, used once and then wiped.
  • Jobs use the tools on your Mac: Xcode, Homebrew packages, Docker. Nothing is preinstalled.
  • Updates install themselves, after running jobs finish.

A job stuck in Queued? See Troubleshooting.