cli

Oct 28, 2025

Changes in this version

+ const ExitError

+ const ExitInternalError

+ const ExitNotFound

+ const ExitSuccess

+ const ExitUnauthorized

+ const ExitUsageError

+ var Blue = color.New(color.FgBlue).SprintFunc()

+ var Bold = color.New(color.Bold).SprintFunc()

+ var BoldBlue = color.New(color.FgBlue, color.Bold).SprintFunc()

+ var BoldGreen = color.New(color.FgGreen, color.Bold).SprintFunc()

+ var BoldRed = color.New(color.FgRed, color.Bold).SprintFunc()

+ var BoldYellow = color.New(color.FgYellow, color.Bold).SprintFunc()

+ var Cyan = color.New(color.FgCyan).SprintFunc()

+ var ErrCircularDependency = errors.New("circular plugin dependency detected")

+ var ErrCommandNotFound = errors.New("command not found")

+ var ErrFlagInvalid = errors.New("invalid flag value")

+ var ErrFlagRequired = errors.New("required flag missing")

+ var ErrInvalidArguments = errors.New("invalid arguments")

+ var ErrPluginAlreadyRegistered = errors.New("plugin already registered")

+ var ErrPluginNotFound = errors.New("plugin not found")

+ var Gray = color.New(color.FgHiBlack).SprintFunc()

+ var Green = color.New(color.FgGreen).SprintFunc()

+ var Italic = color.New(color.Italic).SprintFunc()

+ var Magenta = color.New(color.FgMagenta).SprintFunc()

+ var Red = color.New(color.FgRed).SprintFunc()

+ var Underline = color.New(color.Underline).SprintFunc()

+ var White = color.New(color.FgWhite).SprintFunc()

+ var Yellow = color.New(color.FgYellow).SprintFunc()

+ func AppFromContext(ctx CommandContext) (forge.App, bool)

+ func Colorize(colorFunc func(...any) string, s string) string

+ func ConfigureColors(config ColorConfig)

+ func FormatError(err error, colors bool) string

+ func GenerateBashCompletion(cli CLI, w io.Writer) error

+ func GenerateFishCompletion(cli CLI, w io.Writer) error

+ func GenerateZshCompletion(cli CLI, w io.Writer) error

+ func GetExitCode(err error) int

+ func GetService[T any](ctx CommandContext, name string) (T, error)

+ func MultiSelectAsync(ctx context.Context, question string, loader OptionsLoader) ([]string, error)

+ func MultiSelectWithProgressFeedback(ctx context.Context, question string, loader ProgressLoader) ([]string, error)

+ func MultiSelectWithRetry(ctx context.Context, question string, loader OptionsLoader, maxRetries int) ([]string, error)

+ func MustGetApp(ctx CommandContext) forge.App

+ func MustGetService[T any](ctx CommandContext, name string) T

+ func PromptPassword(question string) (string, error)

+ func PromptWithDefault(question, defaultValue string) (string, error)

+ func SelectAsync(ctx context.Context, question string, loader OptionsLoader) (string, error)

+ func SelectWithProgressFeedback(ctx context.Context, question string, loader ProgressLoader) (string, error)

+ func SelectWithRetry(ctx context.Context, question string, loader OptionsLoader, maxRetries int) (string, error)

+ func WithApp(app forge.App) func(*Config)

+ type BasePlugin struct

+ func NewBasePlugin(name, version, description string) *BasePlugin

+ func (p *BasePlugin) AddCommand(cmd Command)

+ func (p *BasePlugin) AddDependency(dep string)

+ func (p *BasePlugin) Commands() []Command

+ func (p *BasePlugin) Dependencies() []string

+ func (p *BasePlugin) Description() string

+ func (p *BasePlugin) Initialize() error

+ func (p *BasePlugin) Name() string

+ func (p *BasePlugin) SetCommands(commands []Command)

+ func (p *BasePlugin) SetDependencies(dependencies []string)

+ func (p *BasePlugin) Version() string

+ type CLI interface

+ AddCommand func(cmd Command) error

+ Commands func() []Command

+ Description func() string

+ Flag func(name string, opts ...FlagOption) Flag

+ Name func() string

+ Plugins func() []Plugin

+ RegisterPlugin func(plugin Plugin) error

+ Run func(args []string) error

+ SetErrorHandler func(handler func(error))

