cli

Documentation

Index

• Variables
• func Banner()
• func Dispatch() error
• func Execute(name string) error
• func Help(name string) error
• func Register(name string, entry Entry)
• func Usage(name string) error
• type Command
• type Entry

Variables

var Author string

Author's name

var AuthorEmail string

Author's e-mail

var Copyright string

Copyright statement.

var Homepage string

Project's URL.

var License string

License notice.

var Name string

Project name.

var Version string

Version string.

Functions

func Banner

func Banner()

Displays a banner with available information (if any).

func Dispatch

func Dispatch() error

Dispatches the subcommand.

func Execute

func Execute(name string) error

Executes a subcommand.

func Help

func Help(name string) error

Shows help for a subcommand.

func Register

func Register(name string, entry Entry)

Registers a subcommand.

func Usage

func Usage(name string) error

Shows usage for a subcommand.

Types

type Command

type Command interface {
	Execute() error
}

Subcommand.

type Entry

type Entry struct {
	Name        string
	Usage       string
	Description string
	Arguments   []string
	Command     Command
}

Command entry.