cli_utils

README

cli-utils

cli-utils is a simple Go package to create command line interfaces.

Installation

To install the package, use the following command:

go get github.com/lazarcloud/cli-utils

Documentation

Index

• Variables
• func ReadInput() (string, error)
• func RunHelp(args RuntimeArgs, c *CLI) error
• type Arg
• type Args
• type CLI
  • func NewCLI(name string, commands Commands, defaultCommand *Command) *CLI
  • func (c *CLI) GetCommand(name string) *Command
  • func (c *CLI) HasCommand(name string) bool
  • func (c *CLI) Run() error
• type Command
• type Commands
• type RuntimeArgs
  • func (r RuntimeArgs) Get(name string) string

Variables

var HelpCommand = Command{
	Name:        "help",
	Description: "Helps you with a command",
	Run:         RunHelp,
	Args: []Arg{
		{
			Name:        "command",
			Description: "Command to get help for",
			Required:    false,
			Default:     nil,
		},
	},
}

Functions

func ReadInput

func ReadInput() (string, error)

func RunHelp

func RunHelp(args RuntimeArgs, c *CLI) error

Types

type Arg

type Arg struct {
	Name        string
	Description string
	Required    bool
	Default     interface{}
	Check       func(arg *Arg, value string) error
}

type Args

type Args []Arg

type CLI

type CLI struct {
	Name           string
	DefaultCommand *Command
	Commands       []Command
}

func NewCLI

func NewCLI(name string, commands Commands, defaultCommand *Command) *CLI

func (*CLI) GetCommand

func (c *CLI) GetCommand(name string) *Command

func (*CLI) HasCommand

func (c *CLI) HasCommand(name string) bool

func (*CLI) Run

func (c *CLI) Run() error

type Command

type Command struct {
	Name        string
	Description string
	Run         func(args RuntimeArgs, c *CLI) error
	CleanUp     func(args RuntimeArgs, c *CLI) error
	Args        Args
}

type Commands

type Commands []Command

type RuntimeArgs

type RuntimeArgs map[string]interface{}

func (RuntimeArgs) Get

func (r RuntimeArgs) Get(name string) string