File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change @@ -11,6 +11,36 @@ A comprehensive SBOM (Software Bill of Materials) generator for systems running
1111- ** License Detection** : Extracts license information from package metadata
1212- ** Package URLs (purl)** : Includes purl references for both deb and nix packages
1313
14+ ## Quick Run
15+
16+ No installation required! Run directly from GitHub:
17+
18+ ### Generate Merged SBOM (Ubuntu + Nix)
19+
20+ ``` bash
21+ # Generate combined SBOM for your system
22+ nix run --extra-experimental-features " nix-command flakes" github:supabase/ubuntu-nix-sbom#sbom-generator -- \
23+ --nix-target /nix/var/nix/profiles/system \
24+ --output system-sbom.json
25+ ```
26+
27+ ### Generate Ubuntu-Only SBOM
28+
29+ ``` bash
30+ # Scan only Ubuntu/Debian packages
31+ nix run --extra-experimental-features " nix-command flakes" github:supabase/ubuntu-nix-sbom#sbom-ubuntu -- \
32+ --output ubuntu-sbom.json
33+ ```
34+
35+ ### Generate Nix-Only SBOM
36+
37+ ``` bash
38+ # Analyze a specific Nix derivation
39+ nix run --extra-experimental-features " nix-command flakes" github:supabase/ubuntu-nix-sbom#sbom-nix -- \
40+ /nix/store/xxx-your-derivation \
41+ --output nix-sbom.json
42+ ```
43+
1444## Prerequisites
1545
1646- Nix with flakes enabled
You can’t perform that action at this time.
0 commit comments