CycloneDX Node Module Integration Guide

Integrate the CycloneDX npm module with Vulnetix. Generate a CycloneDX SBOM from your npm project, then upload to Vulnetix.

Install & scan

$ # Run directly without install
npx @cyclonedx/cyclonedx-npm --help

# Or install globally
npm install -g @cyclonedx/cyclonedx-npm
$ npx @cyclonedx/cyclonedx-npm --output-format JSON --output-file bom.json

Run CycloneDX Node Module in CI

Scan on every push and upload the report as a workflow artifact:

- name: Install dependencies
  run: npm ci

- name: Generate CycloneDX SBOM
  run: npx @cyclonedx/cyclonedx-npm --omit dev --flatten-components --output-format JSON --output-file bom.json

- name: Upload report
  uses: actions/upload-artifact@v6
  with:
    name: cyclonedx-node
    path: bom.json
    if-no-files-found: warn

Then one publish job hands every artifact in the run to Vulnetix, recorded under CycloneDX Node Module's own name and version. Written once per workflow, however many scanners you run:

publish:
  name: Publish to Vulnetix
  runs-on: ubuntu-latest
  needs: [scan]        # every scanner job, or its report is never published
  if: always()         # or one failing scanner suppresses all the others
  permissions:
    contents: read
    actions: read      # required to list the run's artifacts
  env:
    VULNETIX_ORG_ID: ${{ secrets.VULNETIX_ORG_ID }}
    VULNETIX_API_KEY: ${{ secrets.VULNETIX_API_KEY }}
  steps:
    - uses: actions/checkout@v5
    - name: Install Vulnetix CLI
      run: |
        curl -fsSL https://cli.vulnetix.com/install.sh | sh -s -- --install-dir "$HOME/.local/bin"
        echo "$HOME/.local/bin" >> "$GITHUB_PATH"
    - name: Publish scanner reports
      env:
        GITHUB_TOKEN: ${{ github.token }}
      run: vulnetix gha upload --org-id "$VULNETIX_ORG_ID" --json

After the run, vulnetix gha status reports what was actually recorded.

How Vulnetix compares: better together

Vulnetix does not replace CycloneDX Node Module. Keep running it. Vulnetix sits on top of CycloneDX Node Module (and every other scanner you already own) turning disconnected tool outputs into one prioritised, fixable queue.

CycloneDX Node Module is strongest at its core category and also carries features in License Compliance, SCA, just as Vulnetix spans categories.

✓ full · ~ partial · ✗ not covered

What CycloneDX Node Module does well

• Official, high-accuracy npm SBOM generator that uses npm's own dependency resolution to produce a complete, deduplicated component inventory including transitive packages
• Runnable via npx with no install, and supports CycloneDX spec versions 1.2–1.6 (default 1.6) in both JSON and XML output
• Faithfully represents the real node_modules nesting (or flattens on demand), and targets OWASP SCVS Level-2 evidence quality (only external signing missing)
• Experimental license-text gathering (--gather-license-texts) collects actual license files from installed components as evidence

Where Vulnetix adds to it: Vulnetix consumes the CycloneDX SBOM this tool emits and adds the layers it deliberately omits: vulnerability and malware matching across the npm tree, install-time package firewall, cross-scanner dedup, EPSS/KEV/LEV exploit-intel prioritisation, reachability, versioned VEX + audit, EOL policy and autofix PRs. It also upgrades output to CycloneDX 1.7 / SPDX 2.3. Better together, the module builds the accurate JS/TS inventory, Vulnetix prioritises and remediates against it.

No migration, no rip-and-replace. CycloneDX Node Module keeps doing what it does best; Vulnetix adds the orchestration, exploit-intelligence prioritisation and remediation layer built for the way AppSec works today.

Centralise CycloneDX Node Module results in Vulnetix

Upload CycloneDX Node Module CycloneDX output to the Vulnetix platform to deduplicate findings, prioritise them with EPSS, CISA KEV and Coalition ESS exploit intelligence, and track remediation across every scanner in a single queue.

CycloneDX Node Module documentation ↗  ·  Source repository ↗

Wire CycloneDX Node Module into your CI/CD pipeline →