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

console

package module

Go to main page

Versions in this module

v0

v0.1.2

Sep 24, 2022

Changes in this version

+ var ErrExecuteNil = errors.New("console: execute is nil")

type AlternativesError

+ Alt []string

+ Err error

v0.1.1

Sep 18, 2022

Changes in this version

+ const ArgumentCommandName

+ const ArgumentNamespace

+ const OptionAnsi

+ const OptionFormat

+ const OptionHelp

+ const OptionNoAnsi

+ const OptionQuiet

+ const OptionVerbose

+ const OptionVersion

v0.1.0

Sep 18, 2022

Changes in this version

+ type AlternativesError struct

+ func (e AlternativesError) Alternatives() []string

+ func (e AlternativesError) Error() string

+ func (e AlternativesError) Is(err error) bool

+ func (e AlternativesError) Unwrap() error

v0.0.2

Mar 3, 2021

v0.0.1

Nov 1, 2020

Changes in this version

+ const CommandHelp

+ const CommandList

+ const HelpArgumentCommandName

+ var ErrCommandDuplicate = errors.New("console: duplicate command")

+ var ErrCommandNil = errors.New("console: Register command is nil")

+ var ErrNotFound = errors.New("command not found")

+ func Commands() []string

+ func Default(d *input.Definition) *input.Definition

+ func Execute(ctx context.Context, cmd *Command, opts ...func(*App))

+ func MustRegister(cmd *Command)

+ func Register(cmd *Command) error

+ func Run(ctx context.Context, cmd *Command, in input.Input, out output.Output) error

+ func WithExit(f func(int)) func(*App)

+ func WithInput(in input.Input) func(*App)

+ func WithOutput(out output.Output) func(*App)

+ func WithSkipArgs(l int) func(*App)

+ type Action func(ctx context.Context, input input.Input, output output.Output) error

+ type App struct

+ func New(opts ...func(*App)) *App

+ func (a *App) Add(cmds ...*Command) *App

+ func (a *App) Execute(ctx context.Context)

+ type Command struct

+ Configure Configure

+ Description string

+ Execute Action

+ Handle Handle

+ Help string

+ Hidden bool

+ Name string

+ Prepare Prepare

+ Version string

+ func Find(name string) (*Command, error)

+ func (c *Command) Init(ctx context.Context, cfg *input.Definition) error

+ func (c *Command) Run(ctx context.Context, in input.Input, out output.Output) error

+ func (c *Command) String() string

+ func (c *Command) With(opts ...Option) *Command

+ type Configure func(ctx context.Context, cfg *input.Definition) error

+ type ErrorAlternatives struct

+ func (e ErrorAlternatives) Alternatives() []string

+ func (e ErrorAlternatives) Error() string

+ func (e ErrorAlternatives) Is(err error) bool

+ func (e ErrorAlternatives) Unwrap() error

+ type Handle func(ctx context.Context, in input.Input, out output.Output, n Action) error

+ func ChainHandle(handlers ...Handle) Handle

+ type Option func(*Command)

+ func WithHandle(h ...Handle) Option

+ func WithHidden(v bool) Option

+ func WithName(n string) Option

+ func WithPrepare(p ...Prepare) Option

+ type Prepare func(ctx context.Context, cfg *input.Definition, n Configure) error

+ func ChainPrepare(prepare ...Prepare) Prepare