structcli

May 4, 2026

Changes in this version

+ func RegisterType[T any](hooks TypeHooks[T])

+ type CompleteHookFunc = internalhooks.CompleteHookFunc

+ type DecodeHookFunc = internalhooks.DecodeHookFunc

+ type DefineHookFunc = internalhooks.DefineHookFunc

+ type FieldCompleter interface

+ CompletionHooks func() map[string]CompleteHookFunc

+ type FieldHook struct

+ Decode DecodeHookFunc

+ Define DefineHookFunc

+ type FieldHookProvider interface

+ FieldHooks func() map[string]FieldHook

+ type TypeHooks struct

+ Decode DecodeHookFunc

+ Define DefineHookFunc

Apr 30, 2026

Changes in this version

+ const ConfigFlagAnnotation

+ const DefaultModTagName

+ const DefaultValidateTagName

+ func Bind(c *cobra.Command, opts any) error

+ func ExecuteC(cmd *cobra.Command) (*cobra.Command, error)

+ func Setup(cmd *cobra.Command, opts ...SetupOption) error

+ type ContextInjector interface

+ Context func(context.Context) context.Context

+ type SetupOption func(*setupConfig)

+ func WithAppName(name string) SetupOption

+ func WithConfig(opts ...config.Options) SetupOption

+ func WithDebug(opts debug.Options) SetupOption

+ func WithFlagErrors() SetupOption

+ func WithHelpTopics(opts ...helptopics.Options) SetupOption

+ func WithJSONSchema(opts ...jsonschema.Options) SetupOption

+ func WithMCP(opts ...structclimcp.Options) SetupOption

+ type Transformable interface

+ Transform func(context.Context) error

+ type Validatable interface

+ Validate func(context.Context) []error

Apr 23, 2026

Changes in this version

+ func IsHelpTopicCommand(c *cobra.Command) bool

+ func RegisterEnum[E ~string](values map[E][]string)

+ func RegisterIntEnum[E ~int | ~int8 | ~int16 | ~int32 | ~int64](values map[E][]string)

+ func SetupHelpTopics(rootC *cobra.Command, opts helptopics.Options) error

type CommandSchema

+ ConfigFlag string

type FlagSchema

+ EnvOnly bool

Apr 7, 2026

Changes in this version

+ const Version

+ func SetupMCP(rootC *cobra.Command, opts structclimcp.Options) error

Apr 3, 2026

Changes in this version

+ func ExecuteOrExit(cmd *cobra.Command)

+ func HandleError(cmd *cobra.Command, err error, w io.Writer) int

+ func SetupFlagErrors(rootC *cobra.Command)

+ func SetupJSONSchema(rootC *cobra.Command, opts jsonschema.Options) error

+ type CommandSchema struct

+ Aliases []string

+ CommandPath string

+ Description string

+ EnvPrefix string

+ Example string

+ Flags map[string]*FlagSchema

+ Groups map[string][]string

+ Name string

+ Subcommands []string

+ ValidArgs []string

+ func JSONSchema(c *cobra.Command, opts ...jsonschema.Opt) ([]*CommandSchema, error)

+ func (cs *CommandSchema) ToJSONSchema() ([]byte, error)

type DefineOption

+ func WithModTagName(name string) DefineOption

+ func WithValidateTagName(name string) DefineOption

+ type EnumValuer interface

+ EnumValues func() []string

+ type FlagSchema struct

+ Default string

+ Description string

+ Enum []string

+ EnvVars []string

+ FieldPath string

+ Group string

+ Name string

+ Presets []PresetInfo

+ Required bool

+ Shorthand string

+ Type string

+ type PresetInfo struct

+ Name string

+ Value string

+ type StructuredError struct

+ Available []string

+ Command string

+ ConfigFile string

+ EnvVar string

+ Error string

+ ExitCode int

+ Expected string

+ Flag string

+ Got string

+ Hint string

+ Key string

+ Message string

+ Violations []Violation

+ type Violation struct

+ Field string

+ Message string

+ Param string

+ Rule string

+ Value any

Mar 22, 2026

Changes in this version

+ type Base64 []byte

+ type Hex []byte

Feb 15, 2026

Changes in this version

+ func GetConfigViper(c *cobra.Command) *viper.Viper

Jun 22, 2025

Changes in this version

+ func Define(c *cobra.Command, o Options, defineOpts ...DefineOption) error

+ func EnvPrefix() string

+ func GetOrSetAppName(name, cName string) string

+ func GetViper(c *cobra.Command) *viper.Viper

+ func IsDebugActive(c *cobra.Command) bool

+ func Reset()

+ func SetEnvPrefix(str string)

+ func SetupConfig(rootC *cobra.Command, cfgOpts config.Options) error

+ func SetupDebug(rootC *cobra.Command, debugOpts debug.Options) error

+ func SetupUsage(c *cobra.Command)

+ func Unmarshal(c *cobra.Command, opts Options, hooks ...mapstructure.DecodeHookFunc) error

+ func UseConfig(readWhen func() bool) (inUse bool, mes string, err error)

+ func UseConfigSimple(c *cobra.Command) (inUse bool, message string, err error)

+ func UseDebug(c *cobra.Command, w io.Writer)

+ type ContextOptions interface

+ Context func(context.Context) context.Context

+ FromContext func(context.Context) error

+ type DefineOption func(*defineContext)

+ func WithExclusions(exclusions ...string) DefineOption

+ type Options interface

+ Attach func(*cobra.Command) error

+ type TransformableOptions interface

+ Transform func(context.Context) error

+ type ValidatableOptions interface

+ Validate func(context.Context) []error