Snapvisor

https://snapvisor.io/docs
Admin
Snapvisor is an open-source visual regression testing platform that captures screenshots from...
Tokens:58,357
Snippets:474
Trust Score:2.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Snapvisor CLI

Source: https://snapvisor.io/docs/migrate-from-lost-pixel

Install the Snapvisor CLI package as a development dependency.

```bash
npm install --save-dev @snapvisor/cli
```

--------------------------------

### Install @snapvisor/playwright

Source: https://snapvisor.io/docs/sdks

Install the Playwright SDK as a dev dependency.

```bash
npm install --save-dev @snapvisor/playwright
```

--------------------------------

### cURL request to list reviews

Source: https://snapvisor.io/docs/api-reference/reviews/listReviews

Example cURL command to GET the reviews for a build. Replace the placeholder strings with actual values.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string/builds/string/reviews" \
  -H "Authorization: Bearer "
```

--------------------------------

### Install Python SDK from GitHub

Source: https://snapvisor.io/docs/sdks

Install the Python SDK directly from GitHub until it is available on PyPI as 'snapvisor'.

```bash
pip install git+https://github.com/DevinoSolutions/snapvisor-python
```

--------------------------------

### Initialize environment and start containers

Source: https://snapvisor.io/docs/self-hosting

Copy the environment template and start the services using Docker Compose.

```bash
cp .env.example .env
# fill in the variables above, then:
docker compose up -d
```

--------------------------------

### Install and use @snapvisor/cli to upload screenshots

Source: https://snapvisor.io/docs/sdks

Install the CLI and upload a screenshots directory with a project token. The CLI also exposes commands to deploy, inspect, review builds, and more.

```bash
npm install --save-dev @snapvisor/cli
```

```bash
ARGOS_TOKEN="<your-project-token>" npx @snapvisor/cli upload ./screenshots
```

--------------------------------

### Response body example

Source: https://snapvisor.io/docs/api-reference/deployments/getDeployment

Example JSON response body for a successful deployment retrieval.

```json
{
  "id": "string",
  "status": "pending",
  "environment": "preview",
  "branch": "string",
  "commitSha": "string",
  "url": "http://example.com",
  "createdAt": "string"
}
```

--------------------------------

### Get Project Request

Source: https://snapvisor.io/docs/api-reference/projects/getProject

Example cURL request to retrieve a project by owner and project name.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string" \  -H "Authorization: Bearer "
```

--------------------------------

### Install @snapvisor CLI and Playwright adapter

Source: https://snapvisor.io/docs/getting-started

Install the Snapvisor CLI and the Playwright adapter as dev dependencies. Official adapters also cover Cypress, Puppeteer, and Storybook.

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

--------------------------------

### JSON response for GET /me

Source: https://snapvisor.io/docs/api-reference/users/getMe

Example response body showing the user object, accounts array, and GitHub linkage. The response includes fields like id, name, email, and account type.

```json
{  "user": {    "id": "string",    "name": "string",    "email": "string"  },  "accounts": [    {      "id": "string",      "slug": "string",      "name": "string",      "type": "user",      "mcpAccessIncluded": true    }  ],  "github": {    "connected": true,    "login": "string"  }}
```

--------------------------------

### Response body example

Source: https://snapvisor.io/docs/api-reference/builds/updateBuild

Example JSON response body for a successful update, containing build details, status, stats, metadata, and notification information.

```json
{
  "build": {
    "id": "string",
    "number": 1,
    "head": {
      "sha": "string",
      "branch": "string"
    },
    "base": {
      "sha": "string",
      "branch": "string"
    },
    "status": "accepted",
    "conclusion": "no-changes",
    "stats": {
      "added": 0,
      "removed": 0,
      "unchanged": 0,
      "changed": 0,
      "ignored": 0,
      "failure": 0,
      "retryFailure": 0,
      "total": 0
    },
    "metadata": {
      "testReport": {
        "status": "passed",
        "stats": {
          "startTime": "string",
          "duration": 0
        }
      }
    },
    "url": "http://example.com",
    "notification": {
      "description": "string",
      "context": "string",
      "github": {
        "state": "pending"
      },
      "gitlab": {
        "state": "pending"
      },
      "url": "http://example.com"
    }
  }
}
```

--------------------------------

### Install TypeScript API Client

Source: https://snapvisor.io/docs/api

Command to install the official typed client for TypeScript projects.

```bash
npm install @snapvisor/api-client
```

--------------------------------

### Response body example

Source: https://snapvisor.io/docs/api-reference/builds/findBaseline

Example JSON response from the baseline endpoint, showing the structure of a baseline build.

