Giter Club home page Giter Club logo

edgex-cli's Introduction

Go Report Card

edgex-cli

Introduction

A command line interface to interact with EdgeX microservices. Replaces the need to manually construct complex CURL commands and/or maintain developer scripts.

 _____    _           __  __  _____                     _            
| ____|__| | __ _  ___\ \/ / |  ___|__  _   _ _ __   __| |_ __ _   _ 
|  _| / _` |/ _` |/ _ \\  /  | |_ / _ \| | | | '_ \ / _` | '__| | | |
| |__| (_| | (_| |  __//  \  |  _| (_) | |_| | | | | (_| | |  | |_| |
|_____\__,_|\__, |\___/_/\_\ |_|  \___/ \__,_|_| |_|\__,_|_|   \__, |
            |___/                                              |___/ 


https://www.edgexfoundry.org/

Usage:
  edgex [command]

Available Commands:
  addressable   Addressable command command
  db            Purges entire EdgeX Database. [USE WITH CAUTION]
  device        Device command
  deviceservice Device service command
  event         Event command
  help          Help about any command
  interval      Interval command
  notification  Notification command
  profile       Device profile command.
  reading       Reading command
  status        Checks the current status of each microservice.
  subscription  Subscription command
  version       Version command

Flags:
  -h, --help       help for edgex
      --no-pager   Do not pipe output into a pager.
  -u, --url        Print URL(s) used by the entered command.
  -v, --verbose    Print entire HTTP response.

Use "edgex [command] --help" for more information about a command.

Installation

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

  • Clone the git repo:
$ git clone https://github.com/edgexfoundry-holding/edgex-cli
  • Change directory:
$ cd edgex-cli
  • Install the CLI:
$ make install

You can now use the CLI by entering edgex-cli anywhere on your machine.

Developers

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

  • Build and run:
$ make build
$ ./edgex-cli
  • Use go run:
$ go run main.go [COMMAND]
  • Running tests:
$ make test

This will generate a coverage.out file in the root directory of the repo which you can use to see test coverage of code by running

$ go tool cover -html=coverage.out

edgex-cli's People

Contributors

couralex6 avatar iain-anderson avatar jdharms avatar kurokobo avatar milj19lf avatar mkbhanda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.