clix

Documentation

Overview

Package clix provides CLI convenience functions for Frostyard tools, wrapping charmbracelet/fang and spf13/cobra with standardized version injection, common flags, JSON output helpers, and reporter factory.

Index

• Variables
• func BindViper(cmd *cobra.Command) error
• func NewReporter() reporter.Reporter
• func OutputJSON(data any) bool
• func OutputJSONError(message string, err error) error
• type App
  • func (a *App) Run(cmd *cobra.Command) error
  • func (a *App) VersionString() string

Variables

var (
	JSONOutput bool // --json flag value
	Verbose    bool // --verbose / -v flag value
	DryRun     bool // --dry-run / -n flag value
)

Common flag values, populated when Run() registers persistent flags.

Functions

func BindViper

func BindViper(cmd *cobra.Command) error

BindViper binds the common flags (--json, --verbose, --dry-run) to viper. Call this in a PersistentPreRunE if your app uses viper for config management.

func NewReporter

func NewReporter() reporter.Reporter

NewReporter returns the appropriate reporter based on the JSONOutput flag. JSON mode: JSONReporter writing to os.Stdout (for piping/parsing). Text mode: TextReporter writing to os.Stderr (keeps stdout clean for data).

func OutputJSON

func OutputJSON(data any) bool

OutputJSON writes data as indented JSON to stdout if JSONOutput is true. Returns true if output was written, false if JSON mode is not active.

func OutputJSONError

func OutputJSONError(message string, err error) error

OutputJSONError writes a structured error object as JSON to stdout and returns a wrapped error for the caller to propagate.

Types

type App

type App struct {
	Version string
	Commit  string
	Date    string
	BuiltBy string
}

App holds build-time metadata for a CLI application. Create one in main() and call Run() to execute the root command.

func (*App) Run

func (a *App) Run(cmd *cobra.Command) error

Run registers common persistent flags on cmd, then executes the command via fang.Execute with the formatted version string and signal handling.

func (*App) VersionString

func (a *App) VersionString() string

VersionString returns a formatted version string including commit, date, and builder info. Example: "1.2.3 (Commit: abc) (Date: 2026-01-01) (Built by: ci)"