Docs · CI

Check every build.

actuity check scans your preview or staging site and fails the build when AI agents would run into a problem, before it reaches production.

GitHub Actions

Add a step after your preview deploys. Store your API key as a repository secret named ACTUITY_API_KEY.

.github/workflows/ci.yml

- name: Check what AI agents run into
  run: npx actuity check "$PREVIEW_URL" --min-score 80
  env:
    ACTUITY_API_KEY: ${{ secrets.ACTUITY_API_KEY }}

Choose when it fails

By default check fails when there is any problem to fix.
--min-score 80 fails only when the score is below 80.
--fail-on none never fails on problems; use it with --min-score alone.

Exit codes

Code	Meaning
0	Done: the check passed.
1	The check fell short: a problem to fix, or a score below --min-score.
2	Wrong usage, like a missing address.
3	Actuity or the scan failed.

The same command works in any CI that runs Node.js 18.17 or newer.

Next: API keys →