Skip to main content

Configure CI

The official Argos CLI is the simplest and fastest way to send screenshots to Argos visual testing platform. Therefore, your CI should use it after taking screenshots during the end-to-end tests.

Install

Install @argos-cli package from npm.

npm i --save-dev @argos-cli

Configuring environment variable

Note: GitHub Actions CI users can skip this step.

Argos uses the ARGOS_TOKEN to identify to which repository the screenshots you send are related.

To get token value, sign in to Argos and click on the Gear buttonbutton in front of your repository.

Set the ARGOS_TOKEN as an environment variable (sometimes called “secrets”) in your CI configuration.

Upload the screenshots

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

npx @argos-ci/cli upload ./screenshots

Sometimes an additional option is required to access the CI environment variable.

CI configuration examples

Your CI is missing? Check our examples folder. Don't hesitate to contribute by adding an example!

Enjoy!

Congratulations, Argos is now installed on your repository. You are ready to start the visual testing routine.