# Functions
No description provided by the author
AddAlias - Add an aliased command to the library.
AddCommand -- Add a command to registry Cmd structures should avoid pointers to data structures so cmd structures can be duplicated into separate instances without data collision.
AddCommonCmdOptions -- Add the given command options to the options supported by the current executing command.
AddHistoryOptions -- Add options for history payload types.
ClearCmdOptions -- Clear common command options by setting a new configuration.
CmdParse -- implements the parse/getopt function by hiding an Option type not to be exported in the interface.
No description provided by the author
No description provided by the author
CommandProcessor -- Start the command interpretter using the given reader and options and return the number of commands executed and whether it completed successfully.
Output that is intended only for the console; typically help information and general shell/command processor debug.
No description provided by the author
ConvertNodeValueTostring -- convert a node result to a string value.
Delay - Non-abortable delay function.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
General output that goes to the console stderr and a log file.
EscapeStringValue -- Quote a string handling '\"' as well.
ExpandAlias - Expand alias in input string.
No description provided by the author
FormBodyValidate - Validate form data is ok; only display a warning if not.
GetAlias - get the alias command from the library.
GetAllAliasKeys -- gets a list of keys from the library.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetDefaultStartupOptions return an interface to the options for the shell startup.
No description provided by the author
No description provided by the author
GetFileContentsOfType -- read the file contents using a default extension if one was not provided.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetJobOptionsFromParams -- initializes options from common command line options.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Validate a file exists in full format or with expected extension added.
GetValueAsDate -- given a scaler value in an interface convert it to a date if it is can be converted.
GetX509Pool - Get the X509 pool to use; the system is used by default and a cert.pem file is appended if it can be found in the init directory, or the exe directory.
InitializeCommonCmdOptions initialize common command options.
Only set the global if not initialized already.
InitializeShell -- Initialize common parameters needed by the shell.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IsFlowControl - Determines if the error as the given action associated.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IsVariableSubstitutionComplete -- Validate that variable substitution was complete (no variable syntax found).
No description provided by the author
JsonBodyValidate - Validate form data is ok; only display a warning if not.
JsonCompletionHandler -- Helper function to push json result data and perform output processing.
LineParse -- Parse a command line into tokens handling escape sequences and double quotes.
MakeJobCompletionForExpectedStatus -- Create a completion handler to accept a different status than StatusOK.
MessageCompletionHandler -- Helper function to push plain text result and perform output processing.
No description provided by the author
No description provided by the author
NewCmdSet -- Create a command set for handling options.
NewCommandLine -- parse command line into a Line.
NewFlowError - Return a FlowError which provides actions to cmd processor.
NewJsonHistoryMap -- Create a HistoryMap from json string content.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewSiegemark -- Create siege benchmarking job monitor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OpenFileForOutput -- open a file.
No description provided by the author
General output that can go to the console stdout or to a log File Generally this is data, verbose output, and debug related to a function.
ParseDuration -- parses a duration value from text that may include time sufix [ms(default), S, see time.ParseDuration].
PeekResult - Get a history result using an index.
PerformHealthCheck - Valiate a default /health endpoint TODO: Evaluate moving this to specialized commands; it is not generic enough to be here.
PerformVariableSubstitution -- perform substitution on a string.
ProcessJob -- Run the jobs based on provided options.
PushError - push a result that is a single string with the error message.
PushResponse -- Push a RestResponse into the history buffer.
PushResult -- push a Result structure into the history buffer.
PushResponse -- Push a RestResponse into the history buffer.
ReadLine -- reads a line from standard in if it is a terminal.
RegisterSubstitutionHandler -- Register a substitution function.
RemoveAlias - remove an alias from the library.
No description provided by the author
No description provided by the author
RestCompletionHandler -- Helper function to push rest result and perform output processing.
RunShell -- process command line and init scripts and run command processor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SortedMapKeys -- Sort a list of keys for a map.
SortedStringSlice -- sort a slice of strings.
SortedSubstitutionFunctionList -- return the substitution functions in sorted order.
SubstitutionFunctionNames -- return the list of substitute functions by name in sorted order.
No description provided by the author
ValidateScriptExists -- Validate the script exists by either basename or basename plus suffix return the file name modified with extension if necesssary.
XmlBodyValidate - Validate form data is ok; only display a warning if not.
# Constants
DisplayOption values.
Path options scenarios for different use cases.
All paths but default as default is assumed.
Path options scenarios for different use cases.
DisplayOption values.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Encapsulated in CmdRestclient.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Encapsulated in CmdRestclient.
Options to include with a command.
Options to include with a command.
Options to include with a command.
Path options scenarios for different use cases.
DisplayOption values.
Path options scenarios for different use cases.
DisplayOption values.
Default values for options.
Default values for options.
Default values for options.
Default values for options.
Default values for options.
Default values for options.
Default values for options.
In milliseconds.
Default values for options.
DisplayOption values.
Path options scenarios for different use cases.
DisplayOption values.
DisplayOption values.
# Variables
No description provided by the author
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Variables for supported categorizations of commands.
Default settings for startup.
Default settings for startup.
No description provided by the author
Default settings for startup.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
Error variables.
No description provided by the author
FlowAbort - Terminate the current script with error (typically Ctrl-C during command).
FlowGo - Continue and exit single step mode.
FlowQuit - Terminate the current script without an error but do not clear LastError.
No description provided by the author
No description provided by the author
Default settings for startup.
Default settings for startup.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
Benchmark -- Structure implementing JobMontor.
BenchmarkIteration -- Iteration structure implementing JobContext.
No description provided by the author
No description provided by the author
HistoryOptions -- Common options for history results.
JobOptions -- options available to the job processing engine.
JsonMap -- contains a deserialized json.
No description provided by the author
Line -- a structure for a parsed line.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RestClient -- An object that makes REST calls.
RestResponse -- The response structure returned by a REST interface.
Result -- a result that can be placed in the history buffer and used by assertion handlers.
RunCommand - The run command structure Note: Run is a command that recurses, so values here can be changed by nested RUNs.
SiegeBucket -- structure for histogram of siege benchmark.
Siegemark -- JobMonitor for siege benchmarking.
SiegemarkIteration -- track a single rest call.
Structure for all common option values.
StartupOptions -- configuration available to the shell.
No description provided by the author
SubstitutionFunction -- a registration function for a handler and its help.
SubstitutionItemHelp -- Help strucsture for a format.
# Interfaces
Abortable - interface for commands that support abort.
No description provided by the author
CmdSet -- Interface exposing the supported interfaces to commands for setting options.
Command - interface for basic command.
CommandWithSubcommands - interface for commands that have sub-commands.
FlowControl - Special Command interfaces to control execution within the command processor.
No description provided by the author
JobContext is returned by the start of an iteration to collect iteration information for the completed iteration.
JobMonitor -- interface to support benchmark capabilities.
LineProcessor - interface for commands that execute whole line.
SubTopicInterface -- Some about topics may have sub topics.
TopicInterface -- THe minumum supported interface for about topics.
Trackable - interface that overrides tracking mechanisms.
# Type aliases
DisplayOption.
FlowErrorCmd -- rename FlowAction - Special values affecting command processor.
JobCompletion -- Function prototype for a function that can parse the response.
JobFunction -- Function prototype for a function that will perform an instance of the job.
JobMaker -- Function prototype for a function that can create an instance of the job function.
ResultContentType -- types of result data.
No description provided by the author
ShortDisplayFunc -- A function can be used to pretty format the output or condense it.
SubstitutionHandler -- A handler returns a value for substitution given a function name.