```json
{  "baseline": {    "id": "string",    "number": 1,    "head": {      "sha": "string",      "branch": "string"    },    "base": {      "sha": "string",      "branch": "string"    },    "status": "accepted",    "conclusion": "no-changes",    "stats": {      "added": 0,      "removed": 0,      "unchanged": 0,      "changed": 0,      "ignored": 0,      "failure": 0,      "retryFailure": 0,      "total": 0    },    "metadata": {      "testReport": {        "status": "passed",        "stats": {          "startTime": "string",          "duration": 0        }      }    },    "url": "http://example.com",    "notification": {      "description": "string",      "context": "string",      "github": {        "state": "pending"      },      "gitlab": {        "state": "pending"      },      "url": "http://example.com"    }  }}
```

--------------------------------

### Example response body for list reviews

Source: https://snapvisor.io/docs/api-reference/reviews/listReviews

Example JSON response containing an array of review objects. Each review includes id, buildId, state, user, dismissedAt, dismissedBy, and date.

```json
[
  {
    "id": "string",
    "buildId": "string",
    "state": "approved",
    "user": {
      "id": "string",
      "slug": "string",
      "name": "string"
    },
    "dismissedAt": "string",
    "dismissedBy": {
      "id": "string",
      "slug": "string",
      "name": "string"
    },
    "date": "string"
  }
]
```

--------------------------------

### cURL request to get a deployment

Source: https://snapvisor.io/docs/api-reference/deployments/getDeployment

Example cURL command to retrieve a deployment by its ID. Requires a project token in the Authorization header.

```bash
curl -X GET "https://api.snapvisor.io/v2/deployments/string" \
  -H "Authorization: Bearer "
```

--------------------------------

### List builds cURL request

Source: https://snapvisor.io/docs/api-reference/builds/listBuilds

Example cURL command to retrieve project builds.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string/builds" \
  -H "Authorization: Bearer "
