command

Sep 20, 2025

Changes in this version

type Command

+ func (c *Command) Name() string

+ func (c *Command) SetCategory(category string)

Jul 24, 2025

Changes in this version

+ var ErrCommandNotAllowed = fmt.Errorf("%w not allowed", Error)

+ var ErrNotImplemented = fmt.Errorf("%w not implemented", Error)

+ func NotImplemented(msg string) error

type Cmd

+ func (c *Cmd) CheckDisabled(sess *session.Context) bool

+ func (c *Cmd) Config() *settings.Profile

+ func (c *Cmd) Disabled() bool

+ func (c *Cmd) Err() error

+ func (c *Cmd) Parent() *Cmd

type Command

+ func (c *Command) AddUsage(usage string) *Command

+ func (c *Command) Disable(a action.Action) *Command

type Config

+ Disabled settings.Bool

+ FailDisabled settings.Bool

type SubCmdInfo

+ Disabled bool

Dec 2, 2024

Changes in this version

type Config

+ HideDefaultUsage settings.Bool

Sep 1, 2024

Changes in this version

type Config

+ MaxArgsErr settings.String

+ MinArgsErr settings.String

Jun 3, 2024

Changes in this version

type Command

+ func (c *Command) WithSubCommands(cmds ...*Command) *Command

Jun 3, 2024

Changes in this version

+ var ErrFlags = errors.New("command flags error")

+ var ErrHasNoParent = errors.New("command has no parent command")

+ var Error = errors.New("command error")

+ type Cmd struct

+ func Compile(root *Command) (*Cmd, *logging.QueueLogger, error)

+ func (c *Cmd) Categories() map[string]string

+ func (c *Cmd) ExecAfterAlways(sess *session.Context, err error) error

+ func (c *Cmd) ExecAfterFailure(sess *session.Context, err error) error

+ func (c *Cmd) ExecAfterSuccess(sess *session.Context) error

+ func (c *Cmd) ExecBefore(sess *session.Context) (err error)

+ func (c *Cmd) ExecDo(sess *session.Context) (err error)

+ func (c *Cmd) Flag(name string) varflag.Flag

+ func (c *Cmd) Flags() []varflag.Flag

+ func (c *Cmd) GetFlagSet() varflag.Flags

+ func (c *Cmd) GlobalFlags() []varflag.Flag

+ func (c *Cmd) HasBefore() bool

+ func (c *Cmd) Info() []string

+ func (c *Cmd) IsImmediate() bool

+ func (c *Cmd) IsRoot() bool

+ func (c *Cmd) IsWrapper() bool

+ func (c *Cmd) Name() string

+ func (c *Cmd) SharedFlags() []varflag.Flag

+ func (c *Cmd) SkipSharedBeforeAction() bool

+ func (c *Cmd) SubCommands() []SubCmdInfo

+ func (c *Cmd) Usage() []string

+ type Command struct

+ func New(s Config) *Command

+ func (c *Command) AddInfo(paragraph string) *Command

+ func (c *Command) AfterAlways(a action.WithPrevErr) *Command

+ func (c *Command) AfterFailure(a action.WithPrevErr) *Command

+ func (c *Command) AfterSuccess(a action.Action) *Command

+ func (c *Command) Before(a action.WithArgs) *Command

+ func (c *Command) DescribeCategory(cat, desc string) *Command

+ func (c *Command) Do(action action.WithArgs) *Command

+ func (c *Command) Err() error

+ func (c *Command) Usage(usage string)

+ func (c *Command) WithFlag(ffn varflag.FlagCreateFunc) *Command

+ func (c *Command) WithFlags(ffns ...varflag.FlagCreateFunc) *Command

+ func (c *Command) WithSubCommand(cmd *Command) *Command

+ type Config struct

+ Category settings.String

+ Description settings.String

+ Immediate settings.Bool

+ MaxArgs settings.Uint

+ MinArgs settings.Uint

+ Name settings.String

+ SharedBeforeAction settings.Bool

+ SkipSharedBefore settings.Bool

+ Usage settings.String

+ func (s Config) Blueprint() (*settings.Blueprint, error)

+ type SubCmdInfo struct

+ Category string

+ Description string

+ Name string