chatsbom 0.2.3

ChatSBOM - Talk to your Supply Chain. Chat with SBOMs.

ChatSBOM

Talk to your Supply Chain. Chat with SBOMs.

ChatSBOM is a CLI tool for deep insights into Software Bill of Materials (SBOM) data.

Motivation

GitHub's Dependency Graph shows which repositories depend on your project, but there's no way to sort dependents by stars (isaacs/github#1537). This makes it difficult for maintainers of popular packages to identify their most important downstream users. ChatSBOM solves this by collecting and indexing SBOM data, enabling queries like "which popular projects use my library?"

Key Features

• Collect: Find high-quality repos on GitHub (stars/language)
• Download: Fetch dependency files (go.mod, package.json, etc.)
• Convert: Transform files to standard SBOM format using Syft
• Index: Load SBOM data into ClickHouse database
• Status: View database statistics and insights
• Query: Search for library dependencies via CLI
• Chat: AI-powered natural language queries

Quick Start

Prerequisites

• uv - Python package manager for fast installation and execution of the CLI tool
• syft - SBOM generation tool for extracting dependency data from project files
• docker - Container runtime for running infrastructure services
• docker-compose - Container orchestration tool for managing multi-container deployments
• clickhouse - Columnar database for storing and querying SBOM metadata efficiently

Usage

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Run commands directly with uvx:

# 1. Collect repository links from GitHub (e.g., top Go repos)
uvx chatsbom collect --language go --min-stars 1000

# 2. Download dependency files
uvx chatsbom download --language go

# 3. Convert to standard SBOM format
uvx chatsbom convert --language go

# 4. Index SBOM data into database
uvx chatsbom index --language go

# 5. Show database statistics
uvx chatsbom status

# 6. Query dependencies
uvx chatsbom query gin --language go

# 7. Launch AI chat interface
uvx chatsbom chat

Architecture

ChatSBOM follows a clean, modular architecture with high cohesion and low coupling:

Command Flow

collect → download → convert → index → status/query/chat
   ↓         ↓          ↓         ↓
 .jsonl    files/    sbom.json  database

Core Modules

• chatsbom.core.config: Centralized configuration management

  • Path conventions (data directories, file naming)
  • Database connection settings
  • GitHub API configuration

• chatsbom.core.repository: Data access layer (Repository Pattern)

  • Abstracts all database operations
  • Uses generators for memory-efficient data streaming
  • Supports batch operations for large datasets

• chatsbom.core.validation: Data validation utilities

  • Validates data flow between commands
  • Ensures data integrity

• chatsbom.commands.*: CLI commands (7 commands)

  • Each command has a single responsibility
  • Decoupled through configuration and repository layers

Use Cases

Asking AI Agent to retrieve the top 10 projects using gin framework.