stdcli

Oct 24, 2025

Changes in this version

type Engine

+ Flags []Flag

Oct 24, 2025

Changes in this version

+ type ColumnWriter interface

+ Append func(items ...any)

+ Print func() error

type Context

+ Columns func() ColumnWriter

type Flag

+ func (f *Flag) Kind() FlagType

+ type FlagType string

+ const FlagBool

+ const FlagDuration

+ const FlagInt

+ const FlagString

Apr 16, 2024

Changes in this version

type Context

+ IsTerminalReader func() bool

+ IsTerminalWriter func() bool

Mar 11, 2024

Changes in this version

type Context

+ TableWriter func(columns ...string) TableWriter

Jan 30, 2024

Changes in this version

type Context

+ Cleanup func(func())

type ExitCoder

+ ExitCode func() int

Jan 23, 2024

Changes in this version

type Context

+ IsTerminal func() bool

Jan 23, 2024

Changes in this version

+ type CommandDefinition struct

+ Command string

+ Description string

+ Handler HandlerFunc

+ Options CommandOptions

+ type CommandDefinitions []CommandDefinition

+ func (cs *CommandDefinitions) Register(command, description string, fn HandlerFunc, opts CommandOptions)

+ func (cs CommandDefinitions) Apply(e *Engine)

type Context

+ InfoWriter func() InfoWriter

+ type Flags []Flag

+ func (fs Flags) Bool(name string) bool

+ func (fs Flags) Int(name string) int

+ func (fs Flags) String(name string) string

+ func (fs Flags) Value(name string) any

+ type InfoWriter interface

+ Add func(header, value string)

+ Print func() error

+ type TableWriter interface

+ Append func(row ...string)

+ Print func() error

Apr 9, 2022

Changes in this version

+ func Help(c *Context) error

+ func IsTerminal(f *os.File) bool

+ type CmdExecutor struct

+ func (e *CmdExecutor) Execute(cmd string, args ...string) ([]byte, error)

+ func (e *CmdExecutor) Run(w io.Writer, cmd string, args ...string) error

+ func (e *CmdExecutor) Terminal(cmd string, args ...string) error

+ type Command struct

+ Command []string

+ Description string

+ Flags []Flag

+ Handler HandlerFunc

+ Invisible bool

+ Usage string

+ Validate Validator

+ func (c *Command) ExecuteContext(ctx context.Context, args []string) error

+ func (c *Command) FullCommand() string

+ func (c *Command) Match(args []string) ([]string, bool)

+ type CommandOptions struct

+ Flags []Flag

+ Invisible bool

+ Usage string

+ Validate Validator

+ type Context struct

+ Args []string

+ Flags []*Flag

+ func (c *Context) Arg(i int) string

+ func (c *Context) Bool(name string) bool

+ func (c *Context) Error(err error) error

+ func (c *Context) Errorf(format string, args ...interface{}) error

+ func (c *Context) Execute(cmd string, args ...string) ([]byte, error)

+ func (c *Context) Fail(err error)

+ func (c *Context) Flag(name string) *Flag

+ func (c *Context) Info() *Info

+ func (c *Context) Int(name string) int

+ func (c *Context) LocalSetting(name string) string

+ func (c *Context) OK(id ...string) error

+ func (c *Context) Options(opts interface{}) error

+ func (c *Context) Read(data []byte) (int, error)

+ func (c *Context) ReadSecret() (string, error)

+ func (c *Context) Reader() *Reader

+ func (c *Context) Run(cmd string, args ...string) error

+ func (c *Context) SettingDelete(name string) error

+ func (c *Context) SettingDirectory(name string) (string, error)

+ func (c *Context) SettingRead(name string) (string, error)

+ func (c *Context) SettingReadKey(name, key string) (string, error)

+ func (c *Context) SettingWrite(name, value string) error

+ func (c *Context) SettingWriteKey(name, key, value string) error

+ func (c *Context) Startf(format string, args ...interface{})

