utils

Documentation

Overview

Package utils contains all the utility functions.

Package utils contains all the utility functions.

Index

• Constants
• Variables
• func DisplayCommandUsage(out io.Writer)
• func DisplayHelp(out io.Writer)
• func DisplaySupportedCommands(out io.Writer)
• func FormatFlag(flagName string) string
• func GetFlag(val string) string
• func IsFlag(val string) bool
• func IsHelp(subcommand string, parameters map[string][]string) bool
• func Register(command SsmCliCommand)
• type SsmCliCommand

Constants

const (
	HelpFlag   = "help"
	SsmCliName = "ssmcli"
	FlagPrefix = "--"
)

Variables

var SsmCliCommands map[string]SsmCliCommand

CliCommands is the set of support commands

Functions

func DisplayCommandUsage

func DisplayCommandUsage(out io.Writer)

DisplayCommandUsage prints cli usage info to console

func DisplayHelp

func DisplayHelp(out io.Writer)

DisplayHelp shows help for the ssmcli

func DisplaySupportedCommands

func DisplaySupportedCommands(out io.Writer)

DisplaySupportedCommands prints a list of supported cli commands to the console

func FormatFlag

func FormatFlag(flagName string) string

FormatFlag returns a parameter name formatted as a command line flag

func GetFlag

func GetFlag(val string) string

GetFlag returns the flag name if val is a flag, or empty if it is not

func IsFlag

func IsFlag(val string) bool

IsFlag returns true if val is a flag

func IsHelp

func IsHelp(subcommand string, parameters map[string][]string) bool

IsHelp determines if a subcommand or flag is a request for help

func Register

func Register(command SsmCliCommand)

Register

Types

type SsmCliCommand

type SsmCliCommand interface {
	Execute(parameters map[string][]string) (error, string)
	Help() string
	Name() string
}

CliCommand defines the interface for all commands the cli can execute