Skip to content

Commit

Permalink
doc: update getting started
Browse files Browse the repository at this point in the history
Now that nixos-facter is in nixpkgs, it's possible to run it from there as well as the flake.
  • Loading branch information
brianmcgee committed Sep 18, 2024
1 parent d78cd60 commit cc817a8
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions docs/content/getting-started/generate-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,25 @@

To generate a report, you will need to have [Nix] installed on the target machine.

```shell
sudo nix run \
--option experimental-features "nix-command flakes" \
--option extra-substituters https://numtide.cachix.org \
--option extra-trusted-public-keys numtide.cachix.org-1:2ps1kLBUWjxIneOy1Ik6cQjb41X0iXVXeHigGmycPPE= \
github:numtide/nixos-facter -- -o facter.json
```
=== "Flake"

```shell
sudo nix run \
--option experimental-features "nix-command flakes" \
--option extra-substituters https://numtide.cachix.org \
--option extra-trusted-public-keys numtide.cachix.org-1:2ps1kLBUWjxIneOy1Ik6cQjb41X0iXVXeHigGmycPPE= \
github:numtide/nixos-facter -- -o facter.json
```

!!! warning

The latest report output from `main` may be incompatible. Run from [nixpkgs] to ensure a stable report output.

!!! note
=== "Nixpkgs"

In the near-future we will add [nixos-facter] to [nixpkgs]. Until then, we recommend using the [Numtide Binary Cache]
to avoid having to build everything from scratch.
```shell
sudo nix run nixpkgs#nixos-facter -- -o facter.json
```

This will scan your system and produce a JSON-based report in a file named `facter.json`:

Expand Down

0 comments on commit cc817a8

Please sign in to comment.