Command Line Options

This section describes the command line options that are common to all EdgeX services. Some services have addition command line options which are documented in the specific sections for those services.

ConfDir

-cd/--configDir

Specify local configuration directory. Default is ./res

Can be overridden with EDGEX_CONFIG_DIR environment variable.

File

-cf/--configFile <name>

Indicates the name of the local configuration file. Default is configuration.yaml

Can be overridden with EDGEX_CONFIG_FILE environment variable.

Config Provider

-cp/ --configProvider

Indicates to use Configuration Provider service at specified URL. URL Format: {type}.{protocol}://{host}:{port}. Default is consul.http://localhost:8500

Can be overridden with EDGEX_CONFIG_PROVIDER environment variable.

Common Config

-cc/ --commonConfig

Takes the location where the common configuration is loaded from when not using the Configuration Provider. Default is blank.

Can be overridden with EDGEX_COMMON_CONFIG environment variable.

Profile

-p/--profile <name>

Indicates configuration profile other than default. Default is no profile name resulting in using ./res/configuration.yaml if -f and -c are not used.

Can be overridden with EDGEX_PROFILE environment variable.

Registry

-r/ --registry

Indicates service should use the Registry. Connection information is pulled from the [Registry] configuration section.

Can be overridden with EDGEX_USE_REGISTRY environment variable.

Overwrite

-o/--overwrite

Overwrite configuration in provider with local configuration.

This will clobber existing settings in provider, problematic if those settings were edited by hand intentionally. Typically only used during development.

Developer Mode

-d/--dev

Indicates service should run in developer mode. The allows the service running from command-line to properly communicate with other EdgeX services running in Docker (aka hybrid mode). This flag cause all Host configuration values pulled from common configuration via the Configuration Provider to be overridden with the value "localhost".

Help

-h/--help

Show the help message