kong

Feb 9, 2025

Changes in this version

type Resolver

+ func EnvResolver() Resolver

Jan 4, 2025

Changes in this version

type Tag

+ XorPrefix string

Dec 1, 2024

Changes in this version

+ type PassthroughMode int

+ const PassThroughModeAll

+ const PassThroughModeNone

+ const PassThroughModePartial

type Tag

+ PassthroughMode PassthroughMode

type Value

+ PassthroughMode PassthroughMode

Nov 5, 2024

Changes in this version

+ type AfterRun interface

+ AfterRun func(args ...any) error

Aug 21, 2024

Changes in this version

type Flag

+ And []string

type Tag

+ And []string

Mar 8, 2024

Changes in this version

type Flag

+ Aliases []string

Oct 7, 2023

Changes in this version

+ type BoolMapperValue interface

+ IsBool func() bool

Feb 25, 2023

Changes in this version

+ type BoolMapperExt interface

+ IsBoolFromValue func(v reflect.Value) bool

type Context

+ func (c *Context) Call(fn any, binds ...interface{}) (out []interface{}, err error)

type Flag

+ Envs []string

type Option

+ func Embed(strct any, tags ...string) Option

+ func FlagNamer(namer func(fieldName string) string) Option

type Tag

+ Envs []string

+ func (t *Tag) String() string

Oct 17, 2022

Changes in this version

type Node

+ Active bool

type Value

+ Active bool

type VersionFlag

+ func (v VersionFlag) BeforeReset(app *Kong, vars Vars) error

Jun 11, 2022

Changes in this version

type ParseError

+ func (p *ParseError) Unwrap() error

type Scanner

+ func ScanAsType(ttype TokenType, args ...string) *Scanner

Mar 11, 2022

Changes in this version

type Option

+ func AutoGroup(format func(parent Visitable, flag *Flag) *Group) Option

type Value

+ func (v *Value) EnumSlice() []string

Jan 5, 2022

Changes in this version

+ type ChangeDirFlag string

+ func (c ChangeDirFlag) Decode(ctx *DecodeContext) error

type Node

+ Passthrough bool

Dec 13, 2021

Changes in this version

type Tag

+ HasDefault bool

type Value

+ HasDefault bool

Dec 4, 2021

Changes in this version

+ func HasInterpolatedVar(s string, v string) bool

type Option

+ func ValueFormatter(helpFormatter HelpValueFormatter) Option

type Tag

+ TypeName string

type Value

+ OrigHelp string

Oct 22, 2021

Changes in this version

type Context

+ func (c *Context) BindToProvider(provider interface{}) error

type HelpOptions

+ WrapUpperBound int

type Node

+ DefaultCmd *Node

type Option

+ func DefaultEnvars(prefix string) Option

+ func IgnoreFields(regexes ...string) Option

type Tag

+ EnvPrefix string

+ type VarsContributor interface

+ Vars func(ctx *Value) Vars

Jun 6, 2021

Changes in this version

type HelpOptions

+ NoExpandSubcommands bool

type Option

+ func DynamicCommand(name, help, group string, cmd interface{}) Option

+ type PlaceHolderProvider interface

+ PlaceHolder func(flag *Flag) string

type Tag

+ Passthrough bool

type Value

+ Passthrough bool

+ func (v *Value) IsCounter() bool

Mar 2, 2021

Changes in this version

+ func DefaultShortHelpPrinter(options HelpOptions, ctx *Context) error

type Flag

+ Negated bool

type HelpOptions

+ FlagsLast bool

type Option

+ func ShortHelp(shortHelp HelpPrinter) Option

+ func ShortUsageOnError() Option

type Tag

+ Negatable bool

Feb 9, 2021

Changes in this version

+ type Group struct

+ Description string

+ Key string

+ Title string

+ type Groups map[string]string

+ func (g Groups) Apply(k *Kong) error

type Node

+ Aliases []string

+ func (n *Node) ClosestGroup() *Group

type Option

+ func ExplicitGroups(groups []Group) Option

type Tag

+ Aliases []string

Dec 4, 2020

Changes in this version

+ type NamedFileContentFlag struct

+ Contents []byte

+ Filename string

