Configuration

Full reference for configuring the GetMac Buildkite Plugin.

Plugin Parameters

Parameter	Required	Default	Description
`project-id`	Yes	—	Your GetMac project ID
`image`	No	`macos-tahoe`	macOS image version
`machine-type`	No	`mac-m4-c4-m8`	VM hardware configuration
`region`	No	`eu-central-ltu-1`	Geographic region for VM
`ssh-private-key-path`	No	`~/.ssh/id_rsa`	Path to SSH private key
`api-url`	No	`https://api.getmac.io/v1`	GetMac API endpoint
`debug`	No	`false`	Enable verbose logging

The GETMAC_CLOUD_API_KEY environment variable must be set on the Buildkite agent. See Getting Started for details.

Full Example

A complete pipeline configuration with all available options:

steps:
  - label: ":mac: Build & Test"
    command: "swift test"
    plugins:
      - getmac-io/getmac#main:
          project-id: "your-project-id"
          image: "macos-tahoe"
          machine-type: "mac-m4-c4-m8"
          region: "eu-central-ltu-1"

Machine Images

Image	macOS Version	Description
`macos-sonoma`	macOS 14 (Sonoma)	Stable release
`macos-sequoia`	macOS 15 (Sequoia)	Stable release
`macos-tahoe`	macOS 26 (Tahoe)	Latest stable release (default)
`macos-tahoe-beta`	macOS 26 (Tahoe Beta)	Beta release

See Runner Images — Installed Tools for details on what's pre-installed on each image.

Machine Types

Type	CPU	Memory
`mac-m4-c4-m8`	4 cores (Apple M4)	8 GB

Regions

Region	Location
`eu-central-ltu-1`	Europe (Lithuania)