Skip to content

Latest commit

 

History

History
177 lines (111 loc) · 3.39 KB

sysdo.md

File metadata and controls

177 lines (111 loc) · 3.39 KB

CLI Documentation: sysdo

Usage:

$ sysdo [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • bootstrap: builds an initial configuration
  • build: builds the specified flake output; infers...
  • cache: cache the output environment of flake.nix
  • clean: remove previously built configurations and...
  • disksetup: configure disk setup for nix-darwin
  • fmt: run formatter on all nix files
  • gc: run garbage collection on unused nix store...
  • switch: builds and activates the specified flake...
  • update: update all flake inputs or optionally...

sysdo bootstrap

builds an initial configuration

Usage:

$ sysdo bootstrap [OPTIONS] [HOST]

Arguments:

  • [HOST]: the hostname of the configuration to build

Options:

  • --nixos / --no-nixos: [default: False]
  • --darwin / --no-darwin: [default: False]
  • --home-manager / --no-home-manager: [default: False]
  • --help: Show this message and exit.

sysdo build

builds the specified flake output; infers correct platform to use if not specified

Usage:

$ sysdo build [OPTIONS] [HOST]

Arguments:

  • [HOST]: the hostname of the configuration to build

Options:

  • --nixos / --no-nixos: [default: False]
  • --darwin / --no-darwin: [default: False]
  • --home-manager / --no-home-manager: [default: False]
  • --help: Show this message and exit.

sysdo cache

cache the output environment of flake.nix

Usage:

$ sysdo cache [OPTIONS]

Options:

  • --cache-name TEXT: [default: kclejeune]
  • --help: Show this message and exit.

sysdo clean

remove previously built configurations and symlinks from the current directory

Usage:

$ sysdo clean [OPTIONS]

Options:

  • --help: Show this message and exit.

sysdo disksetup

configure disk setup for nix-darwin

Usage:

$ sysdo disksetup [OPTIONS]

Options:

  • --help: Show this message and exit.

sysdo fmt

run formatter on all nix files

Usage:

$ sysdo fmt [OPTIONS]

Options:

  • --help: Show this message and exit.

sysdo gc

run garbage collection on unused nix store paths

Usage:

$ sysdo gc [OPTIONS]

Options:

  • -d, --delete-older-than [AGE]: specify minimum age for deleting store paths
  • --dry-run / --no-dry-run: test the result of garbage collection [default: False]
  • --help: Show this message and exit.

sysdo switch

builds and activates the specified flake output; infers correct platform to use if not specified

Usage:

$ sysdo switch [OPTIONS] [HOST]

Arguments:

  • [HOST]: the hostname of the configuration to build

Options:

  • --nixos / --no-nixos: [default: False]
  • --darwin / --no-darwin: [default: False]
  • --home-manager / --no-home-manager: [default: False]
  • --help: Show this message and exit.

sysdo update

update all flake inputs or optionally specific flakes

Usage:

$ sysdo update [OPTIONS]

Options:

  • -f, --flake [FLAKE]: specify an individual flake to be updated
  • --commit / --no-commit: commit the updated lockfile [default: False]
  • --help: Show this message and exit.