Back to Tuist

Getting started {#getting-started}

server/priv/docs/en/guides/features/runners/getting-started.md

4.203.02.6 KB
Original Source

Getting started {#getting-started}

[!IMPORTANT] Invite-only

Tuist Runners are currently invite-only. Reach out or ping us in the community Slack to request access for your account.

[!WARNING] Requirements

  • A <.localized_link href="/guides/server/accounts-and-projects">Tuist account and project</.localized_link>
  • Your project <.localized_link href="/guides/integrations/gitforge/github">connected to a GitHub organization</.localized_link>

Running a job on the fleet takes three changes: connect GitHub, point runs-on at a Tuist <.localized_link href="/guides/features/runners/profiles">profile</.localized_link>, and push.

  1. Request access. Runners are invite-only during the beta. Reach out with the account you want enabled.

  2. Connect GitHub. Make sure your project is <.localized_link href="/guides/integrations/gitforge/github">connected to your GitHub organization</.localized_link>. Tuist receives workflow_job events for that organization and dispatches matching jobs to the fleet. Without this connection, no jobs reach your runners.

  3. Point runs-on at a Tuist profile. Every enabled account starts with two ready-to-use <.localized_link href="/guides/features/runners/profiles">profiles</.localized_link>: linux and macos. Reference them with the tuist- prefix:

    yaml
    jobs:
      build:
        runs-on: tuist-macos # or tuist-linux
        steps:
          - uses: actions/checkout@v4
          - run: tuist test
    

    [!IMPORTANT] Select Xcode with the runner profile

    A macOS runner image contains a single Xcode version, which Tuist selects before the job starts based on the profile. If you're migrating from GitHub-hosted runners, remove steps that use xcode-select --switch (or xcode-select -s) or other tools and actions to switch Xcode versions. Those steps commonly reference Xcode installations specific to GitHub-hosted images and can fail on Tuist Runners.

    To use another Xcode version, <.localized_link href="/guides/features/runners/profiles#creating-a-profile">create or choose a profile</.localized_link> with that version and update runs-on, for example runs-on: tuist-xcode-26-4. xcodebuild, xcrun, and swift will then use the profile's selected Xcode without any additional setup in the workflow.

  4. Push and watch. The job is queued, claimed by a runner, and streamed back to the Runners section of your Tuist dashboard, where you can follow its logs, steps, and machine metrics.