Install

RequirementsCopy Anchor Link

• Node.js ≥ 20
• npm, pnpm, yarn, or bun

Global installCopy Anchor Link

npm install -g equall-cli

After install, the equall binary is on your PATH:

equall --help
equall scan .

One-off runCopy Anchor Link

If you don't want a global install, use npx:

npx equall-cli scan .

To pin the release these docs describe, use npx equall-cli@0.3.3 scan ..

Note: the binary is equall, but the npm package name is equall-cli. Use the package name with npx and npm install; the binary name everywhere else.

Supported file typesCopy Anchor Link

Equall scans .html, .htm, .jsx, .tsx, .vue, .svelte, .astro. Pass a directory and Equall discovers them via globby, respecting .gitignore.

By default it skips dependencies, build output and test files: node_modules/, dist/, build/, .next/, .nuxt/, coverage/, storybook-static/, __tests__/, and *.min.*, *.test.*, *.spec.*, *.stories.* files. The skip applies below the path you scan, so equall scan dist/ still scans your built pages. --exclude adds to this list.

UninstallCopy Anchor Link

npm uninstall -g equall-cli