# Cypress Image Diff Documentation

## Cypress Image Diff Documentation

- [Migrate from v1 to v2](https://cypress.visual-image-diff.dev/migrate-from-v1-to-v2.md)
- [Getting started](https://cypress.visual-image-diff.dev/getting-started.md)
- [Cypress integration](https://cypress.visual-image-diff.dev/getting-started/cypress-integration.md): Integration with Cypress
- [Typescript](https://cypress.visual-image-diff.dev/getting-started/cypress-integration/typescript.md)
- [Javascript](https://cypress.visual-image-diff.dev/getting-started/cypress-integration/javascript.md)
- [Browserstack](https://cypress.visual-image-diff.dev/getting-started/cypress-integration/browserstack.md): Reference: https://www.browserstack.com/docs/automate/cypress
- [Cypress < v10](https://cypress.visual-image-diff.dev/getting-started/cypress-integration/cypress-less-than-v10.md)
- [cy.compareSnapshot command](https://cypress.visual-image-diff.dev/getting-started/cy.comparesnapshot-command.md): All available options for compareSnapshot command
- [Custom config file](https://cypress.visual-image-diff.dev/getting-started/custom-config-file.md): Options for custom config file
- [ROOT\_DIR](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/root_dir.md)
- [FAILURE\_THRESHOLD](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/failure_threshold.md)
- [RETRY\_OPTIONS](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/retry_options.md)
- [FAIL\_ON\_MISSING\_BASELINE](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/fail_on_missing_baseline.md)
- [COMPARISON\_OPTIONS](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/comparison_options.md)
- [JSON\_REPORT](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/json_report.md)
- [CYPRESS\_SCREENSHOT\_OPTIONS](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/cypress_screenshot_options.md)
- [REPORT\_DIR](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/report_dir.md)
- [SCREENSHOTS\_DIR](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/screenshots_dir.md)
- [NAME\_TEMPLATE](https://cypress.visual-image-diff.dev/getting-started/custom-config-file/name_template.md)
- [Reporting](https://cypress.visual-image-diff.dev/getting-started/reporting.md)
- [JSON report](https://cypress.visual-image-diff.dev/getting-started/reporting/json-report.md)
- [Cypress Image Diff HTML Report](https://cypress.visual-image-diff.dev/getting-started/reporting/cypress-image-diff-html-report.md)
- [Legacy HTML Report](https://cypress.visual-image-diff.dev/getting-started/reporting/legacy-html-report.md)
- [Client options](https://cypress.visual-image-diff.dev/getting-started/client-options.md)
- [Running tests](https://cypress.visual-image-diff.dev/getting-started/running-tests.md): Run lint, unit and e2e tests on the repository
- [Contributing](https://cypress.visual-image-diff.dev/getting-started/contributing.md): Guidelines to contribute to this repository
- [Publishing](https://cypress.visual-image-diff.dev/getting-started/publishing.md): Building and publishing


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://cypress.visual-image-diff.dev/migrate-from-v1-to-v2.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.