Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

cli

package module

Go to main page

Versions in this module

v0

v0.0.18

Jul 27, 2021

v0.0.17

Feb 18, 2021

v0.0.16

Sep 20, 2018

Changes in this version

+ const LicenseText

type Cli

+ VerbsRequired bool

+ func (c *Cli) NewVerb(name string, usage string, ...) *Verb

+ func (c *Cli) SetParams(params ...string)

+ func (c *Cli) Verbs() map[string]string

+ type Verb struct

+ Documentation map[string][]byte

+ FlagSet *flag.FlagSet

+ Fn func(io.Reader, io.Writer, io.Writer, []string, *flag.FlagSet) int

+ Name string

+ SectionNo int

+ Usage string

+ func NewVerb(name, usage string, ...) *Verb

+ func (v *Verb) AddFlagSet(flagSet *flag.FlagSet)

+ func (v *Verb) AddHelp(keyword string, usage []byte) error

+ func (v *Verb) Arg(i int) string

+ func (v *Verb) Args() []string

+ func (v *Verb) BoolVar(p *bool, names string, value bool, usage string)

+ func (v *Verb) DurationVar(p *time.Duration, names string, value time.Duration, usage string)

+ func (v *Verb) Float64Var(p *float64, names string, value float64, usage string)

+ func (v *Verb) HasOptions() bool

+ func (v *Verb) Help(keywords ...string) string

+ func (v *Verb) Int64Var(p *int64, names string, value int64, usage string)

+ func (v *Verb) IntVar(p *int, names string, value int, usage string)

+ func (v *Verb) NArg() int

+ func (v *Verb) Option(op string) string

+ func (v *Verb) Options() map[string]string

+ func (v *Verb) Parse(args []string) error

+ func (v *Verb) SetParams(params ...string)

+ func (v *Verb) String() string

+ func (v *Verb) StringVar(p *string, names string, value string, usage string)

+ func (v *Verb) Uint64Var(p *uint64, names string, value uint64, usage string)

+ func (v *Verb) UintVar(p *uint, names string, value uint, usage string)

v0.0.13

Aug 7, 2018

Changes in this version

+ func Generate(...) []byte

+ func PushArg(s string, args []string) []string

+ func ShiftArg(args []string) (string, []string)

+ func UnshiftArg(s string, args []string) []string

type Cli

+ ActionsRequired bool

+ SectionNo int

+ func (c *Cli) AddVerb(verb string, usage string) error

+ func (c *Cli) GenerateManPage(w io.Writer)

+ func (c *Cli) GenerateMarkdown(w io.Writer)

+ func (c *Cli) Verb(args []string) string

v0.0.5

Dec 12, 2017

Changes in this version

+ const Version

+ func CloseFile(filename string, fp *os.File) error

+ func Create(filename string, fallbackFile *os.File) (*os.File, error)

+ func ExitOnError(out *os.File, err error, quiet bool)

+ func IsPipe(in *os.File) bool

+ func OnError(out *os.File, err error, quiet bool)

+ func Open(filename string, fallbackFile *os.File) (*os.File, error)

+ func PopArg(args []string) (string, []string)

+ func ReadLines(in *os.File) ([]string, error)

+ type Action struct

+ Fn func(io.Reader, io.Writer, io.Writer, []string) int

+ Name string

+ Usage string

+ func (a *Action) String() string

+ type Cli struct

+ Documentation map[string][]byte

+ Eout *os.File

+ In *os.File

+ Out *os.File

+ func NewCli(version string) *Cli

+ func (c *Cli) Action(verb string) string

+ func (c *Cli) Actions() map[string]string

+ func (c *Cli) AddAction(verb string, fn func(io.Reader, io.Writer, io.Writer, []string) int, ...) error

+ func (c *Cli) AddHelp(keyword string, usage []byte) error

+ func (c *Cli) AddParams(params ...string)

+ func (c *Cli) AppName() string

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

+ func (c *Cli) Args() []string

