`nxbd` CLI Commands¶

This section describes all available commands in the nxbd tool.

Available Commands¶

Build one or more NixOS system configurations without deploying them. This is useful for testing builds or preparing systems for deployment.

Deploy NixOS configurations to one or more remote systems. Supports configuration checks and automatic rebooting if needed.

This command assumes:

Deployment target host address is defined by the hostname and the (optional) FQDN and is obtained via config.networking.fqdnOrHostName.
The local user account that runs nxbd is used for connecting to the target host via SSH.

Deploy a NixOS configuration to the local system.

If no system is specified, it uses the current hostname as the flake attribute selector in the flake of the current working directory.

Run configuration checks on one or more systems. Checks can verify system configuration, SSH keys, and other deployment requirements.

List all available configuration checks along with all their descriptions.

Display detailed status information about one or more NixOS systems, including deployment status, reboot requirements, and system health.