command

Documentation

Index

• func Annotation(key, value string) opt.Option[Command]
• func Annotations(annotations map[string]string) opt.Option[Command]
• func Deprecated(reason ...string) opt.Option[Command]
• func Example(example string) opt.Option[Command]
• func Module() module.Module
• func Runner(impl func(cmd *cobra.Command, args []string) error) opt.Option[Command]
• func StringFlag(flag Flag, ptr *string) opt.Option[Command]
• func SuggestFor(alternatives ...string) opt.Option[Command]
• type Command
  • func New(name string, short string, long string, opts ...opt.Option[Command]) *Command
• type Flag
• type Root
  • func NewRoot(params RootParams) *Root
  • func (r *Root) OnStart(ctx context.Context) error
  • func (r *Root) OnStop(context.Context) error
• type RootParams

Functions

func Annotation

func Annotation(key, value string) opt.Option[Command]

func Annotations

func Annotations(annotations map[string]string) opt.Option[Command]

func Deprecated

func Deprecated(reason ...string) opt.Option[Command]

func Example

func Example(example string) opt.Option[Command]

func Module

func Module() module.Module

func Runner

func Runner(impl func(cmd *cobra.Command, args []string) error) opt.Option[Command]

func StringFlag

func StringFlag(flag Flag, ptr *string) opt.Option[Command]

func SuggestFor

func SuggestFor(alternatives ...string) opt.Option[Command]

Types

type Command

type Command struct {
	Name                   string
	Short                  string
	Long                   string
	Run                    func(cmd *cobra.Command, args []string) error
	Example                string
	Annotations            map[string]string
	Deprecated             string
	SuggestFor             []string
	MutuallyExclusiveFlags []string
	RequiredFlags          []string
	FlagHandlers           map[string]func(cmd *cobra.Command) error
}

func New

func New(name string, short string, long string, opts ...opt.Option[Command]) *Command

type Flag

type Flag struct {
	Name      string
	Shorthand string
	Usage     string
	Required  bool
	Exclusive bool
}

type Root

type Root struct {
	// contains filtered or unexported fields
}

func NewRoot

func NewRoot(params RootParams) *Root

func (*Root) OnStart

func (r *Root) OnStart(ctx context.Context) error

func (*Root) OnStop

func (r *Root) OnStop(context.Context) error

type RootParams

type RootParams struct {
	fx.In
	Manifest *manifest.Manifest
	Shutdown fx.Shutdowner
	Commands []*Command `group:"command"`
}