Skip to main content

Use Argos with Buildkite

Configure Buildkite to send screenshots to Argos visual testing platform.

1. Install Argos CLI​

npm i --save-dev @argos-ci/cli

Read the CLI documentation if you need information about advanced usages.

2. Expose ARGOS_TOKEN as environment variable​

  1. Log in to Argos, navigate to your project settings and copy your ARGOS_TOKEN.
  2. In your Buildkite pipeline, go to Settings -> Steps -> Environment Variables.
  3. Add a new environment variable called ARGOS_TOKEN and paste the value you copied in the previous step.

If you are not comfortable with exposing environment variables, read the Buildkite documentation.

3. Upload the screenshots​

Add the following command to your CI workflow to upload screenshots to Argos:

npm exec argos upload ./screenshots

Complete example​

pipeline.yml
steps:
  # 👉 Insert the steps required to take screenshots

  - label: "Upload screenshots to argos-ci.com"
    # 👇 change "./screenshots" by your screenshots folder path
    command: npm exec upload ./screenshots

What's next?

Congratulations on installing Argos! 🎉
The next step is to integrate visual review into your development workflow. Visit our review changes section to learn how to.