rotini

package module

Go to main page

Versions in this module

v1

v1.4.3

Oct 12, 2026

v1.4.2

Oct 11, 2026

v1.4.1

Oct 11, 2026

v1.4.0

Oct 11, 2026

Changes in this version

+ func ArgvOf[T any](def Definition, v T, set Presence, opts ...ArgvOption) (argv, env []string, err error)

+ func ConfigFilePath(rtx *Context, file string) (path string, exists bool, err error)

+ func ConfigProfiles(rtx *Context, file string) ([]string, error)

+ func OpenInput(rtx *Context, path string) (io.ReadCloser, error)

+ func SetConfigValue(rtx *Context, file, key, raw string, opts ...ConfigWriteOption) error

+ func SortBy[E any](items []E, field string, desc bool) error

+ func UnsetConfigValue(rtx *Context, file, key string, opts ...ConfigWriteOption) error

+ type AppDirectories struct

+ Cache string

+ Config string

+ Data string

+ State string

+ func AppDirs(rtx *Context, app, strategy string) (AppDirectories, error)

type ArgDef

+ DeprecatedSince string

+ EnumValues []EnumValue

+ From []string

+ Glob bool

+ Layouts []string

+ Passthrough bool

+ Relative string

+ RemovedIn string

+ type ArgvError struct

+ Field FieldPath

+ Reason string

+ func (e *ArgvError) Error() string

+ type ArgvOption func(*argvConfig)

+ func ArgvPath(names ...string) ArgvOption

+ func ArgvSecrets() ArgvOption

type Command

+ DeprecatedIdentifiersRemovedIn map[string]string

+ DeprecatedSince string

+ OptionsFirst bool

+ RemovedIn string

+ ReplacedBy string

+ Usage string

type CommandDef

+ DeprecatedIdentifiersRemovedIn map[string]string

+ DeprecatedSince string

+ Effects *Effects

+ ExitStatus []ExitStatusDef

+ HiddenAliases []string

+ Inputs reflect.Type

+ OptionsFirst bool

+ RemovedIn string

+ ReplacedBy string

+ Usage string

+ type CompletionDescriptionsDef struct

+ Env string

+ type CompletionOptions struct

+ KeepOrder bool

+ NoSpace bool

type CompletionResult

+ KeepOrder bool

+ NoSpace bool

type ConfigFile

+ As string

+ Keys []ConfigKey

+ Profiles *ProfilesDef

+ type ConfigKey struct

+ Enum []string

+ EnumValues []EnumValue

+ IgnoreCase bool

+ Key string

+ Layout string

+ Layouts []string

+ Object bool

+ Secret bool

+ Separator string

+ Type string

+ type ConfigWriteOption func(*configWrite)

+ func AllowSecretWrite() ConfigWriteOption

+ func ParseConfigValue(fn func(raw string) error) ConfigWriteOption

+ func ToProfile(name string) ConfigWriteOption

+ func ToSharedKeys() ConfigWriteOption

type Constraints

+ UniqueItems bool

type Context

+ func (rtx *Context) Context() context.Context

+ func (rtx *Context) DashIndex() (int, bool)

+ func (rtx *Context) Dir() string

+ func (rtx *Context) Environ() []string

+ func (rtx *Context) LookupEnv(name string) (string, bool)

+ func (rtx *Context) Now() time.Time

+ func (rtx *Context) PartialInputs[T any]() (T, Presence, error)

+ func (rtx *Context) SetCompletionOptions(opts CompletionOptions)

+ func (rtx *Context) SetContext(ctx context.Context)

+ func (rtx *Context) Usage() string

+ func (rtx *Context) WithClock(now func() time.Time) *Context

+ func (rtx *Context) WithDir(dir string) *Context

+ func (rtx *Context) WithEnviron(env []string) *Context

+ func (rtx *Context) WithOutputChecks(enabled bool) *Context

+ func (rtx *Context) WithStderr(w io.Writer) *Context

+ func (rtx *Context) WithStdin(r io.Reader) *Context

+ func (rtx *Context) WithStdout(w io.Writer) *Context

+ func (rtx *Context) WriteOutputItemTo[T any](w io.Writer, item T, format string, render func(io.Writer, string, T) error) error

+ func (rtx *Context) WriteOutputTo[T any](w io.Writer, v T, format string, render func(io.Writer, string, T) error) error

type Definition

