Quickstart with any test framework
Learn how to setup visual testing using Argos SDK.
Prerequisites
To get the most out of this guide, you’ll need to:
- Take screenshots while your E2E tests are running
- Run your E2E tests on CI
- Create your project in Argos
1. Install
- npm
- yarn
- pnpm
- bun
npm i --save-dev @argos-ci/cli
yarn add --dev @argos-ci/cli
pnpm add --save-dev @argos-ci/cli
bun add --dev @argos-ci/cli
Read the CLI documentation if you need information about advanced usages.
2. Upload screenshots on CI
Add this command to your CI pipeline to upload the screenshots to Argos.
npm exec -- argos upload --token <ARGOS_TOKEN> ./screenshots
Note: The value of ARGOS_TOKEN is available your project settings on Argos.
Congratulations on installing Argos! 👏
After committing and pushing your changes, the Argos check status will appear on your pull request in GitHub (or GitLab).
Note: you need a reference build to compare your changes with. If you don't have one, builds will remain orphan until you run Argos on your reference branch.
You can now review changes of your app for each pull request, avoid visual bugs and merge with confidence. Welcome on board!
Join our Discord, submit an issue on GitHub or just send an email if you need help.