pog 🤯

Nix-Powered CLI tools

Create feature-rich CLI tools with Nix and bash - complete with flags, documentation, and more

Get Started

Portable Outputs

View on GitHub

🚀

Pure Nix Power

Create comprehensive CLI tools using pure Nix, leveraging the vast nixpkgs ecosystem

📖

Automatic Documentation

Automatic help text generation, documentation, and tab completion out of the box

🎯

Rich Flag System

Comprehensive flag system with short/long options, env vars, defaults, and interactive prompts

🎨

Terminal Enhancement

Rich terminal colors, styling, and interactive features like spinners and prompts

🛠

Developer Friendly

Helper functions, runtime input management, verbose mode, and automatic shellcheck

⚡

Quick Integration

Easy to integrate with existing Nix projects through overlays or direct imports

📦

Portable Distribution

Turn one pog definition into a host script, an Arx bundle, or an AppImage

Explore portable outputs

Define once, choose how to ship

A normal pog package can also produce three opt-in, single-file outputs:

Output	Dependency model	Good fit
`toHostScript`	Uses commands already installed on the host	Bootstrap scripts and managed fleets
`toArx`	Carries the Nix closure inside an experimental Linux bundle	Internal tools that need exact Nix dependencies
`toAppImage`	Carries the Nix closure inside an AppImage	Distributing a Linux CLI as one familiar artifact

The normal Nix package stays unchanged until one of these outputs is requested. Each format uses the same flags, commands, help, runtime inputs, and script definition.

See the portable outputs guide →

Quick Example

nix

pog {
  name = "deploy";                                     # derivation/script name
  description = "Deploy application to cloud";         # used in the help doc
  flags = [
    pog._.flags.aws.region                             # a flag with bash completion, included in pog
    {
      name = "environment";
      short = "e";                                     # defaults to the first character of the name
      description = "deployment environment";          # used in the help doc
      required = true;                                 # forces the user to specify, or prompts for it
      completion = ''echo "dev staging prod"'';        # used for tab completion
    }
  ];
  script = helpers: ''
    green "Deploying to $environment in $region..."
    ${helpers.spinner {
      command = "kubectl apply -f ./manifests/";
      title = "Deploying...";
    }}
  '';
}