Install

npm add ai-bom-visualizer

Usage

Pipe AI-BOM JSON from stdin and open the result in your browser:

snyk aibom --experimental --json | npx ai-bom-visualizer --view

Options:

• --view, -v — After writing the HTML file, open it in the default system browser.
• --file <path>, -f — Read AI-BOM JSON from a file instead of stdin.
• --output <path>, -o — Write the HTML to this path (default: ai-bom-visual-output-HH-mm-ss.html in the current directory).

Examples:

# From stdin (e.g. Snyk)
snyk aibom --experimental --json | npx ai-bom-visualizer --view

# From a file
npx ai-bom-visualizer --file ./my-bom.json --output report.html --view

Build

Building this package requires the root project’s HTML viewer template. From this package directory, run:

npm run build

This runs build:template:root (builds the template in the repo root), then tsc, tsup, and copies the template into dist/viewer-template.html. If the root template is missing, run npm run build:template from the repository root first.

Contributing

Please consult CONTRIBUTING for guidelines on contributing to this project.

Author

ai-bom-visualizer © Liran Tal, Released under the Apache-2.0 License.