Skip to content

Commit

Permalink
docs: use the wiki for usage doc
Browse files Browse the repository at this point in the history
  • Loading branch information
louib committed Aug 28, 2023
1 parent 16d4e15 commit 2e4949a
Showing 1 changed file with 2 additions and 18 deletions.
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

`nix2sbom` extracts the SBOM (Software Bill of Materials) from a Nix derivation

📚 Documentation for using `nix2sbom` is here -> https://github.com/louib/nix2sbom/wiki/Use-nix2sbom

> **Warning**
> This repo is still a work-in-progress.
The command-line options and command names might change
Expand All @@ -17,24 +19,6 @@
* Detects and handles patches
* Discovers git URLs (using archive URLs)

## Using
### With flakes
The `-f` argument can be used to target a specific flake reference. For example, run the
following command to generate a SBOM for the default package of the flake in the current directory:
```
nix2sbom -f .#
```

### On NixOS
The SBOM for the current NixOS system can be obtained with the following command:
```
nix2sbom --current-system
```

### Logging
The `NIX2SBOM_LOG_LEVEL` environment variable can be used to tune the logging level.
The accepted values are `DEBUG`, `INFO`, `WARN` and `ERROR`. The default log level is `INFO`.

## Installing

### With Nix
Expand Down

0 comments on commit 2e4949a

Please sign in to comment.