Title: Get started · Codemany docs
URL: https://codemany.com/docs/get-started
Description: Install Codemany, sign in with GitHub, pick your repos and change one line in your workflow. Your GitHub Actions jobs then run on your own Mac.
All pages as Markdown: https://codemany.com/llms.txt

---

[Get started](https://codemany.com/docs#start)

# Get started

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

## What you need

- A Mac with Apple silicon, on macOS 14 or later. (Linux? See [Add a Linux server](https://codemany.com/docs/machines#linux).)
- A GitHub account that can add runners to the repo: a repo admin, or an organization owner.

## Five steps

1. Install
   [Download Codemany](https://codemany.com/download), drag it to Applications and open it.
2. Sign in with GitHub
   Enter the code the app shows on github.com. You can also use your GitHub CLI login or paste a token. Your token stays on your Mac.
3. Pick repos
   Choose repositories, or a whole organization. Public repos are off unless you turn them on for that repo ([why](https://codemany.com/docs/security#public)).
4. Start runners
   Your 14-day free trial starts here. No card needed.
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, the menu bar, or at `http://codemany.local:8825` from any device on your network.

No workflow to try? Download the [sample workflow](https://codemany.com/codemany-test.yml) and push it to your repo.

## 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](https://codemany.com/docs/troubleshooting).

[Previous Docs](https://codemany.com/docs)[Next Machines](https://codemany.com/docs/machines)
