# Argos Docs

## Documentation

- [Overview](https://argos-ci.com/docs/overview.md): Learn how Argos works and where to start.
- [Quickstart](https://argos-ci.com/docs/quickstart.md): Install Argos, upload your first screenshots, and review your first build.
- [Playwright Quickstart](https://argos-ci.com/docs/quickstart/playwright-quickstart.md): Set up visual testing in your Playwright tests with the Argos Playwright SDK.
- [Vitest Quickstart](https://argos-ci.com/docs/quickstart/vitest-quickstart.md): Set up visual testing in your Vitest browser tests with the Argos Vitest SDK.
- [Storybook Quickstart](https://argos-ci.com/docs/quickstart/storybook-quickstart.md): Set up Argos with Storybook and Vitest to get visual testing and live deployment URLs on every pull request.
- [Storybook Test Runner Quickstart](https://argos-ci.com/docs/quickstart/storybook-quickstart/storybook-test-runner-quickstart.md): Set up visual testing in Storybook with Test Runner and the Argos CLI.
- [Storybook Legacy (\<v8) Quickstart](https://argos-ci.com/docs/quickstart/storybook-quickstart/storybook-legacy-less-than-v8-quickstart.md): Set up visual testing in a legacy Storybook (\<v8) with Storycap and the Argos CLI.
- [Cypress Quickstart](https://argos-ci.com/docs/quickstart/cypress-quickstart.md): Set up visual testing in your Cypress tests with the Argos Cypress SDK.
- [WebdriverIO Quickstart](https://argos-ci.com/docs/quickstart/webdriverio-quickstart.md): Set up visual testing in your WebdriverIO tests with the Argos WebdriverIO SDK.
- [Puppeteer Quickstart](https://argos-ci.com/docs/quickstart/puppeteer-quickstart.md): Set up visual testing in your Puppeteer scripts with the Argos Puppeteer SDK.
- [Any test framework](https://argos-ci.com/docs/quickstart/any-test-framework.md): Set up visual testing with any test framework by uploading screenshots with the Argos CLI.
- [Core concepts](https://argos-ci.com/docs/learn/platform-fundamentals.md): The core concepts behind Argos — builds, baselines, comparisons, and the statuses you see on your pull requests.
- [How Argos detects visual differences](https://argos-ci.com/docs/learn/platform-fundamentals/how-argos-detects-visual-differences.md): Discover how Argos uses deterministic pixel diffing with the odiff library to surface meaningful visual changes.
- [Baseline build](https://argos-ci.com/docs/learn/platform-fundamentals/baseline-build.md): Argos compares screenshots to a chosen baseline build, determined by analyzing the commit history of your Git project.
- [Build modes](https://argos-ci.com/docs/learn/platform-fundamentals/build-modes.md): Compare Argos Continuous Integration mode and Monitoring mode to choose the right one for your workflow.
- [Review workflow](https://argos-ci.com/docs/learn/review-workflow.md): Bring Argos visual changes into your review process across the dashboard, pull requests, and status checks.
- [Builds list](https://argos-ci.com/docs/learn/review-workflow/builds-list.md): Browse, filter, and open builds for a project to scan status and drill into the runs you care about in Argos.
- [Review a build](https://argos-ci.com/docs/learn/review-workflow/review-a-build.md): Review visual changes as a team — request reviewers, comment on the exact pixel or line that changed, discuss in threads, and approve or reject in real time.
- [Pull request comments](https://argos-ci.com/docs/learn/review-workflow/pull-request-comments.md): Get the latest Argos build status and a link to the build page posted automatically on your GitHub pull requests.
- [Summary checks](https://argos-ci.com/docs/learn/review-workflow/summary-checks.md): Configure Argos summary checks to combine commit statuses into one required status check before merging.
- [Tags](https://argos-ci.com/docs/learn/review-workflow/tags.md): Categorize and filter screenshots by tag so you can focus a build review on the changes you care about.
- [Review builds with AI agents](https://argos-ci.com/docs/learn/review-workflow/review-builds-with-ai-agents.md): Let an AI agent read Argos build data to summarize visual changes, check intent, and approve or request changes.
- [Reliability & flakiness](https://argos-ci.com/docs/learn/reliability-and-flakiness.md): Detect unstable tests and use Argos tools and strategies to track and fix flakiness in your visual suite.
- [Flaky test detection](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-test-detection.md): See flaky badges, stability scores, and detailed history so you can review changed tests in Argos with confidence.
- [Tests dashboard](https://argos-ci.com/docs/learn/reliability-and-flakiness/tests-dashboard.md): Get a project-wide view of test stability, with every test ranked by flakiness score in the Argos dashboard.
- [Stabilize screenshots](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests.md): A playbook for tackling visual flakiness, with detection, ignoring noisy changes, and stabilization strategies.
- [Stabilize text rendering](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/stabilize-text-rendering.md): Disable subpixel text and font hinting in Chromium so glyphs render identically across macOS, Linux, and CI.
- [Wait for loading](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/wait-for-loading.md): Use aria-busy so argosScreenshot waits for full page load before capturing, improving screenshot consistency.
- [Wait for background images](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/wait-for-background-images.md): Wait for CSS background images to load before capturing with the waitForBackgroundImages stabilization option.
- [Pause animated GIFs](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/pause-gifs.md): Freeze animated GIFs on their first frame with the pauseGifs stabilization option so they no longer capture a random frame on each run.
- [Stabilize date & time](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/stabilize-date-and-time.md): Hide or freeze dynamic dates and times to remove a common source of flaky visual diffs in Argos.
- [Browser glitches](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/browser-glitches.md): Eliminate browser-induced visual discrepancies like border-radius differences with a consistent test environment.
- [Argos helpers](https://argos-ci.com/docs/learn/reliability-and-flakiness/flaky-tests/argos-helpers.md): Use data-visual-test attributes to hide, remove, or mask dynamic elements for consistent, flake-free screenshots.
- [Deployments](https://argos-ci.com/docs/learn/deployments.md): Deploy your Storybook or static build to a unique Argos URL on every pull request to preview and share it.
- [Use deployments in CI](https://argos-ci.com/docs/learn/deployments/use-deployments-in-ci.md): Run argos deploy from CI to create a deployment on every pull request, with a GitHub Actions Storybook example.
- [Environments](https://argos-ci.com/docs/learn/deployments/environments.md): Understand how Argos assigns each deployment to a preview or production environment from your branch patterns.
- [URLs and domains](https://argos-ci.com/docs/learn/deployments/urls-and-domains.md): Understand the deployment, branch, and production URLs Argos generates and when to share each one.
- [Access protection](https://argos-ci.com/docs/learn/deployments/access-protection.md): Require viewers to sign in before opening deployment URLs to keep your Argos previews private per project.
- [Lifecycle and retention](https://argos-ci.com/docs/learn/deployments/retention.md): How long Argos deployments last, why they can't be overwritten, and how to pick a deploy cadence without cleaning up old builds.
- [How-to guides](https://argos-ci.com/docs/learn/how-to-guides.md): Task-focused guides for wiring Argos into your CI pipeline and expanding what your screenshots cover.
- [CI pipelines](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines.md): Patterns for running Argos efficiently in CI, from monorepos and sharding to preview deployments and subset builds.
- [Parallel testing (sharding)](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/parallel-testing-sharding.md): Collect screenshots from sharded or parallelized test runs into a single Argos build across your CI nodes.
- [Subset builds](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/subset-builds.md): Run subset builds to upload a partial test run without affecting the baseline of screenshots it didn't cover.
- [Skipping a build](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/skipping-a-build.md): Skip an Argos build to report success without screenshots when a required check shouldn't run a visual comparison.
- [Cached CI pipelines (Turborepo, Nx)](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/cached-pipelines.md): Run Argos reliably in pipelines where a task cache like Turborepo or Nx decides which test suites actually run.
- [Monorepos setup](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/monorepos-setup.md): Use build splitting to run separate Argos visual tests for each package or app in your monorepo within one commit.
- [Run on preview deployments](https://argos-ci.com/docs/learn/how-to-guides/ci-pipelines/run-on-preview-deployments.md): Run Argos visual tests against Vercel, Netlify, or Cloudflare preview deployments to catch regressions before merging.
- [Visual coverage](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage.md): Techniques to capture more of your interface, from responsive viewports and injected CSS to non-image file diffs.
- [Responsive viewports](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/responsive-viewports.md): Capture the same page at multiple breakpoints in one test with Argos using Playwright, Cypress, or Puppeteer.
- [Storybook story modes](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/storybook-story-modes.md): Capture separate Storybook snapshots for each mode, combining theme, viewport, and locale globals in Argos.
- [Capture screenshots from URLs](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/capture-screenshots-from-urls.md): Capture screenshots of a list of web pages with Argos using Playwright, Cypress, or Puppeteer.
- [Injecting CSS](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/injecting-css.md): Apply custom CSS at capture time to hide or restyle elements and fix flaky visual diffs in your Argos screenshots.
- [Fallback baselines](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/fallback-baselines.md): Compare a new screenshot against an existing one so variants and A/B tests show real changes instead of appearing as brand new screenshots.
- [Adding ARIA snapshots manually](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/adding-aria-snapshots-manually.md): Include ARIA accessibility snapshots alongside screenshots when uploading files to Argos manually with the CLI.
- [Compare non-image files](https://argos-ci.com/docs/learn/how-to-guides/visual-coverage/compare-non-image-files.md): Upload and diff text-based artifacts like JSON, HTML, Markdown, and CSS in Argos using the CLI files option.
- [Migrate to Argos](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos.md): Step-by-step guides for switching to Argos from Percy, Chromatic, Applitools, native Playwright screenshots, or BackstopJS.
- [Migrate from Percy](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos/from-percy.md): Migrate visual testing from Percy (BrowserStack) to Argos. Replace the Percy SDK and percy exec with the Argos reporter for Playwright, Cypress, or Storybook.
- [Migrate from Chromatic](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos/from-chromatic.md): Migrate visual testing from Chromatic to Argos. Move your Storybook, Playwright, or Cypress visual tests off the chromatic CLI to the Argos SDK.
- [Migrate from Applitools](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos/from-applitools.md): Migrate visual testing from Applitools Eyes to Argos. Replace the eyes.check() lifecycle and the Ultrafast Grid with Argos screenshots for Playwright or Cypress.
- [Migrate from Playwright screenshots](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos/from-playwright-native-screenshots.md): Move from Playwright's built-in toHaveScreenshot() snapshots to Argos. Stop committing PNG baselines to Git and review visual changes on the pull request.
- [Migrate from BackstopJS](https://argos-ci.com/docs/learn/how-to-guides/migrate-to-argos/from-backstopjs.md): Migrate visual testing from self-hosted BackstopJS to Argos. Turn backstop.json scenarios into Playwright screenshots with cloud baselines and pull request review.
- [Integrations](https://argos-ci.com/docs/learn/integrations.md): Connect Argos to your Git provider for pull request statuses, authenticate your CI uploads, and get notified in Slack.
- [GitHub integration](https://argos-ci.com/docs/learn/integrations/github-integration.md): Connect Argos to GitHub for automated visual testing, commit and pull request checks, and baseline selection.
- [GitHub Actions authentication](https://argos-ci.com/docs/learn/integrations/github-actions-authentication.md): Authenticate Argos uploads from GitHub Actions with a project token, OIDC, or tokenless authentication.
- [GitLab integration](https://argos-ci.com/docs/learn/integrations/gitlab-integration.md): Connect Argos to GitLab for visual testing, baseline selection, and direct feedback on your merge requests.
- [Other Git providers](https://argos-ci.com/docs/learn/integrations/other-git-providers.md): Bitbucket and Azure DevOps support in Argos, and how to use Argos with an unsupported Git provider.
- [Slack integration](https://argos-ci.com/docs/learn/integrations/slack-integration.md): Connect Argos to Slack for build notifications and rich previews when you paste an Argos build URL.
- [Microsoft Teams integration](https://argos-ci.com/docs/learn/integrations/microsoft-teams-integration.md): Send Argos build notifications to a Microsoft Teams channel using an incoming webhook.
- [Account & access](https://argos-ci.com/docs/learn/account-and-access.md): Manage your Argos account, configure how your team signs in, and control who can access which projects.
- [Account management](https://argos-ci.com/docs/learn/account-and-access/account-management.md): Create and manage your Argos account, sign up with Google, GitHub, or GitLab, and pick the plan that fits.
- [Analytics](https://argos-ci.com/docs/learn/account-and-access/analytics.md): Track builds, screenshots, change rate, and approval rate across every project in your Argos account — from the dashboard, the REST API, or the CLI.
- [Team members & roles](https://argos-ci.com/docs/learn/account-and-access/team-members-and-roles.md): Invite team members and assign team and project roles to control permissions with role-based access control.
- [GitHub single sign-on](https://argos-ci.com/docs/learn/account-and-access/github-single-sign-on.md): Enable GitHub single sign-on to sync your Argos team with a GitHub organization and let members sign in with GitHub.
- [SAML single sign-on](https://argos-ci.com/docs/learn/account-and-access/saml-single-sign-on.md): Configure SAML single sign-on with providers like Okta or Auth0 to authenticate your Argos team members.
- [Billing & subscription](https://argos-ci.com/docs/learn/billing-and-subscription.md): Understand Argos plans, payment, and usage so you can keep your team's billing under control.
- [Pricing plans](https://argos-ci.com/docs/learn/billing-and-subscription/pricing-plans.md): Compare the Hobby, Pro, and Enterprise plans to find the right Argos pricing for individuals, teams, or companies.
- [How to subscribe](https://argos-ci.com/docs/learn/billing-and-subscription/how-to-subscribe.md): Subscribe to a paid Argos plan through Stripe or GitHub Marketplace, and manage your subscription over time.
- [Usage & spend management](https://argos-ci.com/docs/learn/billing-and-subscription/spend-management.md): Track your team's screenshot usage, understand what happens at your plan limit, and set spend thresholds to get notified or pause builds.
- [Open source](https://argos-ci.com/docs/learn/billing-and-subscription/open-source.md): Find out how qualifying open-source projects can get sponsored, free access to Argos visual testing.
- [Overview](https://argos-ci.com/docs/agents/agents.md): Everything Argos offers to AI agents: an MCP server, a CLI, installable agent skills, and AI-ready documentation.
- [MCP server](https://argos-ci.com/docs/agents/mcp-server.md): Connect AI assistants to Argos with the official MCP server: inspect builds, review visual changes, and manage projects straight from your agent.
- [Agent skills](https://argos-ci.com/docs/agents/agent-skills.md): Installable agent skills that teach your AI assistant the Argos CLI and a complete pull-request visual review workflow.
- [AI-ready docs](https://argos-ci.com/docs/agents/ai-ready-docs.md): The Argos documentation is optimized for LLMs: Markdown for every page, llms.txt indexes, and a docs MCP server.
- [Playwright](https://argos-ci.com/docs/reference/playwright.md): Improve test debugging and boost your visual testing capabilities by combining Argos with your Playwright tests.
- [Vitest](https://argos-ci.com/docs/reference/vitest.md): Integrate visual testing into your Vitest browser tests with Argos. Capture screenshots and snapshots and review visual changes directly within your CI.
- [Storybook](https://argos-ci.com/docs/reference/storybook.md): Integrate visual testing with your Storybook using Argos. This SDK allows you to capture and review visual changes in your Storybook components directly within your CI.
- [Cypress](https://argos-ci.com/docs/reference/cypress.md): Combine Argos with Cypress to stabilize screenshots, wait for fonts and images, and surface test failures.
- [WebdriverIO](https://argos-ci.com/docs/reference/webdriverio.md): Integrating Argos with your WebdriverIO tests to enable visual testing on your application.
- [Puppeteer](https://argos-ci.com/docs/reference/puppeteer.md): Integrating Argos with your Puppeteer tests to enable visual testing on your application.
- [CLI](https://argos-ci.com/docs/reference/argos-command-line-interface-cli.md): Use the Argos CLI to upload screenshots, deploy static builds, inspect builds, and submit reviews from scripts, local workflows, or AI agents.
- [Node.js SDK](https://argos-ci.com/docs/reference/node.js-sdk.md): Upload screenshots programmatically from Node.js scripts, or build your own Argos integration with @argos-ci/core.
- [Screenshot metadata](https://argos-ci.com/docs/reference/screenshot-metadata.md): Attach metadata to screenshots with a companion JSON file to add context on the Argos build page.

## API Reference

- [Introduction](https://argos-ci.com/docs/api-reference/introduction.md): Learn how to authenticate and make requests to the Argos REST API to create builds, fetch results, and automate your visual testing workflow.
- [Pagination](https://argos-ci.com/docs/api-reference/pagination.md): Page through large collections such as builds and diffs using Argos's page-based pagination.
- [Rate limits](https://argos-ci.com/docs/api-reference/rate-limits.md): Understand the Argos API rate limits, the headers returned on every response, and how to handle 429 responses.
- [Errors](https://argos-ci.com/docs/api-reference/errors.md): Learn how the Argos API reports errors, the shape of an error response, and what each HTTP status code means.
- [Users](https://argos-ci.com/docs/api-reference/reference/users.md)
- [Projects](https://argos-ci.com/docs/api-reference/reference/projects.md)
- [Analytics](https://argos-ci.com/docs/api-reference/reference/analytics.md)
- [Builds](https://argos-ci.com/docs/api-reference/reference/builds.md)
- [Reviews](https://argos-ci.com/docs/api-reference/reference/reviews.md)
- [Comments](https://argos-ci.com/docs/api-reference/reference/comments.md)
- [Deployments](https://argos-ci.com/docs/api-reference/reference/deployments.md)
- [Models](https://argos-ci.com/docs/api-reference/reference/models.md)


---

# 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://argos-ci.com/docs/overview.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.