+ CompletionDescriptions *CompletionDescriptionsDef

+ Effects *Effects

+ ExitStatus []ExitStatusDef

+ Inputs reflect.Type

+ Multicall *MulticallDef

+ OptionsFirst bool

+ ResponseFiles *ResponseFilesDef

+ Topics []TopicDef

+ Usage string

type Deprecation

+ RemovedIn string

+ ReplacedBy string

+ Since string

+ Value string

+ type Effects struct

+ Idempotent *bool

+ Kind string

+ OpenWorld *bool

+ type EnumValue struct

+ Aliases []string

+ Deprecated string

+ DeprecatedAliases []string

+ DeprecatedSince string

+ Hidden bool

+ RemovedIn string

+ ReplacedBy string

+ Summary string

+ Value string

+ type ExitStatusDef struct

+ Code int

+ DocsURL string

+ Name string

+ Retryable bool

+ Summary string

+ type Feature struct

+ func Bounds() Feature

+ func Chdir() Feature

+ func ConfigFiles() Feature

+ func Dotenv() Feature

+ func EmailValues() Feature

+ func Env() Feature

+ func EnvFiles() Feature

+ func Fallbacks() Feature

+ func FlagDependencies() Feature

+ func FlagGroups() Feature

+ func IPValues() Feature

+ func JSON() Feature

+ func JSONC() Feature

+ func MACValues() Feature

+ func Multicall() Feature

+ func ObjectFlags() Feature

+ func PathExpansion() Feature

+ func Patterns() Feature

+ func Plugins() Feature

+ func Profiles() Feature

+ func RegexpValues() Feature

+ func ResponseFiles() Feature

+ func Schemas() Feature

+ func Stdin(formats ...string) Feature

+ func StreamPaths() Feature

+ func TOML() Feature

+ func TimeZoneValues() Feature

+ func URLValues() Feature

+ func YAML() Feature

+ func (f Feature) String() string

type FlagDef

+ DeprecatedIdentifiersRemovedIn map[string]string

+ DeprecatedSince string

+ Effects *Effects

+ EnumValues []EnumValue

+ HiddenIdentifiers []string

+ Layouts []string

+ Negation string

+ NoRepeat bool

+ Relative string

+ RemovedIn string

+ ReplacedBy string

+ Role string

type FlagDependency

+ Equals []string

+ Forbids []string

+ Unless []string

+ type Glob string

+ func (g *Glob) UnmarshalText(text []byte) error

+ func (g Glob) MarshalText() ([]byte, error)

+ func (g Glob) Match(name string) bool

+ type HandlerLookup func(name string) (Handler, bool)

type InputReport

+ func (r InputReport) Format(w io.Writer) error

type InputSource

+ Origin string

+ type MulticallDef struct

+ Complete string

+ Prefix string

type OutputDef

+ Stream bool

+ type OutputFile struct

+ func CreateOutput(rtx *Context, path string, opts ...OutputOption) (*OutputFile, error)

+ func (f *OutputFile) Abort() error

+ func (f *OutputFile) Close() error

+ func (f *OutputFile) Name() string

+ func (f *OutputFile) Write(p []byte) (int, error)

+ type OutputOption func(*outputConfig)

+ func FileMode(perm fs.FileMode) OutputOption

+ func Overwrite(enabled bool) OutputOption

type Page

+ Topic bool

type ParseKind

+ const ParseKindMisplacedFlag

+ type ProfilesDef struct

+ Default string

+ Env string

+ Flag string

+ Under string

type Program

+ func NewProgramFunc(def Definition, lookup HandlerLookup) *Program

+ func NewWiredProgram(def Definition, lookup HandlerLookup, features ...Feature) *Program

+ func (p *Program) Definition() Definition

+ func (p *Program) WithArgv0(name string) *Program

+ func (p *Program) WithBufferedOutput(enabled bool) *Program

+ func (p *Program) WithClock(now func() time.Time) *Program

+ func (p *Program) WithCompletionDescriptions(fn func(rtx *Context) bool) *Program

+ func (p *Program) WithDir(dir string) *Program

+ func (p *Program) WithEnviron(env []string) *Program

+ func (p *Program) WithFeatures(features ...Feature) *Program

+ func (p *Program) WithTerminationTimeout(d time.Duration) *Program

+ type ResponseFilesDef struct

+ Prefix string

+ type Selection struct

+ func SelectFields(v any, at string, fields []string) (Selection, error)

