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

cli

package

Go to main page

Versions in this module

v0

v0.1.1

Apr 26, 2024

v0.1.0

Nov 1, 2023

Changes in this version

+ const EnvLogLevel

+ const EnvPlain

+ var ErrParsingArgsOrFlags = "error parsing args or flags"

+ var ErrSentinel = errors.New("error sentinel")

+ var ExposeDocs bool

+ func Commands(ctx context.Context, opts ...Option) (*baseCommand, map[string]cli.CommandFactory)

+ func GroupedHelpFunc(f cli.HelpFunc) cli.HelpFunc

+ func Main(args []string) int

+ func NoArgs(c *baseCommand, args []string) error

+ type DestroyCommand struct

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

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

+ func (c *DestroyCommand) Flags() *flag.Sets

+ func (c *DestroyCommand) Help() string

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

+ func (c *DestroyCommand) Synopsis() string

+ func (c DestroyCommand) Close() error

+ func (c DestroyCommand) GetExample() string

+ func (c DestroyCommand) Init(opts ...Option) error

+ func (c DestroyCommand) IsLinux() bool

+ func (c DestroyCommand) IsMac() bool

+ func (c DestroyCommand) IsWindows() bool

+ type DocGenerateCommand struct

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

+ func (c DocGenerateCommand) Close() error

+ func (c DocGenerateCommand) GetExample() string

+ func (c DocGenerateCommand) Help() string

+ func (c DocGenerateCommand) Init(opts ...Option) error

+ func (c DocGenerateCommand) IsLinux() bool

+ func (c DocGenerateCommand) IsMac() bool

+ func (c DocGenerateCommand) IsWindows() bool

+ func (c DocGenerateCommand) Synopsis() string

+ type GenerateHelpCommand struct

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

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

+ func (c *GenerateHelpCommand) Flags() *flag.Sets

+ func (c *GenerateHelpCommand) Help() string

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

+ func (c *GenerateHelpCommand) Synopsis() string

+ func (c GenerateHelpCommand) Close() error

+ func (c GenerateHelpCommand) GetExample() string

+ func (c GenerateHelpCommand) Init(opts ...Option) error

+ func (c GenerateHelpCommand) IsLinux() bool

+ func (c GenerateHelpCommand) IsMac() bool

+ func (c GenerateHelpCommand) IsWindows() bool

+ type GeneratePackCommand struct

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

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

+ func (c *GeneratePackCommand) Flags() *flag.Sets

+ func (c *GeneratePackCommand) Help() string

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

+ func (c *GeneratePackCommand) Synopsis() string

+ func (c GeneratePackCommand) Close() error

+ func (c GeneratePackCommand) GetExample() string

+ func (c GeneratePackCommand) Init(opts ...Option) error

+ func (c GeneratePackCommand) IsLinux() bool

+ func (c GeneratePackCommand) IsMac() bool

+ func (c GeneratePackCommand) IsWindows() bool

+ type GenerateRegistryCommand struct

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

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

+ func (c *GenerateRegistryCommand) Flags() *flag.Sets

+ func (c *GenerateRegistryCommand) Help() string

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

+ func (c *GenerateRegistryCommand) Synopsis() string

+ func (c GenerateRegistryCommand) Close() error

+ func (c GenerateRegistryCommand) GetExample() string

+ func (c GenerateRegistryCommand) Init(opts ...Option) error

+ func (c GenerateRegistryCommand) IsLinux() bool

+ func (c GenerateRegistryCommand) IsMac() bool

+ func (c GenerateRegistryCommand) IsWindows() bool

+ type HasFlags interface

+ Flags func() *flag.Sets

+ type InfoCommand struct

+ func (c *InfoCommand) Flags() *flag.Sets

+ func (c *InfoCommand) Help() string

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

+ func (c *InfoCommand) Synopsis() string

+ func (c InfoCommand) Close() error

+ func (c InfoCommand) GetExample() string

+ func (c InfoCommand) Init(opts ...Option) error

+ func (c InfoCommand) IsLinux() bool

+ func (c InfoCommand) IsMac() bool

+ func (c InfoCommand) IsWindows() bool

+ type JobStatusError struct

+ type JobStatusInfo struct

+ type ListCommand struct

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

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

+ func (c *ListCommand) Flags() *flag.Sets

+ func (c *ListCommand) Help() string

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

+ func (c *ListCommand) Synopsis() string

+ func (c ListCommand) Close() error

+ func (c ListCommand) GetExample() string

+ func (c ListCommand) Init(opts ...Option) error

+ func (c ListCommand) IsLinux() bool

+ func (c ListCommand) IsMac() bool

+ func (c ListCommand) IsWindows() bool

+ type Option func(c *baseConfig)

+ func WithArgs(args []string) Option

+ func WithClient(v bool) Option

+ func WithConfig(optional bool) Option

+ func WithCustomArgs(args []string, customValidation ValidationFn) Option

+ func WithExactArgs(n int, args []string) Option

+ func WithFlags(f *flag.Sets) Option

+ func WithMaximumNArgs(n int, args []string) Option

+ func WithMinimumNArgs(n int, args []string) Option

+ func WithNoArgs(args []string) Option

+ func WithNoConfig() Option

+ func WithSingleApp() Option

+ func WithUI(ui terminal.UI) Option

+ type PlanCommand struct

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

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

+ func (c *PlanCommand) Flags() *flag.Sets

+ func (c *PlanCommand) Help() string

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

+ func (c *PlanCommand) Synopsis() string

+ func (c PlanCommand) Close() error

+ func (c PlanCommand) GetExample() string