+ func (f *NamedFileContentFlag) Decode(ctx *DecodeContext) error

type Option

+ func PostBuild(fn func(*Kong) error) Option

type Path

+ func (p *Path) Visitable() Visitable

+ type Plugins []interface

Jul 10, 2020

Changes in this version

type Kong

+ func (k *Kong) PostBuild(fn func(*Kong) error) Option

type Tag

+ func (t *Tag) GetSep(k string, dflt rune) (rune, error)

Apr 26, 2020

Changes in this version

type Context

+ func (c *Context) RunNode(node *Node, binds ...interface{}) (err error)

Apr 16, 2020

Changes in this version

type Resolver

+ func EnvarResolver() Resolver

Mar 3, 2020

Changes in this version

+ func DefaultHelpValueFormatter(value *Value) string

type HelpOptions

+ func (h *HelpOptions) CommandTree(node *Node, prefix string) (rows [][2]string)

+ func (h HelpOptions) Apply(k *Kong) error

+ type HelpValueFormatter func(value *Value) string

type Option

+ func BindToProvider(provider interface{}) Option

+ func HelpFormatter(helpFormatter HelpValueFormatter) Option

type Tag

+ MapSep rune

Oct 30, 2019

Changes in this version

type Flag

+ Xor string

type Tag

+ Xor string

Jun 21, 2019

Changes in this version

+ func ApplyDefaults(target interface{}, options ...Option) error

type Context

+ func (c *Context) ApplyDefaults() error

+ func (c *Context) Reset() error

type Scanner

+ func (s *Scanner) PopValueInto(context string, target interface{}) error

type TokenType

+ func (t TokenType) IsAny(types ...TokenType) bool

type Value

+ func (v *Value) ApplyDefault() error

+ func (v *Value) ShortSummary() string

Mar 29, 2019

Changes in this version

+ func DefaultHelpPrinter(options HelpOptions, ctx *Context) error

+ func ExpandPath(path string) string

+ func JoinEscaped(s []string, sep rune) string

+ func LineIndenter(prefix string) string

+ func SpaceIndenter(prefix string) string

+ func SplitEscaped(s string, sep rune) (out []string)

+ func TreeIndenter(prefix string) string

+ func Visit(node Visitable, visitor Visitor) error

+ type AfterApply interface

+ AfterApply func(args ...interface{}) error

+ type Application struct

+ HelpFlag *Flag

+ type Argument = Node

+ type BeforeApply interface

+ BeforeApply func(args ...interface{}) error

+ type BeforeResolve interface

+ BeforeResolve func(args ...interface{}) error

+ type BoolMapper interface

+ IsBool func() bool

+ type Command = Node

+ type ConfigFlag string

+ func (c ConfigFlag) BeforeResolve(kong *Kong, ctx *Context, trace *Path) error

+ type ConfigurationLoader func(r io.Reader) (Resolver, error)

+ type Context struct

+ Args []string

+ Error error

+ Path []*Path

+ func Parse(cli interface{}, options ...Option) *Context

+ func Trace(k *Kong, args []string) (*Context, error)

+ func (c *Context) AddResolver(resolver Resolver)

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

+ func (c *Context) Bind(args ...interface{})

+ func (c *Context) BindTo(impl, iface interface{})

+ func (c *Context) Command() string

+ func (c *Context) Empty() bool

+ func (c *Context) FlagValue(flag *Flag) interface{}

+ func (c *Context) Flags() (flags []*Flag)

+ func (c *Context) PrintUsage(summary bool) error

+ func (c *Context) Resolve() error

+ func (c *Context) Run(bindings ...interface{}) (err error)

+ func (c *Context) Selected() *Node

+ func (c *Context) Validate() error

+ func (c *Context) Value(path *Path) reflect.Value

+ type DecodeContext struct

+ Scan *Scanner

+ Value *Value

+ func (r *DecodeContext) WithScanner(scan *Scanner) *DecodeContext

+ type Error struct

+ func (e Error) Error() string

+ type FileContentFlag []byte

+ func (f *FileContentFlag) Decode(ctx *DecodeContext) error

+ type Flag struct

+ Env string

+ Group string

+ Hidden bool

