commands

Documentation

Overview

Package commands exposes a run method for main() to call

Index

• func Commands() map[string]CommandProvider
• func Register(name string, provider CommandProvider)
• func Run(argv []string) (exitCode int)
• type CommandProvider

Functions

func Commands

func Commands() map[string]CommandProvider

Commands returns a map from name to registered CommandProvider.

func Register

func Register(name string, provider CommandProvider)

Register will register a CommandProvider, this is intended to be used during sstatic initializtion and will panic if name is already in use.

func Run

func Run(argv []string) (exitCode int)

Run will parse command line arguments and run available commands.

Types

type CommandProvider

type CommandProvider interface {
	// Summary returns a one-line description of what this command is for.
	Summary() string
	// Usage returns the docopt usage string, used to parse arguments.
	Usage() string
	// Execute is called with parsed docopt result, return true/false if the
	// utility should exit zero or non-zero.
	Execute(args map[string]interface{}) bool
}

CommandProvider is implemented by anyone who wishes to provide a command line command that the worker should support.