cli

package

v0.1.0-rc.1 Latest Latest Go to latest Published: Sep 9, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

func ExitCode(err error) int

ExitCode maps command errors to stable process exit codes: 0 success, 1 runtime failure, 2 usage error.

type Command struct {
	Name     string
	Aliases  []string
	Summary  string
	Usage    string
	Long     string
	Run      RunFunc
	Children []*Command
}

Command describes one CLI command. Commands can be nested arbitrarily.

func (c *Command) Execute(ctx context.Context, args []string, out, errOut io.Writer) error

Execute routes args through the command tree and handles help consistently.

func (c *Command) Help(w io.Writer)

Help renders stable, human-readable command documentation.

type RunFunc func(context.Context, []string, io.Writer, io.Writer) error

RunFunc executes a command after command routing and built-in help handling.

type UsageError struct {
	Message string
	Hint    string
}

UsageError represents invalid user input. Callers should exit with code 2.

func (e *UsageError) Error() string