+ SetOutput func(w io.Writer)

+ Version func() string

+ func New(config Config) CLI

+ func NewForgeIntegratedCLI(app forge.App, config Config) CLI

+ type CLIError struct

+ Cause error

+ ExitCode int

+ Message string

+ func NewError(message string, exitCode int) *CLIError

+ func WrapError(err error, message string, exitCode int) *CLIError

+ func (e *CLIError) Error() string

+ func (e *CLIError) Unwrap() error

+ type CLILogger struct

+ func NewCLILogger(opts ...LoggerOption) *CLILogger

+ func (l *CLILogger) Debug(msg string, args ...any)

+ func (l *CLILogger) Error(msg string, args ...any)

+ func (l *CLILogger) Info(msg string, args ...any)

+ func (l *CLILogger) NewLine()

+ func (l *CLILogger) Print(msg string, args ...any)

+ func (l *CLILogger) Printf(format string, args ...any)

+ func (l *CLILogger) Println(args ...any)

+ func (l *CLILogger) Separator()

+ func (l *CLILogger) SetColors(enabled bool)

+ func (l *CLILogger) SetLevel(level LogLevel)

+ func (l *CLILogger) SetOutput(w io.Writer)

+ func (l *CLILogger) Success(msg string, args ...any)

+ func (l *CLILogger) Warning(msg string, args ...any)

+ type ColorConfig struct

+ Enabled bool

+ ForceColor bool

+ NoColor bool

+ func DefaultColorConfig() ColorConfig

+ type Command interface

+ AddFlag func(flag Flag)

+ AddSubcommand func(cmd Command) error

+ After func(fn MiddlewareFunc) Command

+ Aliases func() []string

+ Before func(fn MiddlewareFunc) Command

+ Description func() string

+ FindSubcommand func(name string) (Command, bool)

+ Flags func() []Flag

+ Name func() string

+ Parent func() Command

+ Run func(ctx CommandContext) error

+ SetParent func(parent Command)

+ Subcommands func() []Command

+ Usage func() string

+ func NewCommand(name, description string, handler CommandHandler, opts ...CommandOption) Command

+ type CommandContext interface

+ App func() forge.App

+ Arg func(index int) string

+ Args func() []string

+ Bool func(name string) bool

+ Command func() Command

+ Confirm func(question string) (bool, error)

+ Context func() context.Context

+ Duration func(name string) int64

+ Error func(err error)

+ Flag func(name string) FlagValue

+ Info func(msg string)

+ Int func(name string) int

+ Logger func() *CLILogger

+ MultiSelect func(question string, options []string) ([]string, error)

+ MultiSelectAsync func(question string, loader OptionsLoader) ([]string, error)

+ MultiSelectWithRetry func(question string, loader OptionsLoader, maxRetries int) ([]string, error)

+ NArgs func() int

+ Printf func(format string, a ...any)

+ Println func(a ...any)

+ ProgressBar func(total int) ProgressBar

+ Prompt func(question string) (string, error)

+ Select func(question string, options []string) (string, error)

+ SelectAsync func(question string, loader OptionsLoader) (string, error)

+ SelectWithRetry func(question string, loader OptionsLoader, maxRetries int) (string, error)

+ Spinner func(message string) Spinner

+ String func(name string) string

+ StringSlice func(name string) []string

+ Success func(msg string)

+ Table func() TableWriter

+ Warning func(msg string)

+ type CommandHandler func(ctx CommandContext) error

+ type CommandOption func(*command)

+ func WithAfter(fn MiddlewareFunc) CommandOption

+ func WithAliases(aliases ...string) CommandOption

+ func WithBefore(fn MiddlewareFunc) CommandOption

+ func WithFlag(flag Flag) CommandOption

+ func WithFlags(flags ...Flag) CommandOption

+ func WithSubcommand(sub Command) CommandOption

+ func WithUsage(usage string) CommandOption

+ type Config struct

+ App forge.App

+ Description string

+ ErrorHandler func(error)

+ Logger *CLILogger

+ Name string

+ Output io.Writer

+ Version string

+ type Flag interface

+ DefaultValue func() any

+ Description func() string

+ Name func() string

+ Required func() bool

+ ShortName func() string

+ Type func() FlagType

+ Validate func(value any) error

+ func NewBoolFlag(name, shortName, description string, defaultValue bool, opts ...FlagOption) Flag