+ func (s Selection) MarshalJSON() ([]byte, error)

+ func (s Selection) MarshalTOML() (any, error)

+ func (s Selection) MarshalYAML() (any, error)

+ type TopicDef struct

+ Name string

+ Summary string

type WiringError

+ Feature string

v1.3.1

Oct 8, 2026

v1.3.0

Oct 6, 2026

Changes in this version

+ func SuggestionFacts(err error) (token string, candidates []string, ok bool)

type Completion

+ Message string

+ type CompletionMessagesDef struct

+ Env string

type CompletionResult

+ Messages []string

type Context

+ func (rtx *Context) AddCompletionMessage(msg string)

+ func (rtx *Context) CheckInputs[T any](v T, set Presence) error

type Definition

+ CompletionMessages *CompletionMessagesDef

type FlagDef

+ ShortCircuit bool

type InputError

+ Candidates []string

+ Token string

type PluginError

+ Candidates []string

type Presence

+ func PresenceOf[T any](v T) Presence

type Program

+ func (p *Program) WithCompletionMessages(fn func(rtx *Context) bool) *Program

v1.2.0

Oct 5, 2026

Changes in this version

+ var ErrDependencyNotFound = errors.New("rotini: dependency not found")

+ func AsCommand(i int, hook func(context.Context, *Context)) func(context.Context, *Context)

+ func DecodeOutput[T any](p *Program, data []byte, format string) (T, error)

+ func ExitCause(code int) error

+ func MergeInputs[T any](layers ...InputLayer[T]) T

+ func PluginCompletion(w io.Writer, result CompletionResult) error

+ func StripANSI(text string) string

+ type Command struct

+ Arguments []ArgDef

+ Commands []CommandDef

+ Deprecated string

+ DeprecatedIdentifiers []string

+ FlagDependencies []FlagDependency

+ FlagGroups []FlagGroup

+ Flags []FlagDef

+ Handler string

+ Invoked bool

+ Matched string

+ Name string

+ Output *OutputDef

+ Passthrough bool

+ PluginDiscovery *PluginDiscoveryDef

+ PluginPath string

+ Plugins []PluginDef

+ func (cmd Command) DiscoveredPlugins() []DiscoveredPlugin

+ func (cmd Command) PluginBinary(name string) (string, bool)

+ func (cmd Command) PluginDiscoveryErrors() []error

type CommandDef

+ Output *OutputDef

+ PluginDiscovery *PluginDiscoveryDef

+ Plugins []PluginDef

type Context

+ func (rtx *Context) ArgvInputs[T any]() (InputLayer[T], error)

+ func (rtx *Context) CheckOutput(v any) error

+ func (rtx *Context) CommandChain() []Command

+ func (rtx *Context) DefaultInputs[T any]() (InputLayer[T], error)

+ func (rtx *Context) EnvInputs[T any]() (InputLayer[T], error)

+ func (rtx *Context) FileInputs[T any]() (InputLayer[T], error)

+ func (rtx *Context) GetDependency[T any](dep Dependency[T]) (T, bool)

+ func (rtx *Context) InputsWithReport[T any]() (T, InputReport, error)

+ func (rtx *Context) Inputs[T any]() (T, error)

+ func (rtx *Context) MustGetDependency[T any](dep Dependency[T]) T

+ func (rtx *Context) SetDependencyIfAbsent[T any](dep Dependency[T], value T)

+ func (rtx *Context) SetDependency[T any](dep Dependency[T], value T)

+ func (rtx *Context) StdinInputs[T any]() (InputLayer[T], error)

+ func (rtx *Context) WithInputReader(fn func(InputSettings) *InputReader) *Context

+ func (rtx *Context) WithInputSettings(meta InputSettings) *Context

+ func (rtx *Context) WriteOutputItem[T any](item T, format string, render func(io.Writer, string, T) error) error

+ func (rtx *Context) WriteOutput[T any](v T, format string, render func(io.Writer, string, T) error) error

type Definition

+ Output *OutputDef

+ PluginDiscovery *PluginDiscoveryDef

+ Plugins []PluginDef

+ type Dependency struct

+ func NewDependency[T any](name string) Dependency[T]

+ func (d Dependency[T]) Name() string

+ func (d Dependency[T]) String() string

+ type DependencyError struct

+ Name string

+ func (e *DependencyError) Error() string

+ func (e *DependencyError) Unwrap() []error

