cmd

Oct 3, 2024

Changes in this version

+ func PrintMarkdown(w io.Writer, cmd InfoCommand, opts MarkdownOptions) error

+ type InfoCommand interface

+ Info func() *Info

+ SetFlags func(f *gnuflag.FlagSet)

+ type MarkdownOptions struct

+ LinkForCommand func(string) string

+ LinkForSubcommand func(string) string

+ Title string

+ UsagePrefix string

Nov 7, 2023

Changes in this version

type SuperCommand

+ SkipCommandDoc bool

type SuperCommandParams

+ SkipCommandDoc bool

Aug 14, 2023

Changes in this version

type Info

+ Subcommands map[string]string

type SuperCommand

+ Examples string

type SuperCommandParams

+ Examples string

May 3, 2023

Changes in this version

+ func EscapeMarkdown(raw string) string

Feb 28, 2023

Changes in this version

+ const DocumentationFileName

+ const DocumentationIndexFileName

Jan 9, 2023

Changes in this version

type Info

+ Examples []string

+ SeeAlso []string

Jan 3, 2023

Changes in this version

type Context

+ func (ctx *Context) Errorf(format string, params ...interface{})

Feb 3, 2022

Changes in this version

+ var DefaultFormatters = formatters

+ var ErrNoPath = errors.New("path not set")

+ var ErrSilent = errors.New("cmd: error out silently")

+ func CheckEmpty(args []string) error

+ func FlagAlias(c Command, akaDefault string) string

+ func FormatJson(writer io.Writer, value interface{}) error

+ func FormatSmart(writer io.Writer, value interface{}) error

+ func FormatYaml(writer io.Writer, value interface{}) error

+ func IsErrSilent(err error) bool

+ func IsRcPassthroughError(err error) bool

+ func Main(c Command, ctx *Context, args []string) int

+ func NewCommandLogWriter(name string, out, err io.Writer) loggo.Writer

+ func NewRcPassthroughError(code int) error

+ func NewWarningWriter(writer io.Writer) loggo.Writer

+ func ParseAliasFile(aliasFilename string) map[string][]string

+ func WriteError(writer io.Writer, err error)

+ func ZeroOrOneArgs(args []string) (string, error)

+ type AppendStringsValue []string

+ func NewAppendStringsValue(target *[]string) *AppendStringsValue

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

+ func (v *AppendStringsValue) String() string

+ type Command interface

+ AllowInterspersedFlags func() bool

+ Info func() *Info

+ Init func(args []string) error

+ IsSuperCommand func() bool

+ Run func(ctx *Context) error

+ SetFlags func(f *gnuflag.FlagSet)

+ type CommandBase struct

+ func (c *CommandBase) AllowInterspersedFlags() bool

+ func (c *CommandBase) Init(args []string) error

+ func (c *CommandBase) IsSuperCommand() bool

+ func (c *CommandBase) SetFlags(f *gnuflag.FlagSet)

+ type Context struct

+ Dir string

+ Env map[string]string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ func DefaultContext() (*Context, error)

+ func (ctx *Context) AbsPath(path string) string

+ func (ctx *Context) GetStderr() io.Writer

+ func (ctx *Context) GetStdin() io.Reader

+ func (ctx *Context) GetStdout() io.Writer

+ func (ctx *Context) Getenv(key string) string

+ func (ctx *Context) Infof(format string, params ...interface{})

+ func (ctx *Context) InterruptNotify(c chan<- os.Signal)

+ func (ctx *Context) IsSerial() bool

+ func (ctx *Context) Quiet() bool

+ func (ctx *Context) Setenv(key, value string) error

+ func (ctx *Context) StopInterruptNotify(c chan<- os.Signal)

+ func (ctx *Context) Verbosef(format string, params ...interface{})

+ func (ctx *Context) Warningf(format string, params ...interface{})

+ func (ctx *Context) With(c context.Context) *Context

+ type DeprecationCheck interface

+ Deprecated func() (bool, string)

+ Obsolete func() bool

+ type FileVar struct

+ Path string

+ StdinMarkers []string

+ func (f *FileVar) Open(ctx *Context) (io.ReadCloser, error)

+ func (f *FileVar) Read(ctx *Context) ([]byte, error)

