Skip to content

Commit

Permalink
feat: remove the need for --installable
Browse files Browse the repository at this point in the history
  • Loading branch information
Erin van der Veen committed Apr 10, 2024
1 parent f23d02f commit eba8d92
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,19 @@ There are two ways to solve this, either by specifying a specific package `cargo
### `genealogos-cli`
Analyzing a local flake:
```fish
genealogos --installable /path/to/your/local/flake
genealogos /path/to/your/local/flake
```

Analyzing `hello` from nixpkgs:
```fish
genealogos --installable nixpkgs#hello
genealogos nixpkgs#hello
```

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

```fish
nixtract --target-attribute-path hello /tmp/out && genealogos /tmp/out
nixtract --target-attribute-path hello /tmp/out && genealogos -f /tmp/out
```

For more `nixtract` arguments, see `nixtract --help`.
Expand All @@ -81,7 +81,7 @@ Setting backend options:
Any type that implements the `Backend` must have a way to include nar info and only include runtime options.
Genealogos will forward `--include-narinfo` and `--runtime-only` to the backend.
```fish
genealogos --installable nixpkgs#hello --include-narinfo --runtime-only
genealogos --include-narinfo --runtime-only nixpkgs#hello
```

For a full set of options, see:
Expand Down
2 changes: 1 addition & 1 deletion genealogos-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ struct Args {
file: Option<path::PathBuf>,

/// Nix installable (e.g. `nixpkgs#hello`)
#[arg(long, required_unless_present = "file")]
#[arg(required_unless_present = "file")]
installable: Option<String>,

/// Optional path to the output CycloneDX file (default: stdout)
Expand Down

0 comments on commit eba8d92

Please sign in to comment.