@billofmaterial/cli

Bill of Material CLI

Generate comprehensive Software Bill of Materials (SBOM) for your projects with security analysis, risk assessment, and bundle size insights.

Features

• 🔍 Security Analysis - Get security scores and vulnerability insights for all dependencies
• 📦 Bundle Size Analysis - Understand the impact of each dependency on your bundle
• ⚠️ Risk Assessment - Identify high-risk packages with detailed risk factors
• 🏗️ Monorepo Support - Works seamlessly with pnpm, yarn, npm workspaces, and Lerna
• 📊 Comprehensive Reports - Generate markdown and JSON reports
• ⚖️ License Compliance - Identify problematic licenses
• 🏚️ Maintenance Status - Find abandoned or unmaintained packages

Installation

You don't need to install it! Use pnpm dlx (recommended) or npx:

# Using the CLI package directly (recommended)
pnpm dlx @billofmaterial/cli generate

# Using npx
npx billofmaterial/cli generate

# Using yarn
yarn dlx billofmaterial/cli generate

Or install globally:

npm install -g billofmaterial/cli
# or
pnpm add -g billofmaterial/cli

Usage

Generate SBOM

Generate an SBOM for your current project:

billofmaterial/cli generate

Options

billofmaterial/cli generate [options]

Options:
  -p, --path <path>      Path to project directory (default: current directory)
  -o, --output <file>    Output file path (default: "SBOM.md")
  --json                 Also output JSON format
  --no-dev               Exclude dev dependencies
  --no-bundle-size       Skip bundle size analysis
  -h, --help             Display help for command

Examples

# Generate SBOM for current directory
billofmaterial/cli generate

# Generate SBOM for specific project
billofmaterial/cli generate -p ./my-project

# Generate SBOM with custom output
billofmaterial/cli generate -o ./docs/DEPENDENCIES.md

# Generate both markdown and JSON
billofmaterial/cli generate --json

# Skip dev dependencies
billofmaterial/cli generate --no-dev

# Skip bundle size analysis (faster)
billofmaterial/cli generate --no-bundle-size

Web Interface

You can also use the web interface at https://billofmaterial.dev to upload your package.json or entire project and generate SBOM online.

Output

The generated SBOM includes:

• Executive Summary - Overview of dependencies, security scores, and risks
• Key Insights - Top security risks, largest dependencies, license issues
• Dependency Tables - Detailed information for each dependency including:
  • Security scores from Snyk
  • Bundle sizes from Bundlephobia
  • License information
  • Risk assessment
  • Last update date
• Monorepo Support - Separate analysis for each package in monorepos

License

MIT

Links

• Web Interface
• GitHub Repository
• Report Issues