Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qaos.machdel.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Before you begin

If you don’t have one yet, create a QAOS account and set up a project from the QAOS Dashboard. You’ll need a project to run audits and view reports.

​
Prerequisites

Before using QAOS, make sure you have:
  • Node.js 16 or later — Download from nodejs.org
  • Playwright browser binaries — required for the headless browser that powers QAOS
  • A QAOS account — Sign up
Verify your Node.js version: 
node --version
# v18.0.0 or higher recommended
npx is included with Node.js — no separate installation needed.

​
Install Playwright browser binaries

QAOS uses Playwright internally to control a Chromium browser. The browser binaries must be installed separately before your first run: 
npx playwright install chromium
You only need to run this once. If the binaries are missing, QAOS will display a clear error message reminding you to run this command.

​
Run without installing

You can run QAOS directly using npx without installing anything globally: 
npx qaos --version
npx will download the latest version of the CLI on first use and cache it locally.

​
Install globally (optional)

If you prefer to have qaos available as a standalone command, you can install it globally: 
npm install --global qaos
After that, you can run qaos directly instead of npx qaos.

​
Update

To run the latest version with npx, use the @latest tag: 
npx qaos@latest --version
If you installed globally, update with: 
npm install --global qaos@latest

​
Uninstall

If you installed QAOS globally and want to remove it: 
npm uninstall --global qaos
If you only used npx, there is nothing to uninstall — npx caches are managed by npm automatically.

​
Troubleshooting

If you are using npx, make sure you are running npx qaos and not just qaos. If you installed globally and the command is not found, your npm global bin directory may not be in your PATH. Run:
npm bin -g
Add the printed path to your shell’s PATH variable (.bashrc, .zshrc, or equivalent).
QAOS requires Node.js 16 or later. Update using nvm:
nvm install --lts
nvm use --lts

​
Next steps

Once ready, authenticate your CLI to connect it to your QAOS account.