Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseAndRun ¶
func ParseAndRun(routines automation.Routines) int
ParseAndRun parses command-line arguments and runs content from routines. On completion, the function return an exit status that should be passed on to os.Exit.
Types ¶
type Config ¶
type Config struct {
// AppName holds the app-name to use in automation. The default is set to
// match the Go main module import path.
AppName string
// CredentialsFile describes the path to a valid Clarify integration JSON
// credentials file. This property is required if Username is set.
CredentialsFile string
// Username can be set to use Basic Authentication ot authorize against
// Clarify. The user-name is the same as the integration ID. When set,
// the content of the CredentialsFile config is ignored.
Username string
// Password can be set to use Basic Authentication to authorize against
// Clarify. This property is required if Username is set.
Password Password
// Available routines for patterns to match.
Routines automation.Routines
// Patterns describes which sub-routines to run. If empty, all sub-routines
// are run.
Patterns []string
// Verbose, if set, turns on DEBUG logging. The default log level is INFO.
Verbose bool
// Use a JSON log format.
JSON bool
// DryRun, if set, signals routines and actions to not persist changes.
DryRun bool
// EarlyOut, if set, signals the program to abort at the first routine
// error. The default is to continue to the next routine.
EarlyOut bool
}
Config describe a set of command-line options.
func ParseArguments ¶
func ParseArguments(routines automation.Routines, arguments []string) (*Config, error)
ParseArguments parses command-line arguments into a Config structure using the provided or prints usage information to os.Stderr. When using this method, the Patterns property is set from the remaining command-line arguments after all flags (options) have been parsed.
This function can be used by users who need to customize the configuration before it's run, but do not need to customize command-line flags.
func (*Config) FlagSet ¶
FlagSet returns a named flag-set for parsing command line configuration flags where fallback values are fetched from environment variables. Note that there is no flag for the AppName and Patterns property.
This method can be used by users who need to customize the which command-line flags are available in their application.
type Password ¶
type Password struct {
// contains filtered or unexported fields
}
Password helps prevent a string value from being exposed in logs or marshalled as text or JSON.
Source Files