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
- API
  
  Reference documentation for the pkg.go.dev API
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

Go to main page

Versions in this module

v1

v1.21.1

Aug 28, 2026

v1.21.0

Aug 28, 2026

v1.20.0

Aug 2, 2026

Changes in this version

+ const EngineEnvVar

+ var ErrNoSuchTopic = errors.New("no such help topic")

+ type Engine interface

+ Binary func() string

+ Name func() string

+ Title func() string

type Options

+ CommandsCommand struct{}

+ Values struct{ ... }

v1.10.0

Jul 23, 2026

Changes in this version

+ const AdministrativeCommand

+ const DestructiveCommand

+ const HiddenCommand

+ const MiscellaneousCommand

+ const NonDestructiveCommand

+ var Adjectives []string

+ var BuildTime string

+ var GitCommit string

+ var Nouns []string

+ var Version string

+ func Main(version, buildTime, gitCommit string)

+ func RandomName() string

+ func Signals()

+ type CLI struct

+ type Handler func(command string, args ...string) error

+ type Help struct

+ Description string

+ Summary string

+ Type string

+ Usage string

+ type Options struct

+ Ask struct{}

+ Auth struct{ ... }

+ Clobber bool

+ Copy struct{ ... }

+ Curl struct{ ... }

+ DHParam struct{}

+ Delete struct{ ... }

+ Env struct{ ... }

+ Envvars struct{}

+ Exists struct{}

+ Export struct{ ... }

+ Fmt struct{}

+ Gen struct{ ... }

+ Get struct{ ... }

+ Help bool

+ HelpCommand struct{}

+ Import struct{ ... }

+ Init struct{ ... }

+ Insecure bool

+ List struct{ ... }

+ Local struct{ ... }

+ Logout struct{}

+ Move struct{ ... }

+ Option struct{}

+ Paste struct{}

+ Paths struct{ ... }

+ Prompt struct{}

+ Quiet bool

+ RSA struct{}

+ Rekey struct{ ... }

+ Renew struct{}

+ Revert struct{ ... }

+ SSH struct{}

+ Seal struct{}

+ Set struct{}

+ SkipIfExists bool

+ Status struct{ ... }

+ Target struct{ ... }

+ Targets struct{ ... }

+ Tree struct{ ... }

+ UUID struct{}

+ Undelete struct{ ... }

+ Unseal struct{}

+ UseTarget string

+ Vault struct{}

+ Version bool

+ VersionCommand struct{}

+ Versions struct{}

+ X509 struct{ ... }

+ type Runner struct

+ Handlers map[string]Handler

+ Topics map[string]*Help

+ func NewRunner() *Runner

+ func (r *Runner) Dispatch(command string, help *Help, fn Handler)

+ func (r *Runner) Execute(command string, args ...string) error

+ func (r *Runner) Help(out io.Writer, topic string)

+ func (r *Runner) HelpTopic(topic string, help string)

+ func (r *Runner) PrintUsage(w io.Writer, topic string)

+ func (r *Runner) Usage(topic string) error

+ type TokenStatus struct

+ func (t TokenStatus) MarshalJSON() ([]byte, error)

+ func (t TokenStatus) String() string

+ type UsageError struct

+ Topic string

+ func (e *UsageError) Error() string