Get Inclusa running

Inclusa is a command line tool, like the Angular CLI. Install it once, then run inclusa in any project folder. It is pure JavaScript, assumes Node 20 or newer, and drives a Chromium browser you already have.

Install and run

There are two ways to use it. The recommended way is a global install, so you can run inclusa in any project folder.

npm install -g @xtrable-ltd/inclusa
inclusa

Or add it to a single project as a dev dependency and run it through a script.

npm install -D @xtrable-ltd/inclusa
# then add to that project's package.json scripts: "inclusa": "inclusa"
npm run inclusa

Either way, inclusa boots the studio in your browser, scoped to the folder you ran it in. Its reports save under that project's .inclusa/ directory.

What you need

Node 20 or newer, and a Chromium browser you already have: Chrome, Edge, or Brave. There is no bundled headless download, no native binaries, no compiler, and no admin rights. If your browser is installed somewhere unusual and auto detection misses it, set the INCLUSA_BROWSER environment variable to the executable path.

Scan your first site

In the studio, enter a URL and start a scan. Inclusa opens each page in the browser, runs the checks against the rendered DOM, and builds the report live as it crawls. The donut and bars animate in as each page streams back. When it finishes, you get a conformance scorecard, recommended fixes, and a full drill down by rule and by page.

Use it in CI

The same tool runs headless in a pipeline and sets the exit code so a build can fail on an accessibility regression.

inclusa scan https://staging.example.com --ci --crawl \
  --sarif a11y.sarif --junit a11y.xml

Exit code 0 passes, 2 means the gate failed, and 1 is an execution error.

Where to go next

Browse the features for the full tour, or read about using Inclusa in CI to gate your pipeline.