CLI Reference
Complete reference for all niso CLI commands, organized by category.
All commands support --help for detailed usage. Output format can be controlled with --format table|json where applicable.
Package management#
niso init [--template <t>]Initialize a new project with manifest.tomlniso pack [--sign <key>] [--binary <path>]Create a .niso packageniso install <file> [--verify-key <key>]Install a package from a .niso fileniso activate <name> [version] [--dry-run] [--force]Generate unit, setup network, start serviceniso deactivate <name>Stop and disable a serviceniso rollback <name>Switch to previous versionniso remove <name> <version>Delete a specific package versionniso list [--format table|json] [--filter <expr>]List installed packagesniso status [name] [--format table|json]Show service statusniso inspect <file>View package metadata without installingniso verify <file> --key <pubkey>Verify package signatureniso keygen [--output <dir>]Generate Ed25519 signing keypairniso gc [--keep-versions <n>]Garbage collect old versionsniso export <name:version> -o <path>Export as offline .niso fileniso import <path>Install from local .niso fileProcess management#
niso run [--rm] [-d] [-p port] [-e KEY=val] <pkg> [-- args]Run a package (like docker run)niso exec <name> -- <command>Execute command in service environmentniso logs <name> [--follow] [--since <dur>] [--tail <n>]View service logsniso kill <name> [--signal <sig>]Send signal to serviceniso pause <name>Freeze service (cgroup freeze)niso unpause <name>Resume frozen serviceniso wait <name>Wait for oneshot service to completeniso cp <name:path> <local> | <local> <name:path>Copy files to/from serviceniso update <name> --memory <size> --cpus <n>Hot-update resources without restartRegistry#
niso push <file> [--registry <name>]Upload package to registryniso pull <name> [version] [--registry <name>]Download package from registryniso upgrade <name> [version]Pull + install + activateniso search <query> [--registry <name>]Search packagesniso tag <name:version> <name:tag>Create or update a tagniso login [<url>] [--key <key>]Authenticate with a registryniso registry serve [--config <path>]Start registry serverniso registry add <name> <url> [--default]Configure a named registryniso registry create-key --scope <s> --name <n>Create API keyniso registry list-keysList API keysniso registry revoke-key <id>Revoke API keyniso registry gc [--keep-versions <n>]Garbage collect old versionsNetworking#
niso net listList networksniso net create <name> [--subnet <cidr>]Create a networkniso net remove <name>Delete a networkniso net inspect <name>Show network detailsniso net ports [name]Show port mappingsniso net ping <from> <to>Test connectivityniso net rulesShow nftables rulesniso port-forward <name> <host:container>Dynamic port mappingVolumes#
niso volume listList volumesniso volume create <name> [--shared] [--encrypted]Create a volumeniso volume inspect <name>Show volume detailsniso volume remove <name> [--force]Delete a volumeniso volume grant <name> --service <s> --mode <m>Grant accessniso volume revoke <name> --service <s>Revoke accessniso volume snapshot <name>Create tar.zst backupniso volume restore <name> --from <snap>Restore from snapshotniso volume export <name> --output <path>Export for migrationniso volume import <name> --from <path>Import from backupniso volume prune [--dry-run]Cleanup unused volumesniso volume usageShow disk usageniso volume audit [--since <dur>]Volume audit logStacks#
niso stack validate [--file <path>]Validate stack.tomlniso stack up [--file <path>] [--profile <name>]Deploy stackniso stack down [--volumes] [--orphans]Tear down stackniso stack upgrade <service> [version]Upgrade single serviceniso stack status [--file <path>]Show stack statusniso stack diff [--file <path>]Show changesniso stack restart <service>Restart a serviceniso stack logs [-f] [service]View stack logsniso stack wait <service>Wait for serviceniso stack watchWatch for changes and redeployFleet#
niso fleet deploy <name> <ver> [--strategy <s>] [--hosts <label>]Deploy to fleetniso fleet status [--hosts <label>]Fleet statusniso fleet rollback <name> [--hosts <label>]Fleet-wide rollbackniso fleet versions <name>Version per hostniso fleet stack up --file <path> [--hosts <label>]Deploy stack to fleetniso fleet stack diff --file <path>Diff stack across fleetniso context create <name> --host <ssh://...>Create host contextniso context use <name>Switch contextMonitoring#
niso top [name]Live resource usageniso stats [name]Cgroup stats snapshotniso health [name]Health check statusniso health history <name>Health check historyniso events [--follow] [--filter key=val]Lifecycle eventsniso dashboardTUI dashboardniso debug <name>Full debug infoniso scan <pkg|--all> [--advisories <url>]Vulnerability scanniso audit [--service <n>] [--since <dur>]Audit logniso dfDisk usage breakdownniso infoSystem infoIsolation#
niso isolation show <name>Show effective isolation configniso isolation check <name>Validate kernel supportDevelopment#
niso dev run <binary> [--port <p>] [--mount <m>]Run with isolation (no systemd)niso dev watch --build <cmd> --run <cmd>Watch + rebuild + restartniso dev deploy [--registry local]Pack + install + activate + logsniso machine start|stop|status|config|update|resetDevelopment VM managementniso completions bash|zsh|fishGenerate shell completionsGlobal flags#
--host ssh://user@hostRun command on a remote host--format table|jsonOutput format--verbose / -vIncrease log verbosity--quiet / -qSuppress non-essential output--versionShow niso version--help / -hShow helpEnvironment variables#
NISO_LOGLog level (debug, info, warn, error)NISO_SIGNING_KEYPath to signing key for niso packNISO_REGISTRY_KEYRegistry API key for push/pull