cmd

Documentation

Index

• func Execute()
• type AgentContext
• type Command
• type Flag
• type FlagGroups
• type Positional
• type Result

Functions

func Execute

func Execute()

Types

type AgentContext

type AgentContext struct {
	Name        string    `json:"name"`
	Version     string    `json:"version"`
	Commit      string    `json:"commit"`
	Short       string    `json:"short"`
	Long        string    `json:"long"`
	GlobalFlags []Flag    `json:"globalFlags"`
	Commands    []Command `json:"commands"`
}

type Command

type Command struct {
	Name       string       `json:"name"`
	Path       []string     `json:"path"`
	Use        string       `json:"use"`
	Short      string       `json:"short"`
	Long       string       `json:"long"`
	Hidden     bool         `json:"hidden"`
	Runnable   bool         `json:"runnable"`
	Args       []Positional `json:"args"`
	Flags      []Flag       `json:"flags"`
	FlagGroups FlagGroups   `json:"flagGroups"`
	Commands   []Command    `json:"commands"`
}

type Flag

type Flag struct {
	Name        string `json:"name"`
	Shorthand   string `json:"shorthand"`
	Type        string `json:"type"`
	Default     string `json:"default"`
	Description string `json:"description"`
	Required    bool   `json:"required"`
	Persistent  bool   `json:"persistent"`
}

type FlagGroups

type FlagGroups struct {
	OneRequired       [][]string `json:"oneRequired"`
	MutuallyExclusive [][]string `json:"mutuallyExclusive"`
	RequiredTogether  [][]string `json:"requiredTogether"`
}

type Positional

type Positional struct {
	Name     string `json:"name"`
	Required bool   `json:"required"`
}

type Result

type Result struct {
	Success bool   `json:"success"`
	Message string `json:"message,omitempty"`
}