Documentation

Audityxe documentation

How do I get started with Audityxe?

Run npx audityxe-cli https://your-site.com in a terminal, or paste your URL on the Audityxe homepage — both return the same scored audit, and the CLI is free with no account and no rate limit.

Quickstart

Web app: open the homepage, paste a public URL, and click Analyze (a free account is required).
Command line: requires Node.js 18.17+.
```
npx audityxe-cli https://example.com
```

CI gate: fail the build below a score.

npx --yes audityxe-cli https://staging.example.com --min-score 75

API: POST /api/audit with a JSON body { "url": "https://example.com" }; see the API docs and the OpenAPI spec.

Reference

What is Audityxe? — overview and what it is not
CLI guide — install, flags, exit codes
Integrations — GitHub Actions, GitLab, Jenkins, CircleCI, Bitbucket, Azure DevOps, Docker, VS Code
Capabilities & limitations — what exists and what doesn't
REST API — endpoint, auth, limits
Methodology — how scores work
Glossary — LCP, CSP, HSTS, DMARC, SAST, GEO and more
Troubleshooting — exit codes, package name, Node version
Changelog

Last reviewed 2026-10-01 against the Audityxe source code. Product names mentioned are trademarks of their respective owners; Audityxe is not affiliated with them.