Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 2.01 KB

installation.md

File metadata and controls

92 lines (65 loc) · 2.01 KB

Installation

OWASP.WTF runs on Node.js 20+. Pick the method that suits you.

One-shot (recommended)

No install required:

npx owasp-wtf

npx will fetch the latest CLI, run it, and clean up. Best for trying it out or for CI runners that don't already have it installed.

Global install

npm install -g owasp-wtf
owasp-wtf --version

Use this when you scan often or want shell completion of the binary name.

GitHub Action

For CI, use the reusable composite action — no Node setup required, results upload as a workflow artifact:

- uses: actions/checkout@v4
- uses: decoperations/owasp.wtf@v1
  with:
    severity: high
    fail-on-findings: true

Full reference: GitHub Action.

From source

If you want to hack on the CLI itself:

git clone https://github.com/DecOperations/OWASP.WTF.git
cd OWASP.WTF
pnpm install
pnpm build
node packages/cli/dist/index.js --help

Or link it into your shell's PATH:

pnpm link-cli   # runs `npm link` in packages/cli
owasp-wtf --help

GitHub Packages (org-internal)

The CLI is also published to GitHub Packages as @decoperations/owasp-wtf. Consuming repos in DecOperations or Dial-WTF should follow the dedicated guide — it covers same-org, cross-org (Dial-WTF needs a PAT stored as DECOPERATIONS_NPM_TOKEN), local dev, and the most common 401/404 failures:

➡️ GitHub Packages setup

Quick version for a one-off install:

cat > .npmrc <<'EOF'
@decoperations:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
EOF
NODE_AUTH_TOKEN=ghp_xxx npm install -g @decoperations/owasp-wtf

Verifying the install

owasp-wtf --version
owasp-wtf --help

If owasp-wtf isn't found after a global install, your npm bin -g directory isn't on your PATH. Either add it, or use npx owasp-wtf instead.

Next steps