Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Siggi Skulason <siggi.skulason@canonical.com>
  • Loading branch information
Siggi Skulason committed Dec 6, 2021
1 parent 88933ee commit 876bf37
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

## Introduction

EdgeX-CLI is a command line interface tool meant for developers to interact with EdgeX microservices. It replaces the need to manually construct complex cURL commands and/or maintain developer scripts.
EdgeX-CLI is a command line interface tool for developers, used for interacting with the EdgeX microservices.

See the [CLI Getting started documentation](https://docs.edgexfoundry.org/2.2/getting-started/tools/Ch-CommandLineInterface/) and the [EdgeX-CLI V2 Design ADR](https://github.com/edgexfoundry/edgex-docs/blob/main/docs_src/design/adr/core/0019-EdgeX-CLI-V2.md) for more information about the client.

See the [CLI Getting started documentation](https://docs.edgexfoundry.org/2.2/getting-started/tools/Ch-CommandLineInterface/) for more information about the client.

## Installing EdgeX-CLI

Expand All @@ -24,6 +25,11 @@ make build
./bin/edgex-cli
```

## Limitations
- The client requires all services to run on the local host. It does not support a distributed configuration or using the API gateway ([#427](https://github.com/edgexfoundry/edgex-cli/issues/427))
- The `db` command from the v1 client is not supported ([#383](https://github.com/edgexfoundry/edgex-cli/issues/383))
- See this list of [all current enhancement issues](https://github.com/edgexfoundry/edgex-cli/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)

## Community
- [EdgeXFoundry Slack](https://slack.edgexfoundry.org/)
- [Mailing lists](https://lists.edgexfoundry.org/g/main)
Expand Down

0 comments on commit 876bf37

Please sign in to comment.