redant

May 3, 2026

Changes in this version

+ func PrintCommandsJSON(w io.Writer, cmd *Command) error

+ func PrintFlagsJSON(w io.Writer, rootCmd *Command) error

type StreamEnvelope

+ Seq *int64

+ Ts *int64

Apr 1, 2026

Changes in this version

+ func RunCallback[T any](inv *Invocation, callback func(T) error) error

type Command

+ ResponseHandler ResponseHandler

+ ResponseStreamHandler ResponseStreamHandler

type Invocation

+ func (inv *Invocation) Response() (any, bool)

+ func (inv *Invocation) ResponseStream() <-chan any

+ type InvocationStream struct

+ func NewInvocationStream(ctx context.Context, inv *Invocation) *InvocationStream

+ func (s *InvocationStream) Send(data any) error

+ type ResponseHandler interface

+ Handle func(context.Context, *Invocation) (any, error)

+ TypeInfo func() ResponseTypeInfo

+ func Unary[T any](fn func(context.Context, *Invocation) (T, error)) ResponseHandler

+ type ResponseStreamHandler interface

+ HandleStream func(context.Context, *Invocation, *InvocationStream) error

+ TypeInfo func() ResponseTypeInfo

+ func Stream[T any](fn func(context.Context, *Invocation, *TypedWriter[T]) error) ResponseStreamHandler

+ type ResponseTypeInfo struct

+ Schema string

+ TypeName string

+ type StreamEnvelope struct

+ Data any

+ Kind string

+ Type string

+ type StreamError struct

+ Code int

+ Details any

+ Message string

+ type TypedWriter struct

+ func (w *TypedWriter[T]) Raw() *InvocationStream

+ func (w *TypedWriter[T]) Send(v T) error

Mar 27, 2026

Changes in this version

type Command

+ Metadata map[string]string

+ func (c *Command) Meta(key string) string

Mar 14, 2026

Changes in this version

type Invocation

+ Arg0 string

+ func (inv *Invocation) WithArgv0(arg0 string) *Invocation

Dec 31, 2025

Changes in this version

type Option

+ Action func(val pflag.Value) error

Dec 30, 2025

Changes in this version

type Command

+ func (c *Command) Parent() *Command

type Option

+ func (o Option) Type() string

Dec 24, 2025

Changes in this version

type Command

+ func (c *Command) Run(ctx context.Context) error

type Invocation

+ Annotations map[string]any

Dec 24, 2025

Changes in this version

+ const Version

+ var DiscardValue discardValue

+ func ParseFormArgs(form string) (map[string][]string, error)

+ func ParseJSONArgs(jsonStr string) (map[string][]string, error)

+ func ParseQueryArgs(query string) (map[string][]string, error)

+ func PrintCommands(cmd *Command)

+ func PrintFlags(rootCmd *Command)

+ type Arg struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Value pflag.Value

+ type ArgSet []Arg

+ type Bool bool

+ func BoolOf(b *bool) *Bool

+ func (*Bool) NoOptDefValue() string

+ func (Bool) Type() string

+ func (b *Bool) Set(s string) error

+ func (b Bool) String() string

+ func (b Bool) Value() bool

+ type Command struct

+ Aliases []string

+ Args ArgSet

+ Children []*Command

+ Deprecated string

+ Handler HandlerFunc

+ Hidden bool

+ Long string

+ Middleware MiddlewareFunc

+ Options OptionSet

+ RawArgs bool

+ Short string

+ Use string

+ func (c *Command) FullName() string

+ func (c *Command) FullOptions() OptionSet

+ func (c *Command) FullUsage() string

+ func (c *Command) GetGlobalFlags() OptionSet

+ func (c *Command) Invoke(args ...string) *Invocation

+ func (c *Command) Name() string

+ type Duration time.Duration

+ func DurationOf(d *time.Duration) *Duration

+ func (Duration) Type() string

+ func (d *Duration) MarshalYAML() (any, error)

+ func (d *Duration) Set(v string) error

+ func (d *Duration) String() string

+ func (d *Duration) UnmarshalYAML(n *yaml.Node) error

+ func (d *Duration) Value() time.Duration

+ type Enum struct

+ Choices []string

+ Value *string

+ func EnumOf(v *string, choices ...string) *Enum

+ func (e *Enum) MarshalYAML() (any, error)

+ func (e *Enum) Set(v string) error

+ func (e *Enum) String() string

+ func (e *Enum) Type() string

+ func (e *Enum) UnmarshalYAML(n *yaml.Node) error

+ type EnumArray struct

+ Choices []string

+ Value *[]string

+ func EnumArrayOf(v *[]string, choices ...string) *EnumArray

+ func (e *EnumArray) Append(s string) error

+ func (e *EnumArray) GetSlice() []string

+ func (e *EnumArray) Replace(ss []string) error

+ func (e *EnumArray) Set(v string) error

+ func (e *EnumArray) String() string

+ func (e *EnumArray) Type() string

+ type Float64 float64

+ func Float64Of(f *float64) *Float64

+ func (Float64) Type() string

+ func (f *Float64) Set(s string) error

+ func (f Float64) String() string

+ func (f Float64) Value() float64

+ type HandlerFunc func(i *Invocation) error

+ func DefaultHelpFn() HandlerFunc

+ type HostPort struct

+ Host string

+ Port string

+ func (*HostPort) Type() string

+ func (hp *HostPort) MarshalJSON() ([]byte, error)