+ type Handler interface

+ CascadingPostRun func(ctx context.Context, rtx *Context)

+ CascadingPreRun func(ctx context.Context, rtx *Context)

+ PostRun func(ctx context.Context, rtx *Context)

+ PreRun func(ctx context.Context, rtx *Context)

+ Run func(ctx context.Context, rtx *Context)

+ type InputError struct

+ Cause error

+ Channel string

+ Input string

+ Msg string

+ func (e *InputError) Error() string

+ func (e *InputError) Unwrap() []error

+ type InputLayer struct

+ Name string

+ Set Presence

+ Values T

+ type InputReader struct

+ func NewInputReader(meta InputSettings) *InputReader

+ func (b *InputReader) Read(rtx *Context, out any) error

+ type InputReport struct

+ func MergeInputsWithReport[T any](layers ...InputLayer[T]) (T, InputReport)

+ func (r InputReport) Fields() []FieldPath

+ func (r InputReport) History(path FieldPath) []InputSource

+ func (r InputReport) Validate() error

+ func (r InputReport) Winner(path FieldPath) (InputSource, bool)

+ type InputSettings struct

+ ConfigFiles []ConfigFile

+ EnvPrefix string

+ Sources []recon.Source

+ StdinSchemas map[string]string

+ type InputSource struct

+ Layer string

+ Raw string

+ type NoCascadingPostRun struct

+ func (NoCascadingPostRun) CascadingPostRun(ctx context.Context, rtx *Context)

+ type NoCascadingPreRun struct

+ func (NoCascadingPreRun) CascadingPreRun(ctx context.Context, rtx *Context)

+ type NoHooks struct

+ type NoPostRun struct

+ func (NoPostRun) PostRun(ctx context.Context, rtx *Context)

+ type NoPreRun struct

+ func (NoPreRun) PreRun(ctx context.Context, rtx *Context)

type Option

+ func WithDependency[T any](dep Dependency[T], value T) Option

+ type OutputDef struct

+ Schema string

+ Type reflect.Type

+ type Page struct

+ Content string

+ Name string

+ Path []string

+ type PluginDef struct

+ Aliases []string

+ Binary string

+ Name string

+ Summary string

+ Timeout time.Duration

+ type PluginDiscoveryDef struct

+ Hidden bool

+ Prefix string

+ type PluginDispatch struct

+ Args []string

+ Def PluginDef

+ Dir string

+ Discovered bool

+ type PluginError struct

+ Binary string

+ Cause error

+ Kind PluginErrorKind

+ Msg string

+ Name string

+ Timeout time.Duration

+ func (e *PluginError) Error() string

+ func (e *PluginError) Unwrap() []error

+ type PluginErrorKind int

+ const PluginNotFound

+ const PluginStartFailed

+ const PluginTimeout

+ func (k PluginErrorKind) String() string

type Program

+ func (p *Program) WithDependency[T any](dep Dependency[T], value T) *Program

+ func (p *Program) WithInputReader(fn func(InputSettings) *InputReader) *Program

+ func (p *Program) WithInputSettings(meta InputSettings) *Program

+ func (p *Program) WithOutputChecks() *Program

+ func (p *Program) WithReporter(fn Reporter) *Program

+ type Reporter func(ctx context.Context, rtx *Context, out Outcome)

+ func StructuredReporter(structured func(rtx *Context) bool) Reporter

type Resolution

+ Plugin *PluginDispatch

v1.1.1

Oct 3, 2026

Changes in this version

+ func CobraCompletion(w io.Writer, result CompletionResult) error

+ type CompletionCandidate struct

+ Description string

+ Value string

+ type CompletionFormat func(w io.Writer, result CompletionResult) error

+ type CompletionResult struct

+ Candidates []CompletionCandidate

+ Hint Completion

type Program

+ func (p *Program) Complete(words []string, format CompletionFormat) (int, error)

+ func (p *Program) WithCompletion(format CompletionFormat) *Program

v1.1.0

Oct 3, 2026

v1.0.0

Oct 1, 2026

Changes in this version

+ var ErrInternal = errors.New("internal error")

+ var ErrInterrupted = errors.New("interrupted")

+ var ErrNotInteractive = UsageError(errors.New("no input available (not interactive)"))

+ var ErrServiceNotFound = errors.New("rotini: service not found")

+ var ErrShutdownTimeout = InternalError(errors.New("shutdown timed out"))

