Skip to content

Commit 54cbf9b

Browse files
Mic92mergify[bot]
authored andcommitted
docs/cli: sync with actual output
1 parent 024e3d4 commit 54cbf9b

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

docs/cli.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,54 @@
11
# CLI
22

33
```
4-
Usage: nixos-anywhere [options] ssh-host
4+
Usage: nixos-anywhere [options] <ssh-host>
55
66
Options:
77
8-
* -f, --flake flake
9-
set the flake to install the system from
10-
* -s, --store-paths
8+
* -f, --flake <flake_uri>
9+
set the flake to install the system from.
10+
* -i <identity_file>
11+
selects which SSH private key file to use.
12+
* -p, --ssh-port <ssh_port>
13+
set the ssh port to connect with
14+
* --ssh-option <ssh_option>
15+
set an ssh option
16+
* -L, --print-build-logs
17+
print full build logs
18+
* --env-password
19+
set a password used by ssh-copy-id, the password should be set by
20+
the environment variable SSH_PASS
21+
* -s, --store-paths <disko-script> <nixos-system>
1122
set the store paths to the disko-script and nixos-system directly
1223
if this is given, flake is not needed
13-
* --kexec url
24+
* --no-reboot
25+
do not reboot after installation, allowing further customization of the target installation.
26+
* --kexec <path>
1427
use another kexec tarball to bootstrap NixOS
28+
* --kexec-extra-flags
29+
extra flags to add into the call to kexec, e.g. "--no-sync"
30+
* --post-kexec-ssh-port <ssh_port>
31+
after kexec is executed, use a custom ssh port to connect. Defaults to 22
32+
* --copy-host-keys
33+
copy over existing /etc/ssh/ssh_host_* host keys to the installation
34+
* --stop-after-disko
35+
exit after disko formatting, you can then proceed to install manually or some other way
36+
* --extra-files <path>
37+
path to a directory to copy into the root of the new nixos installation.
38+
Copied files will be owned by root.
39+
* --disk-encryption-keys <remote_path> <local_path>
40+
copy the contents of the file or pipe in local_path to remote_path in the installer environment,
41+
after kexec but before installation. Can be repeated.
42+
* --no-substitute-on-destination
43+
disable passing --substitute-on-destination to nix-copy
1544
* --debug
1645
enable debug output
46+
* --option <key> <value>
47+
nix option to pass to every nix related command
48+
* --from <store-uri>
49+
URL of the source Nix store to copy the nixos and disko closure from
50+
* --build-on-remote
51+
build the closure on the remote machine instead of locally and copy-closuring it
52+
* --vm-test
53+
build the system and test the disk configuration inside a VM without installing it to the target.
1754
```

0 commit comments

Comments
 (0)