Merge pull request #571 from a-kenji/ke-update-cli-docs

docs: Update the CLI documentation

Author: Mic92

docs/cli.md

@@ -1,14 +1,19 @@
 # CLI
 
+<!-- `$ nix run . -- --help` -->
+
 ```
 Usage: nixos-anywhere [options] [<ssh-host>]
 
 Options:
 
 * -f, --flake <flake_uri>
-  set the flake to install the system from.
+  set the flake to install the system from. i.e.
+  nixos-anywhere --flake .#mymachine
+  Also supports variants:
+  nixos-anywhere --flake .#nixosConfigurations.mymachine.config.virtualisation.vmVariant
 * --target-host <ssh-host>
-  specified the SSH target host to deploy onto.
+  set the SSH target host to deploy onto.
 * -i <identity_file>
   selects which SSH private key file to use.
 * -p, --ssh-port <ssh_port>
@@ -24,8 +29,6 @@ Options:
 * -s, --store-paths <disko-script> <nixos-system>
   set the store paths to the disko-script and nixos-system directly
   if this is given, flake is not needed
-* --no-reboot
-  do not reboot after installation, allowing further customization of the target installation.
 * --kexec <path>
   use another kexec tarball to bootstrap NixOS
 * --kexec-extra-flags
@@ -36,18 +39,24 @@ Options:
   after kexec is executed, use a custom ssh port to connect. Defaults to 22
 * --copy-host-keys
   copy over existing /etc/ssh/ssh_host_* host keys to the installation
-* --stop-after-disko
-  exit after disko formatting, you can then proceed to install manually or some other way
 * --extra-files <path>
   contents of local <path> are recursively copied to the root (/) of the new NixOS installation. Existing files are overwritten
-  Copied files will be owned by root. See documentation for details.
+  Copied files will be owned by root unless specified by --chown option. See documentation for details.
+* --chown <path> <ownership>
+  change ownership of <path> recursively. Recommended to use uid:gid as opposed to username:groupname for ownership.
+  Option can be specified more than once.
 * --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,
   after kexec but before installation. Can be repeated.
 * --no-substitute-on-destination
   disable passing --substitute-on-destination to nix-copy
+  implies --no-use-machine-substituters
+* --no-use-machine-substituters
+  don't copy the substituters from the machine to be installed into the installer environment
 * --debug
   enable debug output
+* --show-trace
+  show nix build traces
 * --option <key> <value>
   nix option to pass to every nix related command
 * --from <store-uri>
@@ -56,6 +65,22 @@ Options:
   build the closure on the remote machine instead of locally and copy-closuring it
 * --vm-test
   build the system and test the disk configuration inside a VM without installing it to the target.
+* --generate-hardware-config nixos-facter|nixos-generate-config <path>
+  generate a hardware-configuration.nix file using the specified backend and write it to the specified path.
+  The backend can be either 'nixos-facter' or 'nixos-generate-config'.
+* --phases
+  comma separated list of phases to run. Default is: kexec,disko,install,reboot
+  kexec: kexec into the nixos installer
+  disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
+  install: install the system
+  reboot: unmount the filesystems, export any ZFS pools and reboot the machine
+* --disko-mode disko|mount|format
+  set the disko mode to format, mount or destroy. Default is disko.
+  disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
+* --no-disko-deps
+  This will only upload the disko script and not the partitioning tools dependencies.
+  Installers usually have dependencies available.
+  Use this option if your target machine has not enough RAM to store the dependencies in memory.
 * --build-on auto|remote|local
   sets the build on settings to auto, remote or local. Default is auto.
   auto: tries to figure out, if the build is possible on the local host, if not falls back gracefully to remote build