```

--------------------------------

### Configure MCP Client in JSON

Source: https://snapvisor.io/docs/agents/mcp-server

Example configuration for an MCP client using the mcpServers object.

```json
{
  "mcpServers": {
    "snapvisor": {
      "url": "https://mcp.snapvisor.io"
    }
  }
}
```

--------------------------------

### Create review cURL request

Source: https://snapvisor.io/docs/api-reference/reviews/createReview

Example cURL command to POST a review to a specific build.

```bash
curl -X POST "https://api.snapvisor.io/v2/projects/string/string/builds/string/reviews" \  -H "Authorization: Bearer " \  -H "Content-Type: application/json" \  -d '{}'
```

--------------------------------

### Authorization header example

Source: https://snapvisor.io/docs/api-reference/comments/getComment

Shows how to send a personal access token as a bearer token in the Authorization header.

```http
Authorization: Bearer <personal-access-token>
```

--------------------------------

### Production deployment branch patterns

Source: https://snapvisor.io/docs/learn/deployments/environments

Examples of glob patterns used to define which branches are treated as production deployments.

```text
main
{main,production}
release/**
```

--------------------------------

### Get build cURL request

Source: https://snapvisor.io/docs/api-reference/builds/getBuild

Example cURL command to retrieve a build by its number.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string/builds/string" \  -H "Authorization: Bearer "
```

--------------------------------

### Upload screenshots folder with @snapvisor/cli

Source: https://snapvisor.io/docs/getting-started

Run tests to write screenshots, then upload the folder with the CLI. The first build on the base branch becomes the baseline and is approved automatically. If no screenshots are uploaded, Snapvisor reports that none were uploaded.

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

--------------------------------

### Response body example

Source: https://snapvisor.io/docs/api-reference/comments/getComment

Example JSON response body for a successful request.

```json
{
  "id": "string",
  "buildId": "string",
  "threadId": "string",
  "body": null,
  "text": "string",
  "author": {
    "id": "string",
    "slug": "string",
    "name": "string"
  },
  "screenshotDiffId": "string",
  "anchor": {
    "type": "point",
    "x": 0,
    "y": 0
  },
  "pending": true,
  "resolvedAt": "string",
  "editedAt": "string",
  "createdAt": "string",
  "reactions": [
    {
      "emoji": "string",
      "count": 0,
      "users": [
        {
          "id": "string",
          "slug": "string",
          "name": "string"
        }
      ]
    }
  ]
}
```

--------------------------------

### Upload screenshots with Snapvisor CLI

Source: https://snapvisor.io/docs/migrate-from-lost-pixel

Set the project token and execute the upload command to send screenshots to Snapvisor.

```bash
export ARGOS_TOKEN="<your project token>"

# run whatever already produced .lostpixel/current/ — then:
npx @snapvisor/cli upload ./screenshots
```

--------------------------------

### Run database migrations and bootstrap

Source: https://snapvisor.io/docs/self-hosting

Commands executed by the snapvisor-migrate service to apply migrations and seed default plans.

```bash
pnpm run --filter @argos/backend db:migrate:latest
pnpm run --filter @argos/backend db:bootstrap-default-plans
```

--------------------------------

### cURL request example

Source: https://snapvisor.io/docs/api-reference/comments/getComment

Example cURL command to retrieve a single comment on a build.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string/builds/string/comments/string" \
  -H "Authorization: Bearer "
```

--------------------------------

### Response body for create project

Source: https://snapvisor.io/docs/api-reference/projects/createProject

Example JSON response returned on successful creation (201). Contains the project id, account object, name, defaultBaseBranch, and hasRemoteContentAccess.

```json
{
  "id": "string",
  "account": {
    "id": "string",
    "slug": "string"
  },
  "name": "string",
  "defaultBaseBranch": "string",
  "hasRemoteContentAccess": true
}
```

--------------------------------

### Configure CLI for self-hosted instance

Source: https://snapvisor.io/docs/self-hosting

Set the project token and API base URL environment variables before running the upload command.

```bash
export ARGOS_TOKEN="<your project token>"
export ARGOS_API_BASE_URL="https://api.snapvisor.example.com/v2/"

npx @snapvisor/cli upload ./screenshots
```

--------------------------------

### cURL request to GET /me

Source: https://snapvisor.io/docs/api-reference/users/getMe

Sends a GET request to the /me endpoint with a bearer token in the Authorization header. The token is required for user actions.

```bash
curl -X GET "https://api.snapvisor.io/v2/me" \  -H "Authorization: Bearer "
```

--------------------------------

### Add Reaction Request

Source: https://snapvisor.io/docs/api-reference/comments/addCommentReaction

Example cURL command to add an emoji reaction to a comment.

```bash
curl -X POST "https://api.snapvisor.io/v2/projects/string/string/builds/string/comments/string/reactions" \  -H "Authorization: Bearer " \  -H "Content-Type: application/json" \  -d '{    "emoji": "string"  }'
```

--------------------------------

### Create a build request

Source: https://snapvisor.io/docs/api-reference/builds/createBuild

Example cURL command to create a new build by sending a POST request to the builds endpoint.

```bash
curl -X POST "https://api.snapvisor.io/v2/builds" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "commit": "string",
    "branch": "string",
    "screenshotKeys": [
      "string"
    ]
  }'
```

--------------------------------

### Get build response body

Source: https://snapvisor.io/docs/api-reference/builds/getBuild

The JSON structure returned when successfully retrieving a build.

```json
{
  "id": "string",
  "number": 1,
  "head": {
    "sha": "string",
    "branch": "string"
  },
  "base": {
    "sha": "string",
    "branch": "string"
  },
  "status": "accepted",
  "conclusion": "no-changes",
  "stats": {
    "added": 0,
    "removed": 0,
    "unchanged": 0,
    "changed": 0,
    "ignored": 0,
    "failure": 0,
    "retryFailure": 0,
    "total": 0
  },
  "metadata": {
    "testReport": {
      "status": "passed",
      "stats": {
        "startTime": "string",
        "duration": 0
      }
    }
  },
  "url": "http://example.com",
  "notification": {
    "description": "string",
    "context": "string",
    "github": {
      "state": "pending"
    },
    "gitlab": {
      "state": "pending"
    },
    "url": "http://example.com"
  }}
```

--------------------------------

### cURL request to list build diffs

Source: https://snapvisor.io/docs/api-reference/builds/listBuildDiffs

Sends a GET request to the Snapvisor API to list diffs for a build. Requires an Authorization Bearer token.

```bash
curl -X GET "https://api.snapvisor.io/v2/projects/string/string/builds/string/diffs" \  -H "Authorization: Bearer "
```

--------------------------------

### Lost Pixel pageShots configuration

Source: https://snapvisor.io/docs/migrate-from-lost-pixel

Example of a legacy Lost Pixel configuration using pageShots.

```javascript
// lostpixel.config.js
export const config = {
  pageShots: {
    baseUrl: "http://localhost:3000",
    pages: [{ path: "/", name: "home" }],
    mask: [{ selector: "[data-testid=timestamp]" }],
    breakpoints: [375, 1280],
    fullPage: true,
  },
};
```
Tokens:
Raw