cli

package

v0.2.5 Latest Latest Go to latest Published: Apr 12, 2026 License: MIT Imports: 9 Imported by: 0

Details

Package cli contains shared runtime helpers for CLI binaries.

This section is empty.

This section is empty.

func LoadYAML(path string, cfg any, name string) error

LoadYAML merges YAML configuration from path into cfg.

func New(app any, cfg Config, options ...kong.Option) (*kong.Kong, error)

New constructs a Kong parser for app with the provided runtime config.

func NewLogger(level zerolog.Level) zerolog.Logger

NewLogger constructs the standard console logger for a CLI binary.

func Options(cfg Config) []kong.Option

Options returns the default Kong options for a CLI runtime config.

func Parse(app any, cfg Config, options ...kong.Option) *kong.Context

Parse parses process arguments using the shared CLI runtime config.

func Run(ctx *kong.Context, log zerolog.Logger, args ...any) error

Run executes the selected Kong command with the shared logger injected first.

func SubLogger(log zerolog.Logger, subsystem string) zerolog.Logger

SubLogger returns a logger rebound to the provided subsystem name.

type BuildInfo struct {
	Name    string
	Version string
	Commit  string
}

BuildInfo describes resolved build metadata for a CLI binary.

func ResolveBuildInfo(name string) BuildInfo

ResolveBuildInfo returns build metadata with runtime build info fallbacks.

type Config struct {
	Description string
	BuildInfo   BuildInfo
}

Config defines shared runtime settings for parser construction.