Help us shape the future of Go! Take the 2026 Go Developer Survey

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

command

package

Go to main page

Versions in this module

v0

v0.4.1

Nov 12, 2025

v0.4.0

Oct 14, 2025

v0.3.0

Apr 29, 2024

v0.2.0

Aug 21, 2023

v0.1.0

May 8, 2023

Changes in this version

+ func Run(args []string) int

+ func RunCustom(args []string, runOpts *RunOptions) int

+ type BaseCommand struct

+ UI cli.Ui

+ type BoolPtr struct

+ func (b *BoolPtr) Get() bool

+ func (b *BoolPtr) IsSet() bool

+ func (b *BoolPtr) Set(v string) error

+ func (b *BoolPtr) String() string

+ type BoolPtrVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default *bool

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *BoolPtr

+ Usage string

+ type BoolVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default bool

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *bool

+ Usage string

+ type DurationVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default time.Duration

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *time.Duration

+ Usage string

+ type FlagBool interface

+ IsBoolFlag func() bool

+ type FlagExample interface

+ Example func() string

+ type FlagSet struct

+ func NewFlagSet(name string) *FlagSet

+ func (f *FlagSet) BoolPtrVar(i *BoolPtrVar)

+ func (f *FlagSet) BoolVar(i *BoolVar)

+ func (f *FlagSet) DurationVar(i *DurationVar)

+ func (f *FlagSet) Float64Var(i *Float64Var)

+ func (f *FlagSet) Int64Var(i *Int64Var)

+ func (f *FlagSet) IntVar(i *IntVar)

+ func (f *FlagSet) Name() string

+ func (f *FlagSet) StringMapVar(i *StringMapVar)

+ func (f *FlagSet) StringSliceVar(i *StringSliceVar)

+ func (f *FlagSet) StringVar(i *StringVar)

+ func (f *FlagSet) TimeVar(i *TimeVar)

+ func (f *FlagSet) Uint64Var(i *Uint64Var)

+ func (f *FlagSet) UintVar(i *UintVar)

+ func (f *FlagSet) Var(value flag.Value, name, usage string)

+ func (f *FlagSet) VarFlag(i *VarFlag)

+ func (f *FlagSet) Visit(fn func(*flag.Flag))

+ func (f *FlagSet) VisitAll(fn func(*flag.Flag))

+ type FlagSets struct

+ func NewFlagSets(ui cli.Ui) *FlagSets

+ func (f *FlagSets) Args() []string

+ func (f *FlagSets) Completions() complete.Flags

+ func (f *FlagSets) Help() string

+ func (f *FlagSets) NewFlagSet(name string) *FlagSet

+ func (f *FlagSets) Parse(args []string, opts ...ParseOptions) error

+ func (f *FlagSets) Parsed() bool

+ func (f *FlagSets) Visit(fn func(*flag.Flag))

+ type FlagVisibility interface

+ Hidden func() bool

+ type Float64Var struct

+ Aliases []string

+ Completion complete.Predictor

+ Default float64

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *float64

+ Usage string

+ type Int64Var struct

+ Aliases []string

+ Completion complete.Predictor

+ Default int64

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *int64

+ Usage string

+ type IntVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default int

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *int

+ Usage string

+ type ParseOptionAllowRawFormat bool

+ type ParseOptions interface

+ type ReviewCommand struct

+ func (r *ReviewCommand) AutocompleteArgs() complete.Predictor

+ func (r *ReviewCommand) AutocompleteFlags() complete.Flags

+ func (r *ReviewCommand) Flags() *FlagSets

+ func (r *ReviewCommand) Help() string

+ func (r *ReviewCommand) Run(args []string) int

+ func (r *ReviewCommand) Synopsis() string

+ type RunCommand struct

+ func (r *RunCommand) AutocompleteArgs() complete.Predictor

+ func (r *RunCommand) AutocompleteFlags() complete.Flags

+ func (r *RunCommand) Flags() *FlagSets

+ func (r *RunCommand) Help() string

+ func (r *RunCommand) Run(args []string) int

+ func (r *RunCommand) Synopsis() string

+ type RunOptions struct

+ Address string

+ Client *api.Client

+ Stderr io.Writer

+ Stdout io.Writer

+ type StringMapVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default map[string]string

+ Hidden bool

+ Name string

+ Target *map[string]string

+ Usage string

+ type StringSliceVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default []string

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *[]string

+ Usage string

+ type StringVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default string

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *string

+ Usage string

+ type TimeFormat int

+ const TimeVar_Day

+ const TimeVar_EpochSecond

+ const TimeVar_Month

+ const TimeVar_RFC3339Nano

+ const TimeVar_RFC3339Second

+ const TimeVar_TimeOrDay

+ type TimeVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default time.Time

+ EnvVar string

+ Formats TimeFormat

+ Hidden bool

+ Name string

+ Target *time.Time

+ Usage string

+ type Uint64Var struct

+ Aliases []string

+ Completion complete.Predictor

+ Default uint64

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *uint64

+ Usage string

+ type UintVar struct

+ Aliases []string

+ Completion complete.Predictor

+ Default uint

+ EnvVar string

+ Hidden bool

+ Name string

+ Target *uint

+ Usage string

+ type VarFlag struct

+ Aliases []string

+ Completion complete.Predictor

+ Default string

+ EnvVar string

+ Name string

+ Usage string

+ Value flag.Value

+ type VaultUI struct

+ type VersionCommand struct

+ func (c *VersionCommand) AutocompleteArgs() complete.Predictor

+ func (c *VersionCommand) AutocompleteFlags() complete.Flags

+ func (c *VersionCommand) Flags() *FlagSets

+ func (c *VersionCommand) Help() string

+ func (c *VersionCommand) Run(_ []string) int

+ func (c *VersionCommand) Synopsis() string