Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

app

package

Go to main page

Versions in this module

v1

v1.0.4

May 29, 2024

v1.0.3

Jan 4, 2023

Changes in this version

+ const CtxGetResultFn

type App

+ func (a *App) NewCobra() (*cobra.Command, error)

type Cmd

+ func (c *Cmd) MarshalJSON() ([]byte, error)

type CobraFunc

+ func (c *CobraFunc) String() string

+ type JCmd struct

+ Aliases []string

+ Annotations map[string]string

+ ArgAliases []string

+ Args string

+ ArgsValidator ValidatorCtor

+ BashCompletionFunction string

+ Category string

+ Deprecated string

+ DisableAutoGenTag bool

+ DisableFlagParsing bool

+ DisableFlagsInUseLine bool

+ DisableSuggestions bool

+ Example mstring

+ Hidden bool

+ Input CmdInput

+ InputCtor string

+ Long mstring

+ PersistentPostRunE string

+ PersistentPreRunE string

+ PostRunE string

+ PreRunE string

+ RunE string

+ Short string

+ SilenceErrors bool

+ SilenceUsage bool

+ SubCommands []*Cmd

+ SuggestFor []string

+ SuggestionsMinimumDistance int

+ TraverseChildren bool

+ Use string

+ ValidArgs []string

+ Version string

type RunFunc

+ func (c *RunFunc) String() string

v1.0.2

Jun 9, 2022

v1.0.1

Feb 28, 2022

v1.0.0

Feb 24, 2022

Changes in this version

+ const CmdValidate

+ const CtxAddResultFn

+ const CtxCmd

+ const CtxPrintResultFn

+ const CtxResult

+ const SpecKey

+ func AddTemplateFunc(name string, tmplFunc interface{})

+ func NewSpec(categories []*CmdCategory, cmdRoot *Cmd) *spec

+ func SpecOf(cmd *cobra.Command) *spec

+ type AddResultFn func(key string, out interface{}, err error)

+ type App struct

+ func NewApp(spec *spec, rtSpec *Runtime) (*App, error)

+ func NewAppFromSpec(jsonSpec string, rtSpec *Runtime) (*App, error)

+ func (a *App) Cobra() (*cobra.Command, error)

+ func (a *App) Command(path []string) (*Cmd, error)

+ func (a *App) SetCommandEnd(cmdEnd CommandEnd)

+ func (a *App) SetCommandStart(cmdStart CommandStart)

+ func (a *App) SetMonitorResults(b bool)

+ func (a *App) Spec() *spec

+ func (a *App) WithCustomFlags(custom bflags.Flagger) *App

+ func (a *App) WithFlagsChecker(flagsChecker CobraFunction) *App

+ type Cmd struct

+ Aliases []string

+ Annotations map[string]string

+ ArgAliases []string

+ Args string

+ ArgsValidator ValidatorCtor

+ BashCompletionFunction string

+ Category string

+ Deprecated string

+ DisableAutoGenTag bool

+ DisableFlagParsing bool

+ DisableFlagsInUseLine bool

+ DisableSuggestions bool

+ Example mstring

+ Hidden bool

+ Input CmdInput

+ InputCtor string

+ Long mstring

+ PersistentPostRunE CobraFunc

+ PersistentPreRunE CobraFunc

+ PostRunE CobraFunc

+ PreRunE CobraFunc

+ RunE RunFunc

+ Short string

+ SilenceErrors bool

+ SilenceUsage bool

+ SubCommands []*Cmd

+ SuggestFor []string

+ SuggestionsMinimumDistance int

+ TraverseChildren bool

+ Use string

+ ValidArgs []string

+ Version string

+ func (c *Cmd) Name() string

+ func (c *Cmd) Sub(path []string) (*Cmd, error)

+ func (c *Cmd) ToCobra(parent *cobra.Command, f bflags.Flagger) (*cobra.Command, error)

+ func (c *Cmd) UpdateExamples(upd func(s string) string)

+ type CmdCategories []*CmdCategory

+ func NewCategories(categories []*CmdCategory, cmdRoot *cobra.Command) CmdCategories

+ func (c CmdCategories) GetCategories() []*CmdCategory

+ type CmdCategory struct

+ Cmds []*cobra.Command

+ Default bool

+ Name string

+ Title string

+ type CmdCtx struct

+ func NewCmdCtx() *CmdCtx

+ func (c *CmdCtx) Get(k string) (interface{}, bool)

+ func (c *CmdCtx) Set(k string, v interface{})

+ type CmdFlag interface

+ Arg func() bool

+ CmdPath func() string

+ FlagName func() string

+ Value func() interface{}

+ type CmdInput interface

+ type CmdResult struct

+ Error error

+ Key string

+ Result interface{}

+ func (r *CmdResult) String() string

+ type CmdSampler interface

+ ValidateExamples func() error

+ ValidateInputSamples func() error

+ func NewCmdSampler(app *App, printer SamplePrinter, validator CmdValidator) CmdSampler

+ type CmdValidator interface

+ InputSamples func(cmdPath []string, in interface{}) []*InputSample

+ Validate func(cmdPath []string, val *InputSample, in interface{}) error

+ ValidateError func(cmdPath []string, val *InputSample, err error) error

+ type CobraFunc struct

+ func CobraFn(fn CobraFunction) CobraFunc

+ func CobraFnWithName(name string) CobraFunc

+ func (c *CobraFunc) MarshalText() ([]byte, error)

+ func (c *CobraFunc) UnmarshalText(text []byte) error

+ type CobraFunction func(cmd *cobra.Command, args []string) error

+ type CommandEnd func(cmd *cobra.Command, out interface{}, err error)

+ type CommandStart func(cmd *cobra.Command)

+ type Ctor func() interface

+ type FlagsDictionary interface

+ String func() string

+ Validate func(root *cobra.Command) error

+ func NewFlagDictionary(v FlagsValidator, withArgs bool) FlagsDictionary

+ type FlagsValidator interface

+ Validate func(t reflect.Type, flags []CmdFlag) error

+ type InputSample struct

+ ExpectFail bool

+ ExpectedFailure string

+ Input interface{}

+ type PrintResultFn func(results []*CmdResult)

+ type RunFunc struct

+ func RunFn(fn Runfn) RunFunc

+ func RunFnWithName(name string) RunFunc

+ func (c *RunFunc) MarshalText() ([]byte, error)

+ func (c *RunFunc) UnmarshalText(text []byte) error

+ func (c RunFunc) Func() Runfn

+ func (c RunFunc) IsNil() bool

+ type Runfn interface

+ type Runtime struct

+ func RtFunctions(cobraFns map[string]CobraFunction, inputs map[string]Ctor, ...) (*Runtime, error)

+ type SamplePrinter interface

+ Example func(cmdLine string)

+ ExamplesSummary func(withRun, withEx, exCount int) error

+ Print func(cmdPath []string, sample *InputSample, cmdLine string)

+ type ValidatorCtor func(c *cobra.Command) func(c *cobra.Command, args []string) error