+ PlaceHolder string

+ Short rune

+ func (f *Flag) FormatPlaceHolder() string

+ func (f *Flag) String() string

+ type HelpIndenter func(prefix string) string

+ type HelpOptions struct

+ Compact bool

+ Indenter HelpIndenter

+ NoAppSummary bool

+ Summary bool

+ Tree bool

+ type HelpPrinter func(options HelpOptions, ctx *Context) error

+ type HelpProvider interface

+ Help func() string

+ type Kong struct

+ Exit func(int)

+ Model *Application

+ Stderr io.Writer

+ Stdout io.Writer

+ func Must(ast interface{}, options ...Option) *Kong

+ func New(grammar interface{}, options ...Option) (*Kong, error)

+ func (k *Kong) Errorf(format string, args ...interface{}) *Kong

+ func (k *Kong) FatalIfErrorf(err error, args ...interface{})

+ func (k *Kong) Fatalf(format string, args ...interface{})

+ func (k *Kong) LoadConfig(path string) (Resolver, error)

+ func (k *Kong) Parse(args []string) (ctx *Context, err error)

+ func (k *Kong) Printf(format string, args ...interface{}) *Kong

+ type Mapper interface

+ Decode func(ctx *DecodeContext, target reflect.Value) error

+ type MapperFunc func(ctx *DecodeContext, target reflect.Value) error

+ func (m MapperFunc) Decode(ctx *DecodeContext, target reflect.Value) error

+ type MapperValue interface

+ Decode func(ctx *DecodeContext) error

+ type Next func(error) error

+ type Node struct

+ Argument *Value

+ Children []*Node

+ Detail string

+ Flags []*Flag

+ Group string

+ Help string

+ Hidden bool

+ Name string

+ Parent *Node

+ Positional []*Positional

+ Tag *Tag

+ Target reflect.Value

+ Type NodeType

+ func (n *Node) AllFlags(hide bool) (out [][]*Flag)

+ func (n *Node) Depth() int

+ func (n *Node) Find(ptr interface{}) *Node

+ func (n *Node) FlagSummary(hide bool) string

+ func (n *Node) FullPath() string

+ func (n *Node) Leaf() bool

+ func (n *Node) Leaves(hide bool) (out []*Node)

+ func (n *Node) Path() (out string)

+ func (n *Node) Summary() string

+ func (n *Node) Vars() Vars

+ type NodeType int

+ const ApplicationNode

+ const ArgumentNode

+ const CommandNode

+ type Option interface

+ Apply func(k *Kong) error

+ type OptionFunc func(k *Kong) error

+ func Bind(args ...interface{}) OptionFunc

+ func BindTo(impl, iface interface{}) OptionFunc

+ func ClearResolvers() OptionFunc

+ func Configuration(loader ConfigurationLoader, paths ...string) OptionFunc

+ func ConfigureHelp(options HelpOptions) OptionFunc

+ func Description(description string) OptionFunc

+ func Exit(exit func(int)) OptionFunc

+ func Help(help HelpPrinter) OptionFunc

+ func KindMapper(kind reflect.Kind, mapper Mapper) OptionFunc

+ func Name(name string) OptionFunc

+ func NamedMapper(name string, mapper Mapper) OptionFunc

+ func NoDefaultHelp() OptionFunc

+ func Resolvers(resolvers ...Resolver) OptionFunc

+ func TypeMapper(typ reflect.Type, mapper Mapper) OptionFunc

+ func UsageOnError() OptionFunc

+ func ValueMapper(ptr interface{}, mapper Mapper) OptionFunc

+ func Writers(stdout, stderr io.Writer) OptionFunc

+ func (o OptionFunc) Apply(k *Kong) error

+ type ParseError struct

+ Context *Context

+ func (p *ParseError) Cause() error

+ type Path struct

+ App *Application

+ Argument *Argument

+ Command *Command

+ Flag *Flag

+ Flags []*Flag

+ Parent *Node

+ Positional *Positional

+ Resolved bool

+ func (p *Path) Node() *Node

+ type Positional = Value

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) ForNamedType(name string, typ reflect.Type) Mapper

+ func (r *Registry) ForNamedValue(name string, value reflect.Value) Mapper