+ func (c *Cli) BoolVar(p *bool, names string, value bool, usage string)

+ func (c *Cli) DurationVar(p *time.Duration, names string, value time.Duration, usage string)

+ func (c *Cli) Env(name string) string

+ func (c *Cli) EnvAttribute(name string) (*EnvAttribute, error)

+ func (c *Cli) EnvBool(name string, value bool, usage string) *bool

+ func (c *Cli) EnvBoolVar(p *bool, name string, value bool, usage string) error

+ func (c *Cli) EnvDuration(name string, value time.Duration, usage string) *time.Duration

+ func (c *Cli) EnvDurationVar(p *time.Duration, name string, value time.Duration, usage string) error

+ func (c *Cli) EnvFloat64(name string, value float64, usage string) *float64

+ func (c *Cli) EnvInt(name string, value int, usage string) *int

+ func (c *Cli) EnvInt64(name string, value int64, usage string) *int64

+ func (c *Cli) EnvInt64Var(p *int64, name string, value int64, usage string) error

+ func (c *Cli) EnvIntVar(p *int, name string, value int, usage string) error

+ func (c *Cli) EnvString(name string, value string, usage string) *string

+ func (c *Cli) EnvStringVar(p *string, name string, value string, usage string) error

+ func (c *Cli) EnvUint(name string, value uint, usage string) *uint

+ func (c *Cli) EnvUint64(name string, value uint64, usage string) *uint64

+ func (c *Cli) EnvUint64Var(p *uint64, name string, value uint64, usage string) error

+ func (c *Cli) EnvUintVar(p *uint, name string, value uint, usage string) error

+ func (c *Cli) Float64Var(p *float64, names string, value float64, usage string)

+ func (c *Cli) GenerateMarkdownDocs(w io.Writer)

+ func (c *Cli) Getenv(name string) string

+ func (c *Cli) Help(keywords ...string) string

+ func (c *Cli) Int64Var(p *int64, names string, value int64, usage string)

+ func (c *Cli) IntVar(p *int, names string, value int, usage string)

+ func (c *Cli) License() string

+ func (c *Cli) NArg() int

+ func (c *Cli) Option(op string) string

+ func (c *Cli) Options() map[string]string

+ func (c *Cli) Parse() error

+ func (c *Cli) ParseEnv() error

+ func (c *Cli) ParseOptions()

+ func (c *Cli) Run(args []string) int

+ func (c *Cli) StringVar(p *string, names string, value string, usage string)

+ func (c *Cli) Uint64Var(p *uint64, names string, value uint64, usage string)

+ func (c *Cli) UintVar(p *uint, names string, value uint, usage string)

+ func (c *Cli) Usage(w io.Writer)

+ func (c *Cli) Version() string

+ type Config struct

+ DescriptionText string

+ EnvPrefix string

+ ExampleText string

+ LicenseText string

+ OptionText string

+ Options map[string]string

+ UsageText string

+ VersionText string

+ func New(appName, envPrefix, version string) *Config

+ func (cfg *Config) AddExample(topic, text string)

+ func (cfg *Config) AddHelp(topic, text string)

+ func (cfg *Config) CheckOption(envVar, value string, required bool) string

+ func (cfg *Config) Example(topics ...string) string

+ func (cfg *Config) Get(key string) string

+ func (cfg *Config) Help(topics ...string) string

+ func (cfg *Config) License() string

+ func (cfg *Config) MergeEnv(envVar, flagValue string) string

+ func (cfg *Config) MergeEnvBool(envVar string, flagValue bool) bool

+ func (cfg *Config) StandardOptions(showHelp, showExamples, showLicense, showVersion bool, args []string) string

+ func (cfg *Config) Usage() string

+ func (cfg *Config) Version() string

+ type EnvAttribute struct

+ BoolValue bool

+ DurationValue time.Duration

+ Float64Value float64

+ Int64Value int64

+ IntValue int

+ Name string

+ StringValue string

+ Type string

+ Uint64Value uint64

+ UintValue uint

+ Usage string