Skip to content

Commit

Permalink
Update README with new API
Browse files Browse the repository at this point in the history
  • Loading branch information
Erin van der Veen committed Jan 22, 2024
1 parent 44f76d1 commit 1e52c8a
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,21 @@ 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 local flake
```fish
genealogos --flake-ref /path/to/your/local/flake
```

### Analyzing a package from your system nixpkgs channel
### Analyzing `hello` from nixpkgs
```fish
nixtract --target-attribute-path hello /tmp/out && genealogos /tmp/out
genealogos --flake-ref nixpkgs --attribute-path hello
```

### Analyzing a local flake
### Using a trace file
This section assumes you are using the latest `main` version version of [nixtract][nixtract].

```fish
nixtract --target-flake-ref /path/to/your/local/flake /tmp/out && genealogos /tmp/out
nixtract --target-attribute-path hello /tmp/out && genealogos /tmp/out
```

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

0 comments on commit 1e52c8a

Please sign in to comment.