+ func (f *FileVar) Set(v string) error

+ func (f *FileVar) SetStdin(markers ...string)

+ func (f *FileVar) String() string

+ func (f FileVar) IsStdin() bool

+ type FlagAdder interface

+ AddFlags func(*gnuflag.FlagSet)

+ type Formatter func(writer io.Writer, value interface{}) error

+ type Info struct

+ Aliases []string

+ Args string

+ Doc string

+ FlagKnownAs string

+ Name string

+ Purpose string

+ ShowSuperFlags []string

+ func (i *Info) Help(f *gnuflag.FlagSet) []byte

+ func (i *Info) HelpWithSuperFlags(superF *gnuflag.FlagSet, f *gnuflag.FlagSet) []byte

+ type Log struct

+ Config string

+ Debug bool

+ DefaultConfig string

+ NewWriter func(target io.Writer) loggo.Writer

+ Path string

+ Quiet bool

+ ShowLog bool

+ Verbose bool

+ func (l *Log) AddFlags(f *gnuflag.FlagSet)

+ func (l *Log) GetLogWriter(target io.Writer) loggo.Writer

+ func (log *Log) Start(ctx *Context) error

+ type MissingCallback func(ctx *Context, subcommand string, args []string) error

+ type Output struct

+ func (c *Output) AddFlags(f *gnuflag.FlagSet, defaultFormatter string, formatters map[string]Formatter)

+ func (c *Output) Name() string

+ func (c *Output) Write(ctx *Context, value interface{}) (err error)

+ func (c *Output) WriteFormatter(ctx *Context, formatter Formatter, value interface{}) (err error)

+ type RcPassthroughError struct

+ Code int

+ func (e *RcPassthroughError) Error() string

+ type StringMap struct

+ Mapping *map[string]string

+ func (m StringMap) Set(s string) error

+ func (m StringMap) String() string

+ type StringsValue []string

+ func NewStringsValue(defaultValue []string, target *[]string) *StringsValue

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

+ func (v *StringsValue) String() string

+ type SuperCommand struct

+ Aliases []string

+ Doc string

+ FlagKnownAs string

+ Log *Log

+ Name string

+ Purpose string

+ func NewSuperCommand(params SuperCommandParams) *SuperCommand

+ func (c *SuperCommand) AddHelpTopic(name, short, long string, aliases ...string)

+ func (c *SuperCommand) AddHelpTopicCallback(name, short string, longCallback func() string)

+ func (c *SuperCommand) AllowInterspersedFlags() bool

+ func (c *SuperCommand) FindClosestSubCommand(name string) (string, Command, bool)

+ func (c *SuperCommand) Info() *Info

+ func (c *SuperCommand) Init(args []string) error

+ func (c *SuperCommand) IsSuperCommand() bool

+ func (c *SuperCommand) Register(subcmd Command)

+ func (c *SuperCommand) RegisterAlias(name, forName string, check DeprecationCheck)

+ func (c *SuperCommand) RegisterDeprecated(subcmd Command, check DeprecationCheck)

+ func (c *SuperCommand) RegisterSuperAlias(name, super, forName string, check DeprecationCheck)

+ func (c *SuperCommand) Run(ctx *Context) error

+ func (c *SuperCommand) SetCommonFlags(f *gnuflag.FlagSet)

+ func (c *SuperCommand) SetFlags(f *gnuflag.FlagSet)

+ type SuperCommandParams struct

+ Aliases []string

+ Doc string

+ FlagKnownAs string

+ GlobalFlags FlagAdder

+ Log *Log

+ MissingCallback MissingCallback

+ Name string

+ NotifyHelp func([]string)

+ NotifyRun func(cmdName string)

+ Purpose string

+ UsagePrefix string

+ UserAliasesFilename string

+ Version string

+ VersionDetail interface{}

+ type TypeFormatter struct

+ Formatter Formatter

+ Serialisable bool

+ type UnrecognizedCommand struct

+ func DefaultUnrecognizedCommand(name string) *UnrecognizedCommand

+ func UnrecognizedCommandf(format string, args ...interface{}) *UnrecognizedCommand

+ func (e *UnrecognizedCommand) Error() string