Edge Xpert CLI Command List

The commands used by the edgexpert CLI tool are described below. For information on the available <services> arguments, see Edge Xpert Services.

Parameter	Arguments	Description
`--help` or `-h`		Displays help on the `edgexpert` command
`--version` or `-v`		Displays the version, the repository and the Git SHA of the installed Edge Xpert
`--env-file`		Specify an alternate environment file
`pull`	`[<options>]` `[<services>]`	Downloads the latest Edge Xpert images. Specifying no options pulls the core service images only. Specifying the `--all` option pulls updates for all images Specifying one or more services pulls updates for the specified services only
`up`	`[<options>]` `[<services>]`	Creates and starts the Edge Xpert services. Starts core services by default Specifying the `--no-core` option runs the up command without starting the core Specifying the `--no-core-data` option runs the up command without starting Core Data Specifying the `--no-core-keeper` option runs the up command without starting Core Keeper Specifying `--api-gateway` is dependent on the services started by the `--secret` option and additionally starts the nginx and proxy-auth services to set up the API gateway
`start`	`[<services>]`	Starts the specified Edge Xpert services If no services are specified, restarts all running services
`run`	`[<services>]` `[<args>]`	Creates and runs a one-off service with custom arguments
`clean`	`--force` or `-f`	Stops and deletes the running Edge Xpert services and removes all Edge Xpert volumes except the license volume
`stop`	`[<services>]`	Stops the Edge Xpert services If no services are specified, stops all running services
`rm` (alias: `down`)	`[<services>]`	Stops and deletes the running Edge Xpert containers If no services are specified, stops and deletes all created services
`status`		Displays the current status of the created and/or running Edge Xpert services
`ip`		Displays the internet protocol (IP) addresses of the running Edge Xpert services
`logs`	`[<services>] -o` <output_directory>	Exports the logs from created and/or running Edge Xpert services to the specified directory If no services are specified, outputs all logs to the specified directory
`config`	[<options>]	Specifying the `validate` option validates the current docker-compose configuration Specifying the `view`option displays the current docker-compose configuration Specifying the `gen`option with required services to generate the corresponding docker-compose configuration
`license`	[<options>]	Specifying the `install` option installs the specified licenses to the license volume Specifying the `uninstall` option uninstalls the specified license Specifying the `view` option lists all currently installed licenses Specifying the `check` option validates all installed licenses Specifying the `clean` option deletes the license volume; the volume must not be mounted - for further information, refer to Installation and Licensing
`image`	[<options>]	Displays the versions or Git SHA from which each service was built Specifying the `version` option displays the version information for each service Specifying the `sha` option displays the SHA information for each service