Skip to main content

Installation

Prerequisites​

  • Node.js ≥ 18 (we use ES2020 features)
  • npm 8+

Verify your Node version:

node --version
# v18.x or higher
npm install -g shadowaudit

Verify the install:

shadowaudit --version
# 0.5.0

npx (no install)​

Prefer not to install globally? Use npx:

npx shadowaudit --spec openapi.json --dir ./src

npx downloads the latest version on each run — no local install needed.

Verify it works​

shadowaudit --help

You should see:

Usage: shadowaudit [options]

Static API security scanner for undocumented routes

Options:
  -V, --version       output the version number
  --dir <path>        Directory to scan
  --spec <path>       Path to OpenAPI/Swagger spec file
  --format <type>     Output format: table, json, sarif
  --fail-on <level>   Fail CI pipeline on: critical, high, info
  --framework <name>  Force framework: express, fastapi, django
  -h, --help          display help for command

Next steps​