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

v0

v0.36.0

Aug 4, 2026

v0.35.0

Jul 7, 2026

v0.34.0

Jul 1, 2026

v0.33.0

Jun 10, 2026

Changes in this version

+ type Flags struct

+ func (f Flags) GetOptionalBool(flag string) bool

+ func (f Flags) GetOptionalBoolWrapper(flag string) *wrapperspb.BoolValue

+ func (f Flags) GetOptionalID(idFlag string) string

+ func (f Flags) GetOptionalInt32(flag string) int32

+ func (f Flags) GetOptionalString(flag string) string

+ func (f Flags) GetRequiredBool(flag string) bool

+ func (f Flags) GetRequiredID(idFlag string) string

+ func (f Flags) GetRequiredInt32(flag string) int32

+ func (f Flags) GetRequiredString(flag string) string

+ func (f Flags) GetStringSlice(flag string, v []string, opts FlagsStringSliceOptions) []string

v0.32.0

May 20, 2026

v0.31.0

Apr 22, 2026

Changes in this version

+ const ActionCreate

+ const ActionDeactivate

+ const ActionDelete

+ const ActionGet

+ const ActionList

+ const ActionReactivate

+ const ActionUpdate

+ const ActionUpdateUnsafe

+ const ExitCodeError

+ const ExitCodeSuccess

+ const FlexColumnWidthFive

+ const FlexColumnWidthFour

+ const FlexColumnWidthOne

+ const FlexColumnWidthThree

+ const FlexColumnWidthTwo

+ const InputNameFQN

+ const InputNameFQNUpdated

+ var ErrPrinterExpectsCommand = errors.New("printer expects a command")

+ func AggregateClientIDs(reqCtx []*policy.RequestContext) []string

+ func AskForInput(message string) string

+ func AskForSecret(message string) string

+ func CommaSeparated(values []string) string

+ func ConfirmAction(action, resource, id string, force bool)

+ func ConfirmActionSubtext(action, resource, id, subtext string, force bool)

+ func ConfirmTextInput(action, resource, inputName, shouldMatchValue string)

+ func ConstructMetadata(m *common.Metadata) map[string]string

+ func DebugJSON(msg string) interface

+ func DebugMessage(msg string) string

+ func ErrorJSON(msg string, err error) interface

+ func ErrorMessage(msg string, err error) string

+ func ExitWithError(errMsg string, err error)

+ func ExitWithNotFoundError(errMsg string, err error)

+ func ExitWithWarning(warnMsg string)

+ func FooterMessage(msg string) string

+ func GetJSONInput(data string) (string, error)

+ func GetSimpleObligationValues(v []*policy.ObligationValue) []string

+ func GetSimpleRegisteredResourceActionAttributeValues(v []*policy.RegisteredResourceValue_ActionAttributeValue) []string

+ func GetSimpleRegisteredResourceValues(v []*policy.RegisteredResourceValue) []string

+ func GetState(cmd *cobra.Command) common.ActiveStateEnum

+ func KeyAlgToEnum(alg string) (policy.Algorithm, error)

+ func KeyEnumToAlg(enum policy.Algorithm) (string, error)

+ func MessageJSON(status string, msg string) interface

+ func NewTable(cols ...table.Column) table.Model

+ func NewTabular(rows ...[]string) table.Model

+ func NewUUIDColumn() table.Column

+ func PrettyList(values []string) string

+ func PrintSuccessTable(cmd *cobra.Command, id string, t table.Model)

+ func ReadFromArgsOrPipe(args []string, pipe *os.File) []byte

+ func ReadFromFile(filePath string) []byte

+ func ReadFromPipe(in *os.File) []byte

+ func SuccessJSON(msg string) interface

+ func SuccessMessage(msg string) string

+ func TermWidth() int

+ func WarningJSON(msg string) interface

+ func WarningMessage(msg string) string

+ func WithListPaginationFooter(t table.Model, p *policy.PageResponse) table.Model

+ func WithPrintJSON() cliVariadicOption

+ type Cli struct

+ FlagHelper *flagHelper

+ Flags *flagHelper

+ func New(cmd *cobra.Command, args []string, options ...cliVariadicOption) *Cli

+ func (c *Cli) Cmd() *cobra.Command

+ func (c *Cli) Context() context.Context

+ func (c *Cli) ExitWith(styledMsg string, jsonMsg interface{}, code int, w io.Writer)

+ func (c *Cli) ExitWithError(errMsg string, err error)

+ func (c *Cli) ExitWithJSON(v interface{}, code int)

+ func (c *Cli) ExitWithMessage(msg string, code int)

+ func (c *Cli) ExitWithNotFoundError(errMsg string, err error)

+ func (c *Cli) ExitWithSuccess(msg string)

+ func (c *Cli) ExitWithWarning(warnMsg string)

+ func (c *Cli) SetJSONOutput(enabled bool)

+ type Color struct

+ Background lipgloss.CompleteAdaptiveColor

+ Foreground lipgloss.CompleteAdaptiveColor

+ func ColorYellow() Color

+ type FlagsStringSliceOptions struct

+ Max int

+ Min int

+ type Printer struct

+ type SimpleAttribute struct

+ Active string

+ AllowTraversal string

+ ID string

+ Metadata map[string]string

+ Name string

+ Namespace string

+ Rule string

+ Values []string

+ func GetSimpleAttribute(a *policy.Attribute) SimpleAttribute

+ type SimpleAttributeValue struct

+ Active string

+ FQN string

+ ID string

+ Metadata map[string]string

+ func GetSimpleAttributeValue(v *policy.Value) SimpleAttributeValue