constants

Documentation

Index

• Constants
• func IsProgrammaticOutputFormat(outputFormat string) bool

Constants

const (
	FlagHelp               = "help"
	FlagSpace              = "space"
	FlagOutputFormat       = "output-format"
	FlagOutputFormatLegacy = "outputFormat"
	FlagNoPrompt           = "no-prompt"
)

flags for command line switches

const (
	ContextKeyTimeNow = "time.now" // func() time.Time
	ContextKeyOsOpen  = "os.open"  // func(string) (io.ReadCloser, error)
)

flags for storing things in the go context

const (
	OutputFormatJson  = "json"
	OutputFormatBasic = "basic"
	OutputFormatTable = "table" // TODO I'd like to rename this to just "standard" or "default"; discuss with team
)

values for output formats

const (
	ConfigHost     = "Host"
	ConfigApiKey   = "ApiKey"
	ConfigSpace    = "Space"
	ConfigNoPrompt = "NoPrompt"
	// ConfigProxyUrl     = "ProxyUrl"
	ConfigEditor = "Editor"
	// ConfigShowOctopus  = "ShowOctopus"
	ConfigOutputFormat = "OutputFormat"
)

keys for key/value store config file

const (
	EnvOctopusHost   = "OCTOPUS_HOST"
	EnvOctopusApiKey = "OCTOPUS_API_KEY"
	EnvOctopusSpace  = "OCTOPUS_SPACE"
	EnvEditor        = "EDITOR"
	EnvVisual        = "VISUAL"
	EnvCI            = "CI"
)

const (
	ExecutableName = "octopus"
)

Functions

func IsProgrammaticOutputFormat

func IsProgrammaticOutputFormat(outputFormat string) bool

IsProgrammaticOutputFormat tells you if it is acceptable for your command to print miscellaneous output to stdout, such as progress messages. If your command is capable of printing such things, you should check the output format first, lest you print a progress message into the middle of a JSON document by accident.