Command line
Audityxe CLI (audityxe-cli)
How do I run Audityxe from the command line?
Run npx audityxe-cli https://your-site.com — the free audityxe-cli npm package (Node.js 18.17+) runs the full Audityxe audit engine locally with no account, no API key, and no rate limit.
Install
The package on npm is audityxe-cli. Works the same on macOS, Linux, and Windows (PowerShell, Command Prompt, or WSL) anywhere Node.js 18.17+ is installed.
npx audityxe-cli https://example.comnpm install --global audityxe-cli
audityxe https://example.comnpm install --save-dev audityxe-cli
npx audityxe https://example.compnpm add -g audityxe-cli
audityxe https://example.comyarn global add audityxe-cli
audityxe https://example.comnpm view audityxe-cli versionsCommand-line options
| Option | What it does |
|---|---|
| --deep | Real multi-hop crawl: up to 25 pages, 3 hops (default is a fast homepage-sample crawl). |
| --max | Max-coverage crawl: up to 50 pages, 5 hops. |
| --ultra | Ultra-coverage crawl: up to 100 pages, 8 hops, 16 concurrent requests, 3 retries. |
| --compare <url> | Also audit a second URL and print a head-to-head, category-by-category comparison. |
| --psi-key <key> | Your own free Google PageSpeed Insights API key — adds a real-browser Lighthouse pass and the real-user Core Web Vitals (CrUX) module. |
| --min-score <n> | Exit with a non-zero status if the overall score (0–100) is below n. This is the CI gate. |
| --track | Save this run's score to ~/.audityxe/history.json so audityxe history can show the trend. Local only. |
| --json | Print the full result as JSON instead of the formatted terminal report. |
| --no-color | Disable ANSI colors. |
| -h, --help | Show help. |
| -v, --version | Show the CLI version. |
| audityxe history [url] | Subcommand: list tracked URLs, or show one URL's score trend oldest to newest. |
Examples
npx audityxe-cli https://example.com --deep --min-score 80npx audityxe-cli https://yoursite.com --compare https://competitor.comnpx audityxe-cli https://example.com --json > report.jsonnpx audityxe-cli https://example.com --psi-key YOUR_GOOGLE_KEYnpx audityxe-cli https://example.com --track
npx audityxe-cli history https://example.comExit codes
- 0
- Audit completed (and, if --min-score was set, the score met it).
- 1
- The audit failed to run, or the overall score was below --min-score.
- 2
- Invalid command-line arguments (for example a non-numeric --min-score).
Frequently asked questions
How do I install the Audityxe CLI?
Run npx audityxe-cli https://example.com to use it without installing, or install it with npm install --global audityxe-cli. It requires Node.js 18.17 or newer, and the installed command is audityxe.
What is the Audityxe npm package name?
The package is audityxe-cli — there is no package named plain audityxe. Install it with npm, pnpm add -g, or yarn global add using that name.
Is the Audityxe CLI free and does it need an account?
Yes, it is free. It needs no account, no API key, and has no rate limit; it runs the audit engine on your own machine and only contacts the site you audit.
How do I fail a CI build when the score is too low?
Add --min-score <0-100>, for example npx audityxe-cli https://staging.example.com --min-score 75. The command exits with status 1 when the overall score is below the threshold.
Does the Audityxe CLI support a config file, Docker image, or Homebrew?
No. Options are command-line flags only, there is no official Docker image or Homebrew formula, and installation is through npm (or npx).
Does the CLI send any data to Audityxe?
No. It sends no telemetry. Its only network requests go to the URL you audit and, if you pass --psi-key, to Google's PageSpeed Insights API.
Source and license: github.com/zelvior/audityxe — license.
Last reviewed against the Audityxe source code. Product names mentioned are trademarks of their respective owners; Audityxe is not affiliated with them.