+ var ErrUsage = errors.New("usage error")

+ func AtFrame(i int, hook func(context.Context, *Context)) func(context.Context, *Context)

+ func Collect[T any](rtx *Context) (T, error)

+ func DiscoveryDiagnostics(cmd ResolvedCommand) []error

+ func EnvNoColor() bool

+ func ExitCode(code int) error

+ func InternalError(err error) error

+ func IsTerminal(stream any) bool

+ func OverlayInputs[T any](layers ...Layer[T]) T

+ func Ptr[T any](v T) *T

+ func ReadSecret(r io.Reader) ([]byte, error)

+ func RemoteBinaryPath(cmd ResolvedCommand, name string) (string, bool)

+ func Strip(text string) string

+ func TerminalSize(stream any) (cols, rows int, ok bool)

+ func UsageError(err error) error

+ type ArgDef struct

+ Complete Completion

+ Default string

+ Deprecated string

+ Enum []string

+ Hidden bool

+ IgnoreCase bool

+ Layout string

+ Name string

+ Required bool

+ Secret bool

+ Separator string

+ Type string

+ Variadic bool

+ type ArgValueCompleter interface

+ CompleteArgValue func(rtx *Context, arg, partial string) []string

+ type Base64Bytes []byte

+ func (b *Base64Bytes) UnmarshalText(text []byte) error

+ func (b Base64Bytes) MarshalText() ([]byte, error)

+ func (b Base64Bytes) String() string

+ type BindError struct

+ Cause error

+ Channel string

+ Input string

+ Msg string

+ func (e *BindError) Error() string

+ func (e *BindError) Unwrap() []error

+ type BindMeta struct

+ ConfigFiles []ConfigFile

+ EnvPrefix string

+ Sources []recon.Source

+ StdinSchemas map[string]string

+ type Binder struct

+ func NewBinder(meta BindMeta) *Binder

+ func (b *Binder) Bind(rtx *Context, out any) error

+ type ByteSize int64

+ func (b *ByteSize) UnmarshalText(text []byte) error

+ func (b ByteSize) MarshalText() ([]byte, error)

+ func (b ByteSize) String() string

+ type Category int

+ const CategoryInternal

+ const CategoryNone

+ const CategoryUsage

+ func CategoryOf(err error) Category

+ func (c Category) String() string

+ type CommandDef struct

+ Aliases []string

+ Arguments []ArgDef

+ Commands []CommandDef

+ Deprecated string

+ DeprecatedIdentifiers []string

+ Discovery *RemoteDiscoveryDef

+ FlagDependencies []FlagDependency

+ FlagGroups []FlagGroup

+ Flags []FlagDef

+ Handler string

+ Hidden bool

+ Name string

+ Passthrough bool

+ PluginPath string

+ Remotes []RemoteDef

+ Summary string

+ type Completion struct

+ Extensions []string

+ Kind string

+ type ConfigFile struct

+ Discover *DiscoverDef

+ Format string

+ Name string

+ Path string

+ PathFrom *PathFromDef

+ Schema string

+ Scope string

+ type Constraints struct

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ MaxItems int

+ MaxLength int

+ Maximum *float64

+ MinItems int

+ MinLength int

+ Minimum *float64

+ MultipleOf *float64

+ Pattern string

+ PatternMessage string

+ type Context struct

+ Argv []string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ func NewContextFor(def Definition, argv []string) *Context

+ func (rtx *Context) Bind(key string, value any) *Context

+ func (rtx *Context) BindIfAbsent(key string, value any) *Context

+ func (rtx *Context) Chain() []ResolvedCommand

+ func (rtx *Context) Command() ResolvedCommand

+ func (rtx *Context) CommandPath() string

+ func (rtx *Context) Exit(code int)

+ func (rtx *Context) Failed() bool

+ func (rtx *Context) Frame() ResolvedCommand

+ func (rtx *Context) Get[T any](key string) (T, bool)

+ func (rtx *Context) Halt()

+ func (rtx *Context) HaltWith(err error)

+ func (rtx *Context) HaltWithCode(code int)

+ func (rtx *Context) Help() string

+ func (rtx *Context) IsLeaf() bool

+ func (rtx *Context) MustGet[T any](key string) T

+ func (rtx *Context) Parser() *Parser

+ func (rtx *Context) RecordError(err error)

+ func (rtx *Context) RecordInfo(msg string)

