command

Jul 13, 2024

Changes in this version

type ExitCode

+ func ExecuteWithContext(ctx context.Context, w io.Writer, root *Command, args []string, ...) (exitCode ExitCode)

Jun 14, 2024

Changes in this version

+ type PostRunHook interface

+ PostRun func(context.Context, error, ExitCode) error

+ type PostRunHookFunc func(context.Context, error, ExitCode) error

+ func (i PostRunHookFunc) PostRun(ctx context.Context, err error, exitCode ExitCode) error

Jun 11, 2024

Changes in this version

+ type Action interface

+ Run func(context.Context) error

+ type ActionFunc func(context.Context) error

+ func (i ActionFunc) Run(ctx context.Context) error

+ type PreRunHook interface

+ PreRun func(context.Context) error

+ type PreRunHookFunc func(context.Context) error

+ func (i PreRunHookFunc) PreRun(ctx context.Context) error

Jun 3, 2024

Changes in this version

+ var ErrCommandAlreadyHasParent = errors.New("command already has a parent")

+ var ErrInvalidCommand = errors.New("invalid command")

type Command

+ HelpConfig *HelpConfig

+ func MustNew(name, shortDescription, longDescription string, executor Executor, ...) *Command

+ func (c *Command) AddSubCommand(cmd *Command) error

+ func (c *Command) PrintHelp(w io.Writer, width int) error

+ func (c *Command) PrintUsageLine(w io.Writer, width int) error

+ type ErrInvalidTag struct

+ Cause error

+ Tag Tag

+ Value string

+ func (e *ErrInvalidTag) Error() string

+ func (e *ErrInvalidTag) Unwrap() error

+ type ErrInvalidValue struct

+ Cause error

+ Flag string

+ Value string

+ func (e *ErrInvalidValue) Error() string

+ func (e *ErrInvalidValue) Unwrap() error

+ type ErrRequiredFlagMissing struct

+ Cause error

+ Flag string

+ func (e *ErrRequiredFlagMissing) Error() string

+ func (e *ErrRequiredFlagMissing) Unwrap() error

+ type ErrUnknownFlag struct

+ Cause error

+ Flag string

+ func (e *ErrUnknownFlag) Error() string

+ func (e *ErrUnknownFlag) Unwrap() error

+ type Executor interface

+ PreRun func(ctx context.Context) error

+ Run func(ctx context.Context) error

+ type ExitCode int

+ const ExitCodeError

+ const ExitCodeMisconfiguration

+ const ExitCodeSuccess

+ type HelpConfig struct

+ Help bool

+ type InlineExecutor struct

+ PreRunFunc func(context.Context) error

+ RunFunc func(context.Context) error

+ func (i InlineExecutor) PreRun(ctx context.Context) error

+ func (i InlineExecutor) Run(ctx context.Context) error

+ type Tag string

+ const TagArgs

+ const TagDescription

+ const TagEnv

+ const TagFlag

+ const TagInherited

+ const TagName

+ const TagRequired

+ const TagValueName

+ type WrappingWriter struct

+ func NewWrappingWriter(width int) (*WrappingWriter, error)

+ func (w *WrappingWriter) SetLinePrefix(prefix string) error

+ func (w *WrappingWriter) String() string

+ func (w *WrappingWriter) Write(p []byte) (n int, err error)

May 16, 2024

Changes in this version

type Command

+ PreSubCommandRun func(ctx context.Context, config any, usagePrinter UsagePrinter) error

type Spec

+ OnSubCommandRun func(ctx context.Context, config any, usagePrinter UsagePrinter) error

May 14, 2024

Changes in this version

+ func SetupSignalHandler() context.Context

May 14, 2024

Changes in this version

+ var Version = "0.0.0-unknown"

+ func EnvVarsArrayToMap(envVars []string) map[string]string

+ func Execute(root *Command, args []string, envVars map[string]string)

+ type BuiltinConfig struct

+ Help bool

+ type Command struct

+ Config any

+ LongDescription string

+ Name string

+ Parent *Command

+ Run func(ctx context.Context, config any, usagePrinter UsagePrinter) error

+ ShortDescription string

+ func New(spec Spec) *Command

+ func (c *Command) PrintFullUsage(w io.Writer)

+ func (c *Command) PrintShortUsage(w io.Writer)

+ type Spec struct

+ Config any

+ LongDescription string

+ Name string

+ Parent *Command

+ Run func(ctx context.Context, config any, usagePrinter UsagePrinter) error

+ ShortDescription string

+ type UsagePrinter interface

+ PrintFullUsage func(w io.Writer)

+ PrintShortUsage func(w io.Writer)