Skip to content
Panix

CLI Reference

Every panix invocation follows panix <command> [flags]. The generated help below lists all commands; each reference page covers one command in depth.

Terminal window
> panix --help
Usage: panix <command> [flags]


Universal Nix Deployment Orchestrator


Flags:
  -h, --help       Show context-sensitive help.
      --version    Show version ($PANIX_VERSION)


Commands:
  init [flags]
    Initialize a new panix configuration file


  schema [flags]
    Generate YAML schema for configuration files


  template [flags]
    Process templates and anchors, output the result


  eval [flags]
    Fully evaluate and validate configuration (including templating) for
    execution, output the result


  snapshot --path=STRING [flags]
    View snapshot in TUI


  inspect [flags]
    Inspect machines


  build [flags]
    Build closures


  deploy [flags]
    Do full workflow (inspect -> bootstrap -> build -> transfer -> secrets ->
    activate)


  secrets [flags]
    Deploy secrets to machines


  rollback [flags]
    Rollback to a previous generation, use optional --gen=NUMBER flag (default
    is -1)


  completion [<shell>] [flags]
    Print shell code for initializing tab completion (bash, zsh, fish)


Run "panix <command> --help" for more information on a command.

Command Pages

Section titled “Command Pages”
  • Deploy Flags: full panix deploy flag reference, including dry run
  • Output Modes: --output-mode tui/console/json, file logging, and CI flags
  • Other Commands: init, schema, template, eval, inspect, build, secrets, rollback, snapshot
  • Shell Completion: tab completion for bash, zsh, and fish