urfave/cli — Full-Featured CLI Framework for Go

Introduction

urfave/cli is one of the most widely used packages for building command-line applications in Go. It provides a declarative API for defining commands, flags, arguments, and shell completions without code generation or external tooling.

What urfave/cli Does

• Defines commands and nested subcommands with a clean declarative struct API
• Parses typed flags including strings, ints, bools, slices, and maps
• Generates help text and usage documentation automatically from definitions
• Provides shell completion scripts for bash, zsh, fish, and PowerShell
• Supports before/after hooks and middleware for cross-cutting command logic

Architecture Overview

The library centers on the Command struct which holds flags, subcommands, and an Action function. At runtime the parser walks the argument list, matches flags and subcommands, and invokes the matching Action with a populated context. Everything is synchronous and runs in a single goroutine unless your Action launches its own concurrency.

Self-Hosting & Configuration

• Import the v3 module path for the latest API
• Define commands as nested Command structs in your main package
• Set environment variable mappings on flags with the Sources field
• Generate shell completion scripts with the built-in enable-bash-completion flag
• No config files or code generation steps are required

Key Features

• Declarative command tree with unlimited nesting depth
• Typed flag parsing with automatic environment variable fallback
• Built-in help, version, and shell completion commands
• Before and After hooks for setup and teardown logic
• Lightweight with zero dependencies outside the Go standard library

Comparison with Similar Tools

• Cobra — uses a builder pattern and code generation; urfave/cli uses declarative structs
• Kong — struct-tag-based parsing; urfave/cli uses explicit flag definitions
• Kingpin — archived and unmaintained; urfave/cli is actively developed
• pflag — flag parsing only; urfave/cli adds commands, help, and completion
• Bubble Tea — TUI framework for interactive apps; urfave/cli is for traditional CLI parsing

FAQ

Q: How does urfave/cli compare to Cobra? A: Both are mature. Cobra uses builder methods and optional code generation. urfave/cli uses plain struct literals with no generators.

Q: Can I use environment variables for flag defaults? A: Yes. Attach an EnvVars source to any flag and it reads the value at parse time.

Q: Does it support persistent flags across subcommands? A: Flags defined on a parent command are inherited by all subcommands automatically.

Q: Is v3 stable? A: v3 is the current major release and is actively maintained with a stable API.

Sources

• https://github.com/urfave/cli
• https://cli.urfave.org