+ func NewDurationFlag(name, shortName, description string, defaultValue time.Duration, ...) Flag

+ func NewFlag(name string, flagType FlagType, opts ...FlagOption) Flag

+ func NewIntFlag(name, shortName, description string, defaultValue int, opts ...FlagOption) Flag

+ func NewStringFlag(name, shortName, description, defaultValue string, opts ...FlagOption) Flag

+ func NewStringSliceFlag(name, shortName, description string, defaultValue []string, opts ...FlagOption) Flag

+ type FlagOption func(*flagConfig)

+ func Required() FlagOption

+ func ValidateEnum(allowed ...string) FlagOption

+ func ValidateRange(min, max int) FlagOption

+ func WithAlias(alias string) FlagOption

+ func WithBoolFlag(name, shortName, description string, defaultValue bool, opts ...FlagOption) FlagOption

+ func WithDefault(value any) FlagOption

+ func WithDescription(desc string) FlagOption

+ func WithDurationFlag(name, shortName, description string, defaultValue time.Duration, ...) FlagOption

+ func WithIntFlag(name, shortName, description string, defaultValue int, opts ...FlagOption) FlagOption

+ func WithStringFlag(name, shortName, description, defaultValue string, opts ...FlagOption) FlagOption

+ func WithStringSliceFlag(name, shortName, description string, defaultValue []string, opts ...FlagOption) FlagOption

+ func WithValidator(validator func(any) error) FlagOption

+ type FlagType int

+ const BoolFlagType

+ const DurationFlagType

+ const IntFlagType

+ const StringFlagType

+ const StringSliceFlagType

+ type FlagValue interface

+ Bool func() bool

+ Duration func() time.Duration

+ Int func() int

+ IsSet func() bool

+ Raw func() any

+ String func() string

+ StringSlice func() []string

+ type LogLevel int

+ const DebugLevel

+ const ErrorLevel

+ const InfoLevel

+ const SuccessLevel

+ const WarningLevel

+ type LoggerOption func(*loggerConfig)

+ func WithColors(enabled bool) LoggerOption

+ func WithLevel(level LogLevel) LoggerOption

+ func WithOutput(w io.Writer) LoggerOption

+ func WithPrefix(prefix string) LoggerOption

+ type MiddlewareFunc func(next CommandHandler) CommandHandler

+ type OptionsLoader func(ctx context.Context) ([]string, error)

+ type Plugin interface

+ Commands func() []Command

+ Dependencies func() []string

+ Description func() string

+ Initialize func() error

+ Name func() string

+ Version func() string

+ type PluginMetadata struct

+ Commands []string

+ Dependencies []string

+ Description string

+ Name string

+ Version string

+ type PluginRegistry struct

+ func NewPluginRegistry() *PluginRegistry

+ func (r *PluginRegistry) All() []Plugin

+ func (r *PluginRegistry) Count() int

+ func (r *PluginRegistry) Get(name string) (Plugin, error)

+ func (r *PluginRegistry) GetMetadata(name string) (*PluginMetadata, error)

+ func (r *PluginRegistry) Has(name string) bool

+ func (r *PluginRegistry) Metadata() []*PluginMetadata

+ func (r *PluginRegistry) Names() []string

+ func (r *PluginRegistry) Register(plugin Plugin) error

+ func (r *PluginRegistry) RegisterAll(plugins []Plugin) error

+ type ProgressBar interface

+ Finish func(message string)

+ Increment func()

+ Set func(current int)

+ type ProgressLoader func(ctx context.Context, progress func(current, total int, message string)) ([]string, error)

+ type Spinner interface

+ Stop func(message string)

+ Update func(message string)

+ type TableAlignment int

+ const AlignCenter

+ const AlignLeft

+ const AlignRight

+ type TableStyle int

+ const StyleCompact

+ const StyleDefault

+ const StyleMarkdown

+ const StyleRounded

+ const StyleSimple

+ type TableWriter interface

+ AppendRow func(row []string)

+ Render func()

+ SetAlignment func(alignment TableAlignment)

+ SetColumnAlignment func(column int, alignment TableAlignment)

+ SetHeader func(headers []string)

+ SetMaxColumnWidth func(width int)

+ SetMinColumnWidth func(width int)

+ SetStyle func(style TableStyle)