Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rewrite README #6

Merged
merged 1 commit into from
Dec 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
# Introduction
# Genealogos
The Genealogos project is a tool that takes output from Nix evaluation tools
and produces SBOM files. Currently, it takes input from [nixtract][nixtract]
and produces json output compliant with the [CycloneDX][cyclonedx] 1.5
specification. Output from Genealogos can be used by various other tools to
perform further analysis. Any tool that takes JSON in the CycloneDX format
should accept Genealogos' output.

Genealogos is a project to leverage the nixpkgs project to generate CycloneDX SBOMs files, and easy to read HTML SBOM reports.
The project is still very early stages, so the output may as of yet be of little
use.

## Using Genealogos
This section assumes you are using the latest `main` version version of [nixtract][nixtract].

### Analyzing a package from your system nixpkgs channel
```fish
nixtract --target-attribute-path hello - | genealogos
```

### Analyzing a local flake
```fish
nixtract --target-flake-ref /path/to/your/local/flake - | genealogos
```

For more `nixtract` arguments, see `nixtract --help`.

## Building Genealogos
`nix build` or `cargo build`. A development shell is present via `nix devel`.

[cyclonedx]: https://cyclonedx.org/
[nixtract]: https://github.com/tweag/nixtract/
Loading