VisualQ

CI/CD Integration

Automate visual regression testing in your deployment pipeline.

VisualQ integrates with your CI/CD pipeline so visual tests run automatically on every deploy, pull request, or scheduled job.

Integration options

MethodBest for
CLIAny CI system — recommended for GitLab, Jenkins, CircleCI, etc.
GitHub ActionGitHub-hosted repositories
REST APICustom HTTP integrations
MCP / agentsCursor, Claude Desktop, cloud agents
Agent API keysOrg-scoped keys for IDE agents (vq_org_live_…)

CI pipelines use project API keys. IDE agents typically use org agent API keys.

All CI methods support an optional environment parameter to target a specific environment (e.g., staging, production). When omitted, the project's default environment is used.

Typical CI workflow

Developer pushes code

CI pipeline starts

VisualQ runs visual tests

Results posted to PR / Slack / webhook

Team reviews diffs and approves or fixes

In this section

  • Agent API keys — org-scoped keys for Cursor and QA agents
  • API keys — project keys for CI/CD
  • CLI@visualq/cli command reference for all audit types
  • REST API — trigger runs and check status programmatically
  • GitHub Action — official GitHub Action setup
  • Other CI systems — Jenkins, GitLab CI, and more

On this page