# ValiqAI docs

> ValiqAI tests web apps the way a person would: give it a URL and it signs up, clicks through, runs checks, and reports what is broken with proof. These docs cover setting it up and running it from the terminal or CI.

## Pages

- [ValiqAI docs](https://www.valiqai.com/docs.md): How to set up ValiqAI, run it from your terminal or CI, and read what it finds.
- [Verify your domain](https://www.valiqai.com/docs/verify-domain.md): Prove you own a site once, and ValiqAI can scan it and every subdomain.
- [ValiqAI CLI](https://www.valiqai.com/docs/cli.md): Run a scan from your terminal or CI, and fail the build when it finds blockers.
- [Install and sign in](https://www.valiqai.com/docs/cli-install.md): Install the CLI, sign in from the browser, and give CI a key of its own.
- [Link a project](https://www.valiqai.com/docs/cli-link.md): Tie a repository to its site with valiqai.json, and verify domains from the terminal.
- [Scanning](https://www.valiqai.com/docs/cli-scanning.md): Scan types and costs, what fails the build, timeouts, retries and exit codes.
- [CI output](https://www.valiqai.com/docs/cli-ci-output.md): GitHub summaries and annotations, JUnit, SARIF, Markdown and JSON.
- [AI coding tools (MCP)](https://www.valiqai.com/docs/cli-mcp.md): Let Claude Code, Cursor or VS Code start scans and read problems with valiqai mcp.
- [Configuration](https://www.valiqai.com/docs/cli-configuration.md): Settings, environment variables, which value wins, doctor and shell completion.
- [Troubleshooting](https://www.valiqai.com/docs/cli-troubleshooting.md): Every error the CLI prints, by code, with what to do about it.
- [CLI changelog](https://www.valiqai.com/docs/cli-changelog.md): What changed in each version of the CLI.
- [CLI commands](https://www.valiqai.com/docs/cli-commands.md): Every command and flag, generated from the CLI itself.
- [valiqai scan](https://www.valiqai.com/docs/valiqai-scan.md): Scan a URL, wait for the result, and exit non-zero when it finds problems.
- [valiqai scans](https://www.valiqai.com/docs/valiqai-scans.md): List scans, view one, follow one, or stop one.
- [valiqai problems](https://www.valiqai.com/docs/valiqai-problems.md): A scan's problems, worst first, with the pages each was found on.
- [valiqai domains](https://www.valiqai.com/docs/valiqai-domains.md): Your verified domains: list, add (with the TXT record), verify, remove.
- [valiqai credits](https://www.valiqai.com/docs/valiqai-credits.md): The workspace's credits, and what each scan reserves.
- [valiqai open](https://www.valiqai.com/docs/valiqai-open.md): Open a scan, a domain, or this folder's site in your browser.
- [valiqai login, logout, whoami, switch](https://www.valiqai.com/docs/valiqai-login.md): Sign in and out, see who you are, and change workspace.
- [valiqai link](https://www.valiqai.com/docs/valiqai-link.md): Tie this folder to a site, so valiqai scan needs no URL here.
- [valiqai init](https://www.valiqai.com/docs/valiqai-init.md): Add a CI job that scans your site and fails the build on blockers.
- [valiqai doctor](https://www.valiqai.com/docs/valiqai-doctor.md): Check your setup: Node, the key, ValiqAI, valiqai.json, the domain, credits.
- [valiqai completion](https://www.valiqai.com/docs/valiqai-completion.md): Print a tab-completion script for bash, zsh, fish or PowerShell.
- [valiqai mcp](https://www.valiqai.com/docs/valiqai-mcp.md): Run an MCP server for AI coding tools.
- [valiqai config](https://www.valiqai.com/docs/valiqai-config.md): Show or change saved settings.
- [GitHub Actions](https://www.valiqai.com/docs/ci-github-actions.md): Scan after each deploy, with a summary, annotations and step outputs.
- [GitLab CI](https://www.valiqai.com/docs/ci-gitlab.md): Scan after each deploy, with each test in the merge request.
- [CircleCI](https://www.valiqai.com/docs/ci-circleci.md): Scan after each deploy, with each test in the job's Tests tab.
- [Jenkins](https://www.valiqai.com/docs/ci-jenkins.md): Scan after each deploy, with each test on the build's Test Result page.
- [Bitbucket Pipelines](https://www.valiqai.com/docs/ci-bitbucket.md): Scan after each deploy, with each test in the step's Tests tab.
- [Buildkite](https://www.valiqai.com/docs/ci-buildkite.md): Scan after each deploy, with a JUnit report as an artifact.
- [Azure Pipelines](https://www.valiqai.com/docs/ci-azure-pipelines.md): Scan after each deploy, with each test in the run's Tests tab.
- [Recipes](https://www.valiqai.com/docs/recipes.md): Nightly scans, strict staging, Vercel and Netlify deploys, scripts, matrices and Slack.
- [API overview](https://www.valiqai.com/docs/api.md): Keys, scopes, personal and team keys, and every endpoint.
- [Scans](https://www.valiqai.com/docs/api-scans.md): Start a scan, follow it, read its problems, and stop it.
- [Domains, credits and keys](https://www.valiqai.com/docs/api-domains.md): Verify domains, read credits, and check or revoke the calling key.
- [Webhooks](https://www.valiqai.com/docs/api-webhooks.md): Get a signed POST when a scan ends: events, payloads, retries and checking the signature.
- [Errors](https://www.valiqai.com/docs/api-errors.md): Status codes, the error body, and every error code.
- [Limits and versioning](https://www.valiqai.com/docs/api-limits.md): Rate limits, idempotent retries, and how the API changes.