cli

name: cli description: Guidelines for designing and documenting Command Line Interfaces.

Design top-level commands that categorize actions, followed by imperative subcommands (similar to kubectl):

./cmd slack post --channel "#foo"

Ensure the CLI is self-documenting:

Help Flags: All commands and subcommands must describe their function via --help, ideally with examples.
Man Pages: For complex applications, generate or provide a comprehensive man page.

Applications should have the following commands by default:

Shows the version of the built application, based on Go's internal build primitives.

./cmd version
v0.0.0-20260126085723-f3472ac67d26

Applications should have the following flags by default:

Modifies the log/slog behavior for the default logger. Accepts the levels the log/slog accepts.

./cmd --log-level debug