+ func (rtx *Context) RecordSuccess(msg string)

+ func (rtx *Context) RecordWarning(warn error)

+ func (rtx *Context) Value(key string) any

+ func (rtx *Context) Version() string

+ func (rtx *Context) WithBindMeta(meta BindMeta) *Context

+ func (rtx *Context) WithBinder(fn func(BindMeta) *Binder) *Context

+ func (rtx *Context) WithHelp(help HelpFunc) *Context

+ func (rtx *Context) WithParser(parser *Parser) *Context

+ func (rtx *Context) WithVersion(version string) *Context

+ type DefaultCascadingPostRun struct

+ func (DefaultCascadingPostRun) CascadingPostRun(ctx context.Context, rtx *Context)

+ type DefaultCascadingPreRun struct

+ func (DefaultCascadingPreRun) CascadingPreRun(ctx context.Context, rtx *Context)

+ type DefaultHooks struct

+ type DefaultPostRun struct

+ func (DefaultPostRun) PostRun(ctx context.Context, rtx *Context)

+ type DefaultPreRun struct

+ func (DefaultPreRun) PreRun(ctx context.Context, rtx *Context)

+ type Definition struct

+ Arguments []ArgDef

+ Commands []CommandDef

+ Discovery *RemoteDiscoveryDef

+ FlagDependencies []FlagDependency

+ FlagGroups []FlagGroup

+ Flags []FlagDef

+ Handler string

+ Name string

+ Passthrough bool

+ PluginPath string

+ RemoteCommands []RemoteDef

+ type Deprecation struct

+ Identifier string

+ Kind string

+ Message string

+ Name string

+ func Deprecations(rtx *Context) []Deprecation

+ func (d Deprecation) Error() string

+ type DiscoverDef struct

+ App string

+ File string

+ Strategy string

+ type DiscoveredPlugin struct

+ Name string

+ Path string

+ func DiscoveredPlugins(cmd ResolvedCommand) []DiscoveredPlugin

+ type FieldPath string

+ type FlagDef struct

+ Complete Completion

+ Default string

+ Defaults []string

+ Deprecated string

+ DeprecatedIdentifiers []string

+ DottedKeys bool

+ Enum []string

+ From []string

+ Hidden bool

+ Identifiers []string

+ IgnoreCase bool

+ ImplicitValue string

+ KeyPaths []string

+ Layout string

+ Name string

+ Negatable bool

+ ObjectSchema string

+ Required bool

+ Secret bool

+ Separator string

+ Summary string

+ Type string

+ type FlagDependency struct

+ Requires []string

+ When string

+ type FlagGroup struct

+ Flags []string

+ Kind FlagGroupKind

+ type FlagGroupKind string

+ const FlagGroupAtLeastOne

+ const FlagGroupMutuallyExclusive

+ const FlagGroupOneOf

+ const FlagGroupRequiredTogether

+ type FlagValueCompleter interface

+ CompleteFlagValue func(rtx *Context, flag, partial string) []string

+ type FunnelFunc func(ctx context.Context, rtx *Context, out Outcome)

+ type Handlers interface

+ CascadingPostRun func(ctx context.Context, rtx *Context)

+ CascadingPreRun func(ctx context.Context, rtx *Context)

+ PostRun func(ctx context.Context, rtx *Context)

+ PreRun func(ctx context.Context, rtx *Context)

+ Run func(ctx context.Context, rtx *Context)

+ type HelpFunc func(path ...string) (string, error)

+ type HexBytes []byte

+ func (h *HexBytes) UnmarshalText(text []byte) error

+ func (h HexBytes) MarshalText() ([]byte, error)

+ func (h HexBytes) String() string

+ type Key struct

+ func NewKey[T any](name string) Key[T]

+ func (k Key[T]) BindTo(rtx *Context, value T)

+ func (k Key[T]) Get(rtx *Context) (T, bool)

+ func (k Key[T]) MustGet(rtx *Context) T

+ func (k Key[T]) Name() string

+ func (k Key[T]) Provide(p *Program, value T) *Program

+ func (k Key[T]) String() string

+ type Layer struct

+ Name string

+ Set Presence

+ Values T

+ func Defaults[T any](rtx *Context) (Layer[T], error)

+ func ParseArgv[T any](rtx *Context) (Layer[T], error)

+ func ParseEnv[T any](rtx *Context) (Layer[T], error)

