pog 🤯

Nix-Powered CLI tools

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

Get Started

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

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...";
    }}
  '';
}