commands

Documentation

Overview

Package commands is the base of all commands. All commands should be in a sub package, implement the Command interface, and register itself through the init function using the Register function

Index

• Variables
• func AddCommand(a, b, c string, cmd Command)
• func AddIfNotEmpty(args map[string]string, key, value string)
• func GetDefaultDescriptionAnnotation() string
• func ReadTokens()
• func RequiresAnnotation() error
• func WriteTokensFile()
• type Command
• type DefaultOpts

Variables

var Parser = flags.NewParser(&Opts, flags.Default)

Parser defines all the commands

var (
	// Tokens to use to connect to the endpoint
	Tokens types.TokenFile = types.TokenFile{Endpoint: map[string]types.TokenFileToken{}}
)

Functions

func AddCommand

func AddCommand(a, b, c string, cmd Command)

AddCommand register a new command to be parsed

func AddIfNotEmpty

func AddIfNotEmpty(args map[string]string, key, value string)

AddIfNotEmpty is a convenient method to add in a map if value is not empty

func GetDefaultDescriptionAnnotation

func GetDefaultDescriptionAnnotation() string

GetDefaultDescriptionAnnotation returns the default description annotation sent

func ReadTokens

func ReadTokens()

ReadTokens sets tokens from tokenfile

func RequiresAnnotation

func RequiresAnnotation() error

RequiresAnnotation mandates the annotation for that command

func WriteTokensFile

func WriteTokensFile()

WriteTokensFile writes a file containing tokens

Types

type Command

type Command interface {
	flags.Commander
	Data() interface{}  // Return the data after the command ran successfully
	PrettyPrint() error // Pretty print the output of the command. It is given the data as returned by the Run method
}

Command is implemented by all our commands

type DefaultOpts

type DefaultOpts struct {
	Dump        bool   `long:"dump" description:"outputs as go structure"`
	JSONNeeded  bool   `long:"json" description:"outputs as json"`
	Capath      string `long:"capath" description:"SSL_CERT_DIR for GOMEME"  env:"GOMEME_CERT_DIR"`
	Endpoint    string `long:"endpoint" description:"endpoint" env:"GOMEME_ENDPOINT" required:"true"`
	Debug       bool   `long:"debug"`
	Subject     string `long:"subject" description:"annotation subject"`
	Description string `long:"description" description:"annotation description"`
}

DefaultOpts are the common options for every command

var Opts DefaultOpts

Opts is the list of default opts