Snapvisor Docs

Getting started

Create a Snapvisor project, set your project token, capture screenshots from your existing test suite, and upload your first build.

Snapvisor captures screenshots from the test suite you already run and compares them against an approved baseline. This is the path from an empty project to your first reviewed build.

1. Create an account and a project

Sign up at app.snapvisor.io — you can continue with email (a verification code is sent to you), Google, GitHub, or GitLab. Teams on the Enterprise plan can also sign in with SAML SSO.

Create a project, then copy its project token (ARGOS_TOKEN) from the project's settings. This token authorizes screenshot uploads for that one project and nothing else.

export ARGOS_TOKEN="<your project token>"

Store the token as a CI secret — never commit it. On GitHub Actions you can skip the token entirely with tokenless authentication.

2. Install an SDK

Snapvisor runs on the open-source @snapvisor SDKs, drop-in forks of the @argos-ci SDKs. Install the CLI plus the adapter for your test runner:

npm install --save-dev @snapvisor/cli @snapvisor/playwright

Official adapters cover Playwright, Cypress, Puppeteer, and Storybook, alongside a framework-agnostic core. A Python SDK and CLI are also available — see SDKs.

3. Upload your first build

Run your tests so they write screenshots to a folder, then upload that folder with the CLI:

# run your tests so they write screenshots, then upload the folder
npx @snapvisor/cli upload ./screenshots

The first build on your base branch becomes the baseline; there is nothing to compare against yet, so it is approved automatically.

If a build finishes with no screenshots, Snapvisor tells you none were uploaded — check that your tests wrote files to the folder you passed to upload.

4. Review changes on your pull requests

On later builds, Snapvisor diffs each screenshot against the approved baseline and posts a status check to the pull request. Open the build, approve the intended changes, and reject regressions. Approving promotes the change to the new baseline for that branch.

Next steps:

On this page