sensecli

Overview ¶

Package sensecli just contains some helpers used to set up binaries that need Sense credentials.

It permits users to configure the Sense client using flags (--sense-email), environment variables (SENSE_EMAIL), or a YAML configuration file.

The easiest thing to do is:

func main() {
	configFile, flagCreds := sensecli.SetupStandardFlags()
	flag.Parse()
	clients, err := sensecli.CreateClients(context.Background(), configFile, flagCreds)
	...
}

By default, the --sense-config flag and SENSE_CONFIG environment variable overrides everything else by specifying the name of a YAML configuration file that contains the following format:

accounts:
- credentials:
    email:          # specify the e-mail address directly
    email-from:		# read the e-mail address from a file
    password:		# specify the password directly
    password-from:	# read the password from a file
    mfa-from:		# read the MFA code from a file
    mfa-command:	# read the MFA code from a command

Multiple accounts can be configured in the same file. If you specify a configuration file, flags and environment variables will be ignored.

If no configuration file is specified, the following flags will be used first to configure a single Sense client:

--sense-email
--sense-email-from
--sense-password
--sense-password-from
--sense-mfa-from
--sense-mfa-command

These environment variables will be used for any flag that is not set:

SENSE_EMAIL
SENSE_EMAIL_FROM
SENSE_PASSWORD
SENSE_PASSWORD_FROM
SENSE_MFA_FROM
SENSE_MFA_COMMAND

These will be blended into one set of credentials that will be used to authenticate the client.

If no flags or environment variables are set, a single unauthenticated Sense client will be created.