This repository has been archived by the owner on May 26, 2023. It is now read-only.
docs: update README.md #426
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,30 @@ | |
|
|
||
| ## 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. | ||
|
|
||
| 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 | ||
|
|
||
| The client can be installed using a [snap](https://github.com/edgexfoundry/edgex-cli/tree/main/snap): | ||
|
|
||
| ``` | ||
| sudo snap install edgex-cli | ||
| ``` | ||
|
|
||
| To build, install and run `edgex-cli` natively, do the following: | ||
| ``` | ||
| git clone http://github.com/edgexfoundry/edgex-cli.git | ||
| cd edgex-cli | ||
| make tidy | ||
| make build | ||
| ./bin/edgex-cli | ||
| ``` | ||
|
There was a problem hiding this comment. Could we also add a section here? This is based on this ADR. Supported commands and sub-commandsCore Command
Core Data
Metadata
Support Notifications
Support Scheduler
Common endpoints in all services
There was a problem hiding this comment. I would rather keep this read me short and put this in the getting started documentation, which I'm working on. Otherwise we end up with documentation in two places and have to keep both up to date. Does that sound ok? There was a problem hiding this comment. Sounds great! Thank you. |
||
|
|
||
| ## Community | ||
| - [EdgeXFoundry Slack](https://slack.edgexfoundry.org/) | ||
| - [Mailing lists](https://lists.edgexfoundry.org/g/main) | ||
|
|
||
| ## License | ||
| [Apache-2.0](LICENSE) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest completely removing the second sentence or changing it to only say that the CLI acts as a wrapper for the REST APIs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed - and updated