nix-community/disko
1
1
Fork 0
mirror of https://github.com/nix-community/disko.git synced 2024-11-09 20:02:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

update command line reference

Browse Source
This commit is contained in:
Jörg Thalheim 2023-09-15 07:53:30 +02:00 committed by mergify[bot]
parent 0faae8adf6
commit ea3e29fe7d
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference.md
View File

@ -2,29 +2,42 @@
## Module Options ## Module Options
TODO: Still to be documented We are currently having issues beeing able to generate proper
module option documentation for our recursive disko types.
However you can read the available options [here](https://github.com/nix-community/disko/tree/master/lib/types).
Combined wit the [examples](https://github.com/nix-community/disko/tree/master/example) this hopefully gives you an overview.
## # Reference Manual: disko ## # Reference Manual: disko
## Command Line Options ## Command Line Options
``` ```
$ nix run github:nix-community/disko -- Usage: ./disko [options] disk-config.nix
disko [options] disk-config.nix or ./disko [options] --flake github:somebody/somewhere#disk-config
or disko [options] --flake github:somebody/somewhere
With flakes, disk-config is discovered first under the .diskoConfigurations top level attribute
or else from the disko module of a NixOS configuration of that name under .nixosConfigurations.
Options: Options:
* -m, --mode mode * -m, --mode mode
set the mode, either create or mount set the mode, either format, mount or disko
format: create partition tables, zpools, lvms, raids and filesystems
mount: mount the partition at the specified root-mountpoint
disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
* -f, --flake uri * -f, --flake uri
fetch the disko config relative to this flake's root fetch the disko config relative to this flake's root
* --arg name value * --arg name value
pass value to nix-build. can be used to set disk-names for example pass value to nix-build. can be used to set disk-names for example
* --argstr name value * --argstr name value
pass value to nix-build as string pass value to nix-build as string
* --root-mountpoint /mnt * --root-mountpoint /some/other/mnt
where to mount the device tree where to mount the device tree (default: /mnt)
* --dry-run * --dry-run
just show the path to the script instead of running it just show the path to the script instead of running it
* --no-deps
avoid adding another dependency closure to an in-memory installer
requires all necessary dependencies to be available in the environment
* --debug * --debug
run with set -x run with set -x
``` ```