edgex-cli

Introduction

A command line interface to interact with EdgeX microservices. You can use this CLI tool instead of complicated CURL command or developer scripts.

Installation

In order to run this tool, you will need a running EdgeX instance and Go 1.11 or higher installed on your machine.

• Clone the git repo in your go path:

$ cd ~/go/src/github.com/edgexfoundry/
$ git clone https://github.com/edgexfoundry-holding/edgex-cli

A bug described in issue #26 is solved through the use of the replace directive. This fix, however, can be erased when using go tidy and some other go commands. make install and make build work.

• Install the CLI:

$ make install

You can now use the CLI by entering edgex anywhere on your machine. BUG: make install currently installs the binary as edgex-cli globally, because of the directory structure.

Available Commands

Readings

All readings:

$ edgex reading list

All readings for device, default limit is 50:

$ edgex reading list <device>

All readings for device with limit:

$ edgex reading list <device> -l <limit>

Notifications

Add notifications from toml file:

$ edgex notification add </path/to/file.toml>

Remove a notification by slug:

$ edgex notification rm <slug>

Remove a notification by age (timestamp):

$ edgex notification rm --age 1561939200

Subscriptions

Add subscriptions from toml file:

$ edgex subscription add </path/to/file.toml>

Remove a subscription by slug:

$ edgex subscription rm A

Remove a subscription by id:

$ edgex subscription add /path/to/file.toml // Add subscriptions from toml file.
$ edgex subscription rm A // Remove a subscription by slug.
$ edgex subscription rm --id SOMEID // Remove a subscription by id.

Intervals

$ edgex interval list // Lists all intervals provided their numbers is within the configured limit.
$ edgex interval list A // List interval with name A.
$ edgex interval list --id SOMEID // List interval with id SOMEID.
$ edgex interval add /path/to/file.toml // Add intervals from toml file.
$ edgex interval update /path/to/file.toml // Update intervals from toml file.
$ edgex interval rm A // Remove a interval by id or name A.

Developers

To test your changes, you can either build the binary or calling go run.

• Build and run:

$ make build
$ ./edgex

• Use go run:

$ go run main.go [COMMAND]