+ func (c *Context) String(name string) string

+ func (c *Context) Table(columns ...string) *Table

+ func (c *Context) Terminal(cmd string, args ...string) error

+ func (c *Context) TerminalRaw() func()

+ func (c *Context) TerminalSize() (int, int, error)

+ func (c *Context) Value(name string) interface{}

+ func (c *Context) Version() string

+ func (c *Context) Write(data []byte) (int, error)

+ func (c *Context) Writef(format string, args ...interface{}) error

+ func (c *Context) Writer() *Writer

+ type Engine struct

+ Commands []Command

+ Executor Executor

+ Name string

+ Profile string

+ Reader *Reader

+ Settings string

+ Version string

+ Writer *Writer

+ func New(name, version string) *Engine

+ func (e *Engine) Command(command, description string, fn HandlerFunc, opts CommandOptions)

+ func (e *Engine) Execute(args []string) int

+ func (e *Engine) ExecuteContext(ctx context.Context, args []string) int

+ func (e *Engine) LocalSetting(name string) string

+ func (e *Engine) SettingDelete(name string) error

+ func (e *Engine) SettingDirectory(name string) (string, error)

+ func (e *Engine) SettingRead(name string) (string, error)

+ func (e *Engine) SettingReadKey(name, key string) (string, error)

+ func (e *Engine) SettingWrite(name, value string) error

+ func (e *Engine) SettingWriteKey(name, key, value string) error

+ type Executor interface

+ Execute func(cmd string, args ...string) ([]byte, error)

+ Run func(w io.Writer, cmd string, args ...string) error

+ Terminal func(cmd string, args ...string) error

+ type ExitCode struct

+ func Exit(code int) ExitCode

+ func (e ExitCode) Code() int

+ func (e ExitCode) Error() string

+ type ExitCoder interface

+ Code func() int

+ type Flag struct

+ Default interface{}

+ Description string

+ Name string

+ Short string

+ Value interface{}

+ func BoolFlag(name, short, description string) Flag

+ func DurationFlag(name, short, description string) Flag

+ func IntFlag(name, short, description string) Flag

+ func OptionFlags(opts interface{}) []Flag

+ func StringFlag(name, short, description string) Flag

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

+ func (f *Flag) String() string

+ func (f *Flag) Type() string

+ func (f *Flag) Usage(v string) string

+ func (f *Flag) UsageLong() string

+ func (f *Flag) UsageShort() string

+ type HandlerFunc func(*Context) error

+ type Info struct

+ Context *Context

+ Rows []InfoRow

+ func (i *Info) Add(header, value string)

+ func (i *Info) Print() error

+ type InfoRow struct

+ Header string

+ Value string

+ type Reader struct

+ var DefaultReader *Reader

+ func (r *Reader) IsTerminal() bool

+ func (r *Reader) TerminalRaw() func() bool

+ type Renderer func(string) string

+ func RenderColors(colors ...int) Renderer

+ func RenderUnderline() Renderer

+ type Table struct

+ Columns []string

+ Context *Context

+ Rows [][]string

+ func (t *Table) AddRow(row ...string)

+ func (t *Table) Print() error

+ type Validator func(c *Context) error

+ func Args(num int) Validator

+ func ArgsBetween(min, max int) Validator

+ func ArgsMax(max int) Validator

+ func ArgsMin(min int) Validator

+ type Writer struct

+ Color bool

+ Stderr io.Writer

+ Stdout io.Writer

+ Tags map[string]Renderer

+ var DefaultWriter *Writer

+ func (w *Writer) Error(err error) error

+ func (w *Writer) Errorf(format string, args ...interface{}) error

+ func (w *Writer) IsTerminal() bool

+ func (w *Writer) Sprintf(format string, args ...interface{}) string

+ func (w *Writer) Write(data []byte) (int, error)

+ func (w *Writer) Writef(format string, args ...interface{}) (int, error)