cmdtree

Documentation

Index

• Variables
• type CmdTree
  • func New(prime *primer.Values, args ...string) *CmdTree
  • func (ct *CmdTree) Command() *captain.Command
  • func (ct *CmdTree) Execute(args []string) error
  • func (ct *CmdTree) OnExecStart(handler captain.ExecEventHandler)
  • func (ct *CmdTree) OnExecStop(handler captain.ExecEventHandler)

Variables

var (
	EnvironmentSetupGroup = captain.NewCommandGroup(locale.Tl("group_environment_setup", "Environment Setup"), 10)
	EnvironmentUsageGroup = captain.NewCommandGroup(locale.Tl("group_environment_usage", "Environment Usage"), 9)
	ProjectUsageGroup     = captain.NewCommandGroup(locale.Tl("group_project_usages", "Project Usage"), 8)
	PackagesGroup         = captain.NewCommandGroup(locale.Tl("group_packages", "Package Management"), 7)
	PlatformGroup         = captain.NewCommandGroup(locale.Tl("group_tools", "Platform"), 6)
	AuthorGroup           = captain.NewCommandGroup(locale.Tl("group_author", "Author"), 5)
	VCSGroup              = captain.NewCommandGroup(locale.Tl("group_vcs", "Version Control"), 4)
	AutomationGroup       = captain.NewCommandGroup(locale.Tl("group_automation", "Automation"), 3)
	UtilsGroup            = captain.NewCommandGroup(locale.Tl("group_utils", "Utilities"), 2)
)

Group instances are used to group command help output.

Types

type CmdTree

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

CmdTree manages a tree of captain.Command instances.

func New

func New(prime *primer.Values, args ...string) *CmdTree

New prepares a CmdTree.

func (*CmdTree) Command

func (ct *CmdTree) Command() *captain.Command

Command returns the root command of the CmdTree

func (*CmdTree) Execute

func (ct *CmdTree) Execute(args []string) error

Execute runs the CmdTree using the provided CLI arguments.

func (*CmdTree) OnExecStart

func (ct *CmdTree) OnExecStart(handler captain.ExecEventHandler)

func (*CmdTree) OnExecStop

func (ct *CmdTree) OnExecStop(handler captain.ExecEventHandler)