+ func (hp *HostPort) MarshalYAML() (any, error)

+ func (hp *HostPort) Set(v string) error

+ func (hp *HostPort) String() string

+ func (hp *HostPort) UnmarshalJSON(b []byte) error

+ func (hp *HostPort) UnmarshalYAML(n *yaml.Node) error

+ type Int64 int64

+ func Int64Of(i *int64) *Int64

+ func (Int64) Type() string

+ func (i *Int64) Set(s string) error

+ func (i Int64) String() string

+ func (i Int64) Value() int64

+ type Invocation struct

+ Args []string

+ Command *Command

+ Flags *pflag.FlagSet

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ func (inv *Invocation) Context() context.Context

+ func (inv *Invocation) CurWords() (prev, cur string)

+ func (inv *Invocation) ParsedFlags() *pflag.FlagSet

+ func (inv *Invocation) Run() (err error)

+ func (inv *Invocation) SignalNotifyContext(parent context.Context, signals ...os.Signal) (ctx context.Context, stop context.CancelFunc)

+ func (inv *Invocation) WithContext(ctx context.Context) *Invocation

+ func (inv *Invocation) WithOS() *Invocation

+ func (inv *Invocation) WithTestParsedFlags(_ testing.TB, parsedFlags *pflag.FlagSet) *Invocation

+ func (inv *Invocation) WithTestSignalNotifyContext(_ testing.TB, ...) *Invocation

+ type MiddlewareFunc func(next HandlerFunc) HandlerFunc

+ func Chain(ms ...MiddlewareFunc) MiddlewareFunc

+ func RequireNArgs(want int) MiddlewareFunc

+ func RequireRangeArgs(start, end int) MiddlewareFunc

+ type NoOptDefValuer interface

+ NoOptDefValue func() string

+ type Option struct

+ Category string

+ Default string

+ Deprecated string

+ Description string

+ Envs []string

+ Flag string

+ Hidden bool

+ Required bool

+ Shorthand string

+ Value pflag.Value

+ type OptionSet []Option

+ func GlobalFlags() OptionSet

+ func (optSet *OptionSet) Add(opts ...Option)

+ func (optSet *OptionSet) Filter(filter func(opt Option) bool) OptionSet

+ func (optSet *OptionSet) FlagSet(name string) *pflag.FlagSet

+ type Regexp regexp.Regexp

+ func (Regexp) Type() string

+ func (r *Regexp) MarshalJSON() ([]byte, error)

+ func (r *Regexp) MarshalYAML() (any, error)

+ func (r *Regexp) Set(v string) error

+ func (r *Regexp) UnmarshalJSON(data []byte) error

+ func (r *Regexp) UnmarshalYAML(n *yaml.Node) error

+ func (r *Regexp) Value() *regexp.Regexp

+ func (r Regexp) String() string

+ type RunCommandError struct

+ Cmd *Command

+ Err error

+ func (e *RunCommandError) Error() string

+ func (e *RunCommandError) Unwrap() error

+ type String string

+ func StringOf(s *string) *String

+ func (*String) NoOptDefValue() string

+ func (String) Type() string

+ func (s *String) Set(v string) error

+ func (s String) String() string

+ func (s String) Value() string

+ type StringArray []string

+ func StringArrayOf(ss *[]string) *StringArray

+ func (StringArray) Type() string

+ func (s *StringArray) Append(v string) error

+ func (s *StringArray) GetSlice() []string

+ func (s *StringArray) Replace(vals []string) error

+ func (s *StringArray) Set(v string) error

+ func (s StringArray) String() string

+ func (s StringArray) Value() []string

+ type Struct struct

+ Value T

+ func (s *Struct[T]) MarshalJSON() ([]byte, error)

+ func (s *Struct[T]) MarshalYAML() (any, error)

+ func (s *Struct[T]) Set(v string) error

+ func (s *Struct[T]) String() string

+ func (s *Struct[T]) Type() string

+ func (s *Struct[T]) UnmarshalJSON(b []byte) error

+ func (s *Struct[T]) UnmarshalYAML(n *yaml.Node) error

+ type URL url.URL

+ func URLOf(u *url.URL) *URL

+ func (*URL) Type() string

+ func (u *URL) MarshalJSON() ([]byte, error)

+ func (u *URL) MarshalYAML() (any, error)

+ func (u *URL) Set(v string) error

+ func (u *URL) String() string

+ func (u *URL) UnmarshalJSON(b []byte) error

+ func (u *URL) UnmarshalYAML(n *yaml.Node) error

+ func (u *URL) Value() *url.URL

+ type UnknownSubcommandError struct

+ Args []string

+ func (e *UnknownSubcommandError) Error() string

+ type Validator struct

+ Value T

+ func Validate[T pflag.Value](opt T, validate func(value T) error) *Validator[T]

+ func (i *Validator[T]) MarshalJSON() ([]byte, error)

+ func (i *Validator[T]) MarshalYAML() (any, error)

+ func (i *Validator[T]) Set(input string) error

+ func (i *Validator[T]) String() string

+ func (i *Validator[T]) Type() string

+ func (i *Validator[T]) Underlying() pflag.Value

+ func (i *Validator[T]) UnmarshalJSON(b []byte) error

+ func (i *Validator[T]) UnmarshalYAML(n *yaml.Node) error

+ type YAMLConfigPath string

+ func (*YAMLConfigPath) Type() string

+ func (p *YAMLConfigPath) Set(v string) error

+ func (p *YAMLConfigPath) String() string