Reference
Command line interface
nicos
Options
--help | Show this message and exit. |
Commands
nicos build
Build a machine ISO image.
Options
-k, --private-key-path TEXT | The path to the private key to use. Defaults to ssh_<machine>_ed25519_key. |
--help | Show this message and exit. |
nicos create
Create a new machine in the cluster.
Options
--rekey / --no-rekey | Rekey the secrets after creating the machine configuration. |
--stage / --no-stage | Stage the changes to git. |
--help | Show this message and exit. |
nicos deploy
Deploy one or several existing machines
Options
--all | Deploy all available machines. |
--remote-build | Build on remote host. |
--help | Show this message and exit. |
nicos init
Initialise a new cluster.
Options
--stage / --no-stage | Stage the changes to git. |
--help | Show this message and exit. |
nicos install
Install a machine using nixos-anywhere.
Options
--user TEXT | User that will connect to the machine through nixos-anywhere. |
--remote-build | build the closure on the remote machine instead of locally and copy-closuring it. |
--help | Show this message and exit. |
nicos secrets
Manage the secrets for the cluster
Options
--help | Show this message and exit. |
Commands
nicos secrets edit
Edit a secret
Options
--stage / --no-stage | Stage the changes to git. |
--help | Show this message and exit. |
nicos secrets export
Export the secrets config in the cluster as a JSON object
Options
--help | Show this message and exit. |
nicos secrets list
List the secrets in the cluster
Options
--help | Show this message and exit. |
nicos secrets rekey
Rekey all the secrets in the cluster.
Options
--stage / --no-stage | Stage the changes to git. |
--help | Show this message and exit. |
nicos secrets user
Edit a user password
Options
--stage / --no-stage | Stage the changes to git. |
--force | Force the change without prompt if the secret already exists. |
--help | Show this message and exit. |
nicos secrets vpn
Add or replace a Wireguard private key of a given host
Options
--stage / --no-stage | Stage the changes to git. |
--force | Force the change without prompt if the secret already exists. |
--help | Show this message and exit. |
nicos secrets wifi
Edit wifi networks and passwords
Options
--stage / --no-stage | Stage the changes to git. |
--help | Show this message and exit. |
Was this page helpful?