appcmd

type App ¶

type App struct {
	Name        string
	Description string
	Version     string
	BuildDate   string
	BuildCommit string
	CmdList     ICommands

	BeforeCommandRun BeforeCommandRunFunc
}

App is the root application that dispatches CLI arguments to commands.

func (app *App) PrintUsage(w io.Writer)

func (app *App) Run(ctx context.Context, args []string) error

type BeforeCommandRunFunc ¶

type BeforeCommandRunFunc func(ctx context.Context, cmd ICommand) (context.Context, error)

BeforeCommandRunFunc is called once before a command's Run, allowing the caller to enrich or validate the context (logging, tracing, etc.).

type Command ¶

type Command[T any] struct {
	Name        string
	HelpDesc    string
	Exec        CommandFunc[T]
	ContextInit ContextInitFunc
}

Command is a generic command with a typed configuration struct T. The configuration is loaded from defaults, environment variables, and CLI flags using the goconfig library, following the struct tags:

• default:"…" — default value
• env:"…" — environment variable name
• envPrefix:"…" — prefix applied to all env tags in nested structs
• cli:"…" — long CLI flag (without "--")
• json:"…" — display name fallback
• field:"…" — display name (highest priority)

func (c *Command[T]) Cmd() string

func (c *Command[T]) Help() string

func (c *Command[T]) PrintHelp(w io.Writer)

func (c *Command[T]) Run(ctx context.Context, args []string) error

func (c *Command[T]) String() string

func (c *Command[T]) WithInitContext(ctxWrapper ContextInitFunc) *Command[T]

type CommandFunc ¶

type CommandFunc[T any] func(ctx context.Context, args []string, config *T) error

CommandFunc is the execution function for a typed command.

type ContextInitFunc ¶

type ContextInitFunc func(ctx context.Context) (context.Context, error)

ContextInitFunc initializes or enriches the context before command execution.

type HelpProvider ¶

type HelpProvider interface {
	PrintHelp(w io.Writer)
}

HelpProvider is an optional interface commands can implement to print detailed help that includes the configuration options table.

type ICommand ¶

type ICommand interface {
	String() string
	Cmd() string
	Help() string
	Run(ctx context.Context, args []string) error
}

ICommand is the interface all commands must implement.

type ICommands ¶

type ICommands []ICommand

ICommands is a list of commands

func (c ICommands) Get(name string) ICommand