+ func ParseFiles[T any](rtx *Context) (Layer[T], error)

+ func ParseStdin[T any](rtx *Context) (Layer[T], error)

+ type Lifecycle func(chain []ResolvedCommand, handlers []Handlers) []LifecycleStep

+ type LifecycleStep struct

+ Do func(ctx context.Context, rtx *Context)

+ Name string

+ Undo func(ctx context.Context, rtx *Context)

+ func DefaultLifecycle(chain []ResolvedCommand, handlers []Handlers) []LifecycleStep

+ type Line struct

+ Stream Stream

+ Text string

+ type Option func(*Program)

+ func Provide[T any](k Key[T], value T) Option

+ type Outcome struct

+ Errors []error

+ Infos []string

+ Panics []*PanicError

+ Successes []string

+ Warnings []error

+ func (o Outcome) Empty() bool

+ func (o Outcome) Failed() bool

+ type PanicError struct

+ Stack []byte

+ Value any

+ func (e *PanicError) Error() string

+ func (e *PanicError) Unwrap() []error

+ type ParseError struct

+ Candidates []string

+ Command string

+ Flag string

+ Kind ParseKind

+ Msg string

+ Token string

+ func (e *ParseError) Error() string

+ func (e *ParseError) Unwrap() error

+ type ParseKind int

+ const ParseKindConstraintViolation

+ const ParseKindEnumViolation

+ const ParseKindInternal

+ const ParseKindInvalidValue

+ const ParseKindMissingRequired

+ const ParseKindNeedsValue

+ const ParseKindNoArguments

+ const ParseKindTooManyArguments

+ const ParseKindUnknownCommand

+ const ParseKindUnknownFlag

+ const ParseKindUnspecified

+ func (k ParseKind) String() string

+ type Parser struct

+ func NewParser() *Parser

+ func (p *Parser) Parse(rtx *Context, out any) error

+ type PathFromDef struct

+ Env string

+ Flag string

+ type Presence map[FieldPath]Provenance

+ type Program struct

+ func NewProgram(def Definition, handlers any) *Program

+ func (p *Program) Bind(key string, value any) *Program

+ func (p *Program) Execute() error

+ func (p *Program) Run(argv []string) (int, error)

+ func (p *Program) RunContext(ctx context.Context, argv []string) (int, error)

+ func (p *Program) With(opts ...Option) *Program

+ func (p *Program) WithArgs(args []string) *Program

+ func (p *Program) WithBindMeta(meta BindMeta) *Program

+ func (p *Program) WithBinder(fn func(BindMeta) *Binder) *Program

+ func (p *Program) WithContext(ctx context.Context) *Program

+ func (p *Program) WithExit(fn func(int)) *Program

+ func (p *Program) WithFunnel(fn FunnelFunc) *Program

+ func (p *Program) WithHelp(help HelpFunc) *Program

+ func (p *Program) WithLifecycle(fn Lifecycle) *Program

+ func (p *Program) WithPanicRecover(enabled bool) *Program

+ func (p *Program) WithParser(parser *Parser) *Program

+ func (p *Program) WithResolver(fn Resolver) *Program

+ func (p *Program) WithSignals(sigs ...os.Signal) *Program

+ func (p *Program) WithStderr(w io.Writer) *Program

+ func (p *Program) WithStdin(r io.Reader) *Program

+ func (p *Program) WithStdout(w io.Writer) *Program

+ func (p *Program) WithTeardownOnPanic(enabled bool) *Program

+ func (p *Program) WithVersion(version string) *Program

+ func (p *Program) WithoutSignalHandling() *Program

+ type Provenance struct

+ Layer string

+ Raw string

+ type REPL struct

+ func NewREPL(program *Program) *REPL

+ func (r *REPL) Complete(line string, pos int) []string

+ func (r *REPL) Run(ctx context.Context) error

+ func (r *REPL) WithErrorEcho(enabled bool) *REPL

+ func (r *REPL) WithExitCommands(words ...string) *REPL

+ func (r *REPL) WithInput(in io.Reader) *REPL

+ func (r *REPL) WithIntercept(fn func(ctx context.Context, line string) (bool, error)) *REPL

+ func (r *REPL) WithInterrupts(ch <-chan struct{}) *REPL

+ func (r *REPL) WithLineReader(fn func(ctx context.Context, prompt string) (string, error)) *REPL

