cli

Documentation

Overview

Package cli is a library to help creating command line tools.

Index

• type Command
• type Module
  • func NewCLI() *Module
  • func (m *Module) AddCommand(name string, command Command)
  • func (m *Module) AddSubCommand(name string) *Module
  • func (m *Module) Definition() string
  • func (m *Module) Exec(args []string) error
  • func (m *Module) Run()

Types

type Command

type Command interface {
	Definition() string // usually it's the output for --help
	Exec(args []string) error
}

To add a module, implement this interface. Definition is the command definition. Exec is the behaviour that you want to implement as a command

type Module

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

Module is the shared structure of commands and sub-commands.

func NewCLI

func NewCLI() *Module

NewCLI returns a root Module that you can add commands and another modules (sub-commands).

func (*Module) AddCommand

func (m *Module) AddCommand(name string, command Command)

AddCommand adds a new command this module.

func (*Module) AddSubCommand

func (m *Module) AddSubCommand(name string) *Module

AddSubCommand adds a new sub-command this module.

func (*Module) Definition

func (m *Module) Definition() string

func (*Module) Exec

func (m *Module) Exec(args []string) error

func (*Module) Run

func (m *Module) Run()

Run is the function that is intended to be run from main().