+ func (c PlanCommand) Init(opts ...Option) error

+ func (c PlanCommand) IsLinux() bool

+ func (c PlanCommand) IsMac() bool

+ func (c PlanCommand) IsWindows() bool

+ type RegistryAddCommand struct

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

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

+ func (c *RegistryAddCommand) Flags() *flag.Sets

+ func (c *RegistryAddCommand) Help() string

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

+ func (c *RegistryAddCommand) Synopsis() string

+ func (c RegistryAddCommand) Close() error

+ func (c RegistryAddCommand) GetExample() string

+ func (c RegistryAddCommand) Init(opts ...Option) error

+ func (c RegistryAddCommand) IsLinux() bool

+ func (c RegistryAddCommand) IsMac() bool

+ func (c RegistryAddCommand) IsWindows() bool

+ type RegistryDeleteCommand struct

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

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

+ func (c *RegistryDeleteCommand) Flags() *flag.Sets

+ func (c *RegistryDeleteCommand) Help() string

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

+ func (c *RegistryDeleteCommand) Synopsis() string

+ func (c RegistryDeleteCommand) Close() error

+ func (c RegistryDeleteCommand) GetExample() string

+ func (c RegistryDeleteCommand) Init(opts ...Option) error

+ func (c RegistryDeleteCommand) IsLinux() bool

+ func (c RegistryDeleteCommand) IsMac() bool

+ func (c RegistryDeleteCommand) IsWindows() bool

+ type RegistryHelpCommand struct

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

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

+ func (c *RegistryHelpCommand) Flags() *flag.Sets

+ func (c *RegistryHelpCommand) Help() string

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

+ func (c *RegistryHelpCommand) Synopsis() string

+ func (c RegistryHelpCommand) Close() error

+ func (c RegistryHelpCommand) GetExample() string

+ func (c RegistryHelpCommand) Init(opts ...Option) error

+ func (c RegistryHelpCommand) IsLinux() bool

+ func (c RegistryHelpCommand) IsMac() bool

+ func (c RegistryHelpCommand) IsWindows() bool

+ type RegistryListCommand struct

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

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

+ func (c *RegistryListCommand) Flags() *flag.Sets

+ func (c *RegistryListCommand) Help() string

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

+ func (c *RegistryListCommand) Synopsis() string

+ func (c RegistryListCommand) Close() error

+ func (c RegistryListCommand) GetExample() string

+ func (c RegistryListCommand) Init(opts ...Option) error

+ func (c RegistryListCommand) IsLinux() bool

+ func (c RegistryListCommand) IsMac() bool

+ func (c RegistryListCommand) IsWindows() bool

+ type Render struct

+ Content string

+ Name string

+ type RenderCommand struct

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

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

+ func (c *RenderCommand) Flags() *flag.Sets

+ func (c *RenderCommand) Help() string

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

+ func (c *RenderCommand) Synopsis() string

+ func (c RenderCommand) Close() error

+ func (c RenderCommand) GetExample() string

+ func (c RenderCommand) Init(opts ...Option) error

+ func (c RenderCommand) IsLinux() bool

+ func (c RenderCommand) IsMac() bool

+ func (c RenderCommand) IsWindows() bool

+ type RunCommand struct

+ Validation ValidationFn

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

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

+ func (c *RunCommand) Flags() *flag.Sets

+ func (c *RunCommand) Help() string

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

+ func (c *RunCommand) Synopsis() string

+ func (c RunCommand) Close() error

+ func (c RunCommand) GetExample() string

+ func (c RunCommand) Init(opts ...Option) error

+ func (c RunCommand) IsLinux() bool

+ func (c RunCommand) IsMac() bool

+ func (c RunCommand) IsWindows() bool

+ type StatusCommand struct

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

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

+ func (c *StatusCommand) Flags() *flag.Sets

+ func (c *StatusCommand) Help() string

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

+ func (c *StatusCommand) Synopsis() string

+ func (c StatusCommand) Close() error

+ func (c StatusCommand) GetExample() string

+ func (c StatusCommand) Init(opts ...Option) error

+ func (c StatusCommand) IsLinux() bool

+ func (c StatusCommand) IsMac() bool

+ func (c StatusCommand) IsWindows() bool

+ type StopCommand struct

+ Validation ValidationFn

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

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

+ func (c *StopCommand) Flags() *flag.Sets

+ func (c *StopCommand) Help() string

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

+ func (c *StopCommand) Synopsis() string

+ func (c StopCommand) Close() error

+ func (c StopCommand) GetExample() string

+ func (c StopCommand) Init(opts ...Option) error

+ func (c StopCommand) IsLinux() bool

+ func (c StopCommand) IsMac() bool

+ func (c StopCommand) IsWindows() bool

+ type ValidationFn func(c *baseCommand, args []string) error

+ func ExactArgs(n int) ValidationFn

+ func MaximumNArgs(n int) ValidationFn

+ func MinimumNArgs(n int) ValidationFn

+ type VersionCommand struct

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

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

+ func (c *VersionCommand) Flags() *flag.Sets

+ func (c *VersionCommand) Help() string

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

+ func (c *VersionCommand) Synopsis() string

+ func (c VersionCommand) Close() error

+ func (c VersionCommand) GetExample() string

+ func (c VersionCommand) Init(opts ...Option) error

+ func (c VersionCommand) IsLinux() bool

+ func (c VersionCommand) IsMac() bool

+ func (c VersionCommand) IsWindows() bool

v0.0.1-techpreview2

Feb 7, 2022

v0.0.1-techpreview.3

Jul 21, 2022