Skip to content

Latest commit

 

History

History
72 lines (54 loc) · 4.94 KB

README.md

File metadata and controls

72 lines (54 loc) · 4.94 KB

Bomly Documentation

New to Bomly? Start with Getting started. Otherwise pick the section that matches what you are doing. The sections follow the navigation groups in manifest.json, plus a few site pages that live outside the versioned docs, such as the FAQ.

Getting started

Install Bomly and run your first scan.

  • Getting Started — first scan, enrich, audit, diff
  • Installation — install methods, bomly vs bomly-lite, checksum verification, uninstall
  • Tutorial — from first scan to a CI gate on a real project, with representative output from the workflow
  • Use Cases — recipes for PR gates, SBOMs, triage, license and offline scans
  • Scan Targets — directories, Git repos, containers, SBOMs
  • Monorepos — recursive discovery, subprojects, and workspace modules
  • Output Formats — text, JSON, SARIF, SBOM
  • SBOM Formats — write, read, convert, and compare SPDX and CycloneDX
  • FAQ — quick answers on privacy, accounts, tool differences, and first-scan surprises (source: faq.json)

How it works

What Bomly does, and why each piece exists.

Operations

Running Bomly in CI and keeping pipelines healthy.

  • Integrations — CI actions, AI agents, code scanning, install channels, plugins, and the marketplace
  • CI Integration — GitHub Actions, GitLab, Jenkins, Azure, CircleCI
  • CI-Readiness Warnings — package-manager, lockfile-format, and install-policy mismatches that fail CI on their own
  • Finding Baselines — keep accepted package findings visible without failing audits
  • Troubleshooting — common errors and fixes

Reference

Specifications, matrices, and design detail. The generated pages (support matrix, config reference, schemas, and the per-component pages) are produced from the code by make generate, so they always match the binary.

Experimental

Features that are still maturing.

  • Reachability — narrowing findings to packages your code can reach

Project