Get started

Quickstart

Connect your GitHub account and run your first Sprintbox workflow.

Connect GitHub

1. Sign in to the Sprintbox dashboard and select your workspace.
2. Complete billing setup if the workspace asks for a payment method.
3. Open Overview and choose Connect GitHub. If an account is already connected, choose Connect account to add another installation.
4. On GitHub, choose your personal account or organization and allow the Sprintbox GitHub App to access the repositories you want to run.
5. Complete the redirect back to Sprintbox. The connected account appears in your workspace.

Start the installation from Sprintbox so the GitHub account is associated with the intended workspace. If an organization owner must approve the installation, that owner also needs access to the Sprintbox workspace to complete setup.

Run a small workflow

Create .github/workflows/sprintbox-test.yml on your repository's default branch. This test needs no repository checkout or secrets:

name: Sprintbox test

on:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  test:
    runs-on: sprintbox-standard-2
    timeout-minutes: 10
    steps:
      - name: Inspect the runner
        run: |
          uname -m
          nproc
          cat /etc/os-release
          echo "Hello from Sprintbox"

Use sprintbox-standard-2 once this profile is enabled for your workspace, or replace it with another enabled label. Open the repository's Actions tab, select Sprintbox test, and choose Run workflow.

The request appears under Active jobs in Sprintbox while a runner is being prepared or running. Use the GitHub job log to check the result. Completed runners leave the active list; completed workflow history stays in GitHub.

For an existing Linux workflow, change the intended job's runs-on value first and keep its build steps. Test the result before moving every job. Workflows with several jobs can use different runner sizes for each job.