command

Documentation

Index

• type AgentCommand
  • func (c *AgentCommand) Help() string
  • func (c *AgentCommand) Run(args []string) int
  • func (c *AgentCommand) Synopsis() string
• type VersionCommand
  • func (c *VersionCommand) Help() string
  • func (c *VersionCommand) Run(_ []string) int
  • func (c *VersionCommand) Synopsis() string

Types

type AgentCommand

type AgentCommand struct {
	Ctx context.Context
	// contains filtered or unexported fields
}

func (*AgentCommand) Help

func (c *AgentCommand) Help() string

Help should return long-form help text that includes the command-line usage, a brief few sentences explaining the function of the command, and the complete list of flags the command accepts.

func (*AgentCommand) Run

func (c *AgentCommand) Run(args []string) int

Run should run the actual command with the given CLI instance and command-line arguments. It should return the exit status when it is finished.

There are a handful of special exit codes this can return documented above that change behavior.

func (*AgentCommand) Synopsis

func (c *AgentCommand) Synopsis() string

Synopsis should return a one-line, short synopsis of the command. This should be less than 50 characters ideally.

type VersionCommand

type VersionCommand struct {
	Version string
}

func (*VersionCommand) Help

func (c *VersionCommand) Help() string

func (*VersionCommand) Run

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

func (*VersionCommand) Synopsis

func (c *VersionCommand) Synopsis() string