nix-community/nixos-anywhere
1
1
Fork 0
mirror of https://github.com/nix-community/nixos-anywhere.git synced 2024-09-17 11:27:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

make usage formatting more consistent

Browse Source
This commit is contained in:
Jörg Thalheim 2023-06-07 07:11:27 +02:00
parent 7c8b2dd689
commit 69443d6929
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/reference.md
View File

@ -19,7 +19,7 @@ TODO: Populate this guide properly
<!-- `$ bash ./src/nixos-anywhere.sh --help` --> <!-- `$ bash ./src/nixos-anywhere.sh --help` -->
``` ```
Usage: nixos-anywhere [options] ssh-host Usage: nixos-anywhere [options] <ssh-host>
Options: Options:
@ -29,27 +29,27 @@ Options:
selects which SSH private key file to use. selects which SSH private key file to use.
* -L, --print-build-logs * -L, --print-build-logs
print full build logs print full build logs
* -s, --store-paths * -s, --store-paths <disko-script> <nixos-system>
set the store paths to the disko-script and nixos-system directly set the store paths to the disko-script and nixos-system directly
if this is give, flake is not needed if this is give, flake is not needed
* --no-reboot * --no-reboot
do not reboot after installation, allowing further customization of the target installation. do not reboot after installation, allowing further customization of the target installation.
* --kexec url * --kexec <url>
use another kexec tarball to bootstrap NixOS use another kexec tarball to bootstrap NixOS
* --stop-after-disko * --stop-after-disko
exit after disko formating, you can then proceed to install manually or some other way exit after disko formating, you can then proceed to install manually or some other way
* --extra-files files * --extra-files <file...>
files to copy into the new nixos installation files to copy into the new nixos installation
* --disk-encryption-keys remote_path local_path * --disk-encryption-keys <remote_path> <local_path>
copy the contents of the file or pipe in local_path to remote_path in the installer environment, copy the contents of the file or pipe in local_path to remote_path in the installer environment,
after kexec but before installation. Can be repeated. after kexec but before installation. Can be repeated.
* --no-substitute-on-destination * --no-substitute-on-destination
disable passing --substitute-on-destination to nix-copy disable passing --substitute-on-destination to nix-copy
* --debug * --debug
enable debug output enable debug output
* --option KEY VALUE * --option <key> <value>
nix option to pass to every nix related command nix option to pass to every nix related command
* --from store-uri * --from <store-uri>
URL of the source Nix store to copy the nixos and disko closure from URL of the source Nix store to copy the nixos and disko closure from
* --build-on-remote * --build-on-remote
build the closure on the remote machine instead of locally and copy-closuring it build the closure on the remote machine instead of locally and copy-closuring it

14
src/nixos-anywhere.sh
View File

@ -3,7 +3,7 @@ set -euo pipefail
showUsage() { showUsage() {
cat <<USAGE cat <<USAGE
Usage: nixos-anywhere [options] ssh-host Usage: nixos-anywhere [options] <ssh-host>
Options: Options:
@ -13,27 +13,27 @@ Options:
selects which SSH private key file to use. selects which SSH private key file to use.
* -L, --print-build-logs * -L, --print-build-logs
print full build logs print full build logs
* -s, --store-paths * -s, --store-paths <disko-script> <nixos-system>
set the store paths to the disko-script and nixos-system directly set the store paths to the disko-script and nixos-system directly
if this is give, flake is not needed if this is give, flake is not needed
* --no-reboot * --no-reboot
do not reboot after installation, allowing further customization of the target installation. do not reboot after installation, allowing further customization of the target installation.
* --kexec url * --kexec <url>
use another kexec tarball to bootstrap NixOS use another kexec tarball to bootstrap NixOS
* --stop-after-disko * --stop-after-disko
exit after disko formating, you can then proceed to install manually or some other way exit after disko formating, you can then proceed to install manually or some other way
* --extra-files files * --extra-files <file...>
files to copy into the new nixos installation files to copy into the new nixos installation
* --disk-encryption-keys remote_path local_path * --disk-encryption-keys <remote_path> <local_path>
copy the contents of the file or pipe in local_path to remote_path in the installer environment, copy the contents of the file or pipe in local_path to remote_path in the installer environment,
after kexec but before installation. Can be repeated. after kexec but before installation. Can be repeated.
* --no-substitute-on-destination * --no-substitute-on-destination
disable passing --substitute-on-destination to nix-copy disable passing --substitute-on-destination to nix-copy
* --debug * --debug
enable debug output enable debug output
* --option KEY VALUE * --option <key> <value>
nix option to pass to every nix related command nix option to pass to every nix related command
* --from store-uri * --from <store-uri>
URL of the source Nix store to copy the nixos and disko closure from URL of the source Nix store to copy the nixos and disko closure from
* --build-on-remote * --build-on-remote
build the closure on the remote machine instead of locally and copy-closuring it build the closure on the remote machine instead of locally and copy-closuring it