+ func (r *Registry) ForType(typ reflect.Type) Mapper

+ func (r *Registry) ForValue(value reflect.Value) Mapper

+ func (r *Registry) RegisterDefaults() *Registry

+ func (r *Registry) RegisterKind(kind reflect.Kind, mapper Mapper) *Registry

+ func (r *Registry) RegisterName(name string, mapper Mapper) *Registry

+ func (r *Registry) RegisterType(typ reflect.Type, mapper Mapper) *Registry

+ func (r *Registry) RegisterValue(ptr interface{}, mapper Mapper) *Registry

+ type Resolver interface

+ Resolve func(context *Context, parent *Path, flag *Flag) (string, error)

+ Validate func(app *Application) error

+ func JSON(r io.Reader) (Resolver, error)

+ type ResolverFunc func(context *Context, parent *Path, flag *Flag) (string, error)

+ func (r ResolverFunc) Resolve(context *Context, parent *Path, flag *Flag) (string, error)

+ func (r ResolverFunc) Validate(app *Application) error

+ type Scanner struct

+ func Scan(args ...string) *Scanner

+ func ScanFromTokens(tokens ...Token) *Scanner

+ func (s *Scanner) Len() int

+ func (s *Scanner) Peek() Token

+ func (s *Scanner) Pop() Token

+ func (s *Scanner) PopUntil(predicate func(Token) bool) (values []Token)

+ func (s *Scanner) PopValue(context string) string

+ func (s *Scanner) PopWhile(predicate func(Token) bool) (values []Token)

+ func (s *Scanner) Push(arg string) *Scanner

+ func (s *Scanner) PushToken(token Token) *Scanner

+ func (s *Scanner) PushTyped(arg string, typ TokenType) *Scanner

+ type Tag struct

+ Arg bool

+ Cmd bool

+ Default string

+ Embed bool

+ Enum string

+ Env string

+ Format string

+ Group string

+ Help string

+ Hidden bool

+ Ignored bool

+ Name string

+ Optional bool

+ PlaceHolder string

+ Prefix string

+ Required bool

+ Sep rune

+ Short rune

+ Type string

+ Vars Vars

+ func (t *Tag) Get(k string) string

+ func (t *Tag) GetAll(k string) []string

+ func (t *Tag) GetBool(k string) (bool, error)

+ func (t *Tag) GetFloat(k string) (float64, error)

+ func (t *Tag) GetInt(k string) (int64, error)

+ func (t *Tag) GetRune(k string) (rune, error)

+ func (t *Tag) Has(k string) bool

+ type Token struct

+ Type TokenType

+ Value string

+ func (t Token) InferredType() TokenType

+ func (t Token) IsAny(types ...TokenType) bool

+ func (t Token) IsEOL() bool

+ func (t Token) IsValue() bool

+ func (t Token) String() string

+ type TokenType int

+ const EOLToken

+ const FlagToken

+ const FlagValueToken

+ const PositionalArgumentToken

+ const ShortFlagTailToken

+ const ShortFlagToken

+ const UntypedToken

+ func (t TokenType) String() string

+ type Value struct

+ Default string

+ DefaultValue reflect.Value

+ Enum string

+ Flag *Flag

+ Format string

+ Help string

+ Mapper Mapper

+ Name string

+ Position int

+ Required bool

+ Set bool

+ Tag *Tag

+ Target reflect.Value

+ func (v *Value) Apply(value reflect.Value)

+ func (v *Value) EnumMap() map[string]bool

+ func (v *Value) IsBool() bool

+ func (v *Value) IsCumulative() bool

+ func (v *Value) IsMap() bool

+ func (v *Value) IsSlice() bool

+ func (v *Value) Parse(scan *Scanner, target reflect.Value) error

+ func (v *Value) Reset() error

+ func (v *Value) Summary() string

+ type Vars map[string]string

+ func (v Vars) Apply(k *Kong) error

+ func (v Vars) CloneWith(vars Vars) Vars

+ type VersionFlag bool

+ func (v VersionFlag) BeforeApply(app *Kong, vars Vars) error

+ type Visitable interface

+ type Visitor func(node Visitable, next Next) error