+ func (r *REPL) WithOutput(out io.Writer) *REPL

+ func (r *REPL) WithPrompt(prompt string) *REPL

+ func (r *REPL) WithPromptFunc(fn func() string) *REPL

+ type RemoteDef struct

+ Aliases []string

+ Binary string

+ Name string

+ Summary string

+ Timeout time.Duration

+ type RemoteDiscoveryDef struct

+ Hidden bool

+ Prefix string

+ type RemoteDispatch struct

+ Args []string

+ Def RemoteDef

+ Dir string

+ Discovered bool

+ type RemoteError struct

+ Binary string

+ Cause error

+ Kind RemoteErrorKind

+ Msg string

+ Name string

+ Timeout time.Duration

+ func (e *RemoteError) Error() string

+ func (e *RemoteError) Unwrap() []error

+ type RemoteErrorKind int

+ const RemoteBinaryNotFound

+ const RemoteSpawnFailed

+ const RemoteTimeout

+ func (k RemoteErrorKind) String() string

+ type Report struct

+ func CollectP[T any](rtx *Context) (T, Report, error)

+ func OverlayInputsP[T any](layers ...Layer[T]) (T, Report)

+ func (r Report) Fields() []FieldPath

+ func (r Report) History(path FieldPath) []Provenance

+ func (r Report) Validate() error

+ func (r Report) Winner(path FieldPath) (Provenance, bool)

+ type Resolution struct

+ Argv []string

+ Chain []ResolvedCommand

+ Remote *RemoteDispatch

+ func DefaultResolver(def Definition, argv []string) (Resolution, error)

+ type ResolvedCommand struct

+ Arguments []ArgDef

+ Commands []CommandDef

+ Deprecated string

+ DeprecatedIdentifiers []string

+ Discovery *RemoteDiscoveryDef

+ FlagDependencies []FlagDependency

+ FlagGroups []FlagGroup

+ Flags []FlagDef

+ Handler string

+ Matched string

+ Name string

+ Passthrough bool

+ PluginPath string

+ Remotes []RemoteDef

+ type Resolver func(def Definition, argv []string) (Resolution, error)

+ type Service struct

+ func NewService() *Service

+ func (s *Service) Go(name string, fn func(context.Context) error) *Service

+ func (s *Service) Run(ctx context.Context) error

+ func (s *Service) WithShutdown(fn func(context.Context) error) *Service

+ func (s *Service) WithShutdownTimeout(d time.Duration) *Service

+ type ServiceError struct

+ Key string

+ func (e *ServiceError) Error() string

+ func (e *ServiceError) Unwrap() []error

+ type Stream int

+ const StreamStderr

+ const StreamStdout

+ func (s Stream) String() string

+ type Subprocess struct

+ func NewSubprocess(name string, args ...string) *Subprocess

+ func (s *Subprocess) Lines(ctx context.Context) iter.Seq2[Line, error]

+ func (s *Subprocess) Output(ctx context.Context) (string, error)

+ func (s *Subprocess) Run(ctx context.Context) (int, error)

+ func (s *Subprocess) WithDir(dir string) *Subprocess

+ func (s *Subprocess) WithEnv(entries ...string) *Subprocess

+ func (s *Subprocess) WithStderr(w io.Writer) *Subprocess

+ func (s *Subprocess) WithStdin(r io.Reader) *Subprocess

+ func (s *Subprocess) WithStdout(w io.Writer) *Subprocess

+ func (s *Subprocess) WithTimeout(d time.Duration) *Subprocess

+ func (s *Subprocess) WithoutParentEnv() *Subprocess

+ type SubprocessError struct

+ Args []string

+ Cause error

+ ExitCode int

+ Name string

+ Stderr string

+ func (e *SubprocessError) Error() string

+ func (e *SubprocessError) Unwrap() []error

+ type Suggestor struct

+ func NewSuggestor() *Suggestor

+ func (s *Suggestor) Closest(input string, candidates []string) (suggestion string, ok bool)

+ func (s *Suggestor) For(err error) []string

+ func (s *Suggestor) Suggest(input string, candidates []string) []string

+ func (s *Suggestor) WithMaxResults(n int) *Suggestor

+ func (s *Suggestor) WithMinScore(score float64) *Suggestor

+ type WiringError struct

+ Command string

+ Handler string

+ Msg string

+ func (e *WiringError) Error() string

+ func (e *WiringError) Unwrap() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL