Getting Started

This guide will help you setup your first Buildkite pipeline. If you don’t have a Buildkite account you’ll first need to sign up. This guide uses GitHub but Buildkite can work with any version control system.

Install and run your first agent

Buildkite agents are small, reliable and cross-platform build runners that run automated builds. Buildkite never accesses your code, and does not run any agents, so you need to install and run agents on your own infrastructure. You can do this on your local development machine, an existing CI machine, or a new server.

  1. Follow the Agent installation instructions to install and start an agent.
  2. Make sure you've configured the agent token, as that is what connects the agent to your Buildkite account. Refer to Buildkite Agent Configuration for more information.
  3. Opt in to the YAML steps editor. This is the newer way of configuring pipelines. Refer to Pipeline Upgrade - Using YAML Steps for new pipelines for more information.

To confirm that your Buildkite agent is running, and configured correctly with your credentials, go to you organization's Agents page. You should see a list of all agents linked to the account, and their status.

Add the sample pipeline

Pipelines are how Buildkite represents your CI workflow, a series of steps that you run on your code.

Choose a sample pipeline to use as your first pipeline:

  1. Click the appropriate Add to Buildkite button:

    bash-example test repository

    Add Bash Example to Buildkite

    powershell-example test repository

    Add PowerShell Example to Buildkite

  2. Accept the pre-filled defaults, and select Create Pipeline.

  3. The example repositories contain a pipeline.yml setting out the pipeline steps, so on the Steps screen, add the following to upload and use the pipeline.yml:

    steps:
      - label: "Pipeline upload"
        command: buildkite-agent pipeline upload
    

    If you do not see the Steps screen, or if the previous screen included a Steps section, you are still using the old web-based editor. This will be deprecated at some point. Please make sure to opt in to the YAML steps editor. Refer to Pipeline Upgrade - Using YAML Steps for new pipelines for more information.

  4. Select Save and Build. Buildkite opens the New Build modal.

  5. You can usually accept the defaults here. If your repository uses 'main' rather than 'master' branch, edit the Branch option. Select Create build. Buildkite takes you to the pipeline build.

Congratulations, you have run your first Buildkite build! 🎉

Invite your team to the organization

Invite your team to see your build from your Buildkite organization User Settings page, by pasting their email addresses into the form.

Using a private repository

When you create a new pipeline with a private repository URL you’ll be shown instructions for configuring your SCM’s webhooks (in GitHub, Bitbucket, etc). Once you’ve followed those instructions make sure your agent’s SSH keys are configured, and you’ll be good to run a build of your private pipeline.

For more advanced pipelines it can be a good idea to use your development machine as the agent for your first few builds. That way all the dependencies are ready and you’ll sooner be able to share a link to a green build with the rest of your team.