From 4f01c0aa7a35b1b5de6a6436e229341d187e792b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20Milo=C5=A1evi=C4=87?= Date: Tue, 27 Nov 2018 08:40:56 +0100 Subject: [PATCH] NOISSUE - Move CLI documentation from getting started guide to separate page (#470) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Move CLI documentation from getting started guide to seperate page Signed-off-by: Ivan Milošević * Fix cli usage examples in readme and docs Signed-off-by: Ivan Milošević --- cli/README.md | 4 +- docs/cli.md | 159 +++++++++++++++++++++++++++++++++++++++ docs/getting-started.md | 162 ---------------------------------------- mkdocs.yml | 3 +- 4 files changed, 163 insertions(+), 165 deletions(-) create mode 100644 docs/cli.md diff --git a/cli/README.md b/cli/README.md index 122cd284..46c543b3 100644 --- a/cli/README.md +++ b/cli/README.md @@ -41,7 +41,7 @@ mainflux-cli things get all --offset=1 --limit=5 #### Retrieve Thing By ID ``` -mainflux-cli things get --offset=1 --limit=5 +mainflux-cli things get ``` #### Remove Thing @@ -61,7 +61,7 @@ mainflux-cli channels get all --offset=1 --limit=5 #### Retrievie Channel By ID ``` -mainflux-cli channels get --offset=1 --limit=5 +mainflux-cli channels get ``` #### Remove Channel diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 00000000..f5ec5664 --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,159 @@ +## CLI + +Mainflux CLI makes it easy to manage users, things, channels and messages. + +CLI can be downloaded as separate asset from [project realeses](https://github.com/mainflux/mainflux/releases) or it can be built with `GNU Make` tool: + +``` +make cli +``` + +which will build `mainflux-cli` in `/build` folder. + +Executing `build/mainflux-cli` without any arguments will output help with all available commands and flags: + +``` +Usage: + mainflux-cli [command] + +Available Commands: + channels Manipulation with channels + help Help about any command + msg Send or retrieve messages + things things + users users create/token + version Get version of Mainflux Things Service + +Flags: + -c, --content-type string Mainflux message content type (default "application/senml+json") + -h, --help help for mainflux-cli + -a, --http-prefix string Mainflux http adapter prefix (default "http") + -i, --insecure Do not check for TLS cert + -l, --limit uint limit query parameter (default 100) + -m, --mainflux-url string Mainflux host URL (default "http://localhost") + -o, --offset uint offset query parameter + -t, --things-prefix string Mainflux things service prefix + -u, --users-prefix string Mainflux users service prefix + +Use "mainflux-cli [command] --help" for more information about a command. +``` + +You can execute each command with `-h` flag for more information about that command, e.g. + +``` +./mainflux-cli channels -h +``` + +will get you usage info: + +``` +Manipulation with channels: create, delete or update channels + +Usage: + mainflux-cli channels [flags] + mainflux-cli channels [command] + +Available Commands: + create create + delete delete + get get all/ + update update + +``` + +### Service +#### Get the service verison + +``` +./mainflux-cli version +``` + +### User management +#### Create User + +``` +./mainflux-cli users create john.doe@email.com password +``` + +#### Login User + +``` +./mainflux-cli users token john.doe@email.com password +``` + +### System Provisioning +#### Provision Device + +``` +./mainflux-cli things create '{"type":"device", "name":"nyDevice"}' +``` + +#### Provision Application + +``` +./mainflux-cli things create '{"type":"app", "name":"nyDevice"}' +``` + +#### Retrieve All Things + +``` +./mainflux-cli things get all --offset=1 --limit=5 +``` + +#### Retrieve Thing By ID + +``` +./mainflux-cli things get +``` + +#### Remove Thing + +``` +./mainflux-cli things delete +``` + +#### Provision Channel + +``` +./mainflux-cli channels create '{"name":"nyChannel"}' +``` + +#### Retrieve All Channels + +``` +./mainflux-cli channels get all --offset=1 --limit=5 +``` + +#### Retrievie Channel By ID + +``` +./mainflux-cli channels get +``` + +#### Remove Channel + +``` +./mainflux-cli channels delete +``` + +### Access control +#### Connect Thing to a Channel + +``` +./mainflux-cli things connect +``` + +#### Disconnect Things from a Channel + +``` +./mainflux-cli things disconnect +``` + +### Messaging +#### Send a message over HTTP + +``` +./mainflux-cli msg send '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]' +``` + + diff --git a/docs/getting-started.md b/docs/getting-started.md index 1c9b8723..e3f208c5 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -328,168 +328,6 @@ mosquitto_sub -u -P -t channels//messages -h If you are using TLS to secure MQTT connection, add `--cafile docker/ssl/certs/ca.crt` to every command. -## CLI - -Mainflux CLI is another way to manage users, things, channels and messages. - -CLI can be downloaded as separate asset from [project realeses](https://github.com/mainflux/mainflux/releases) or it can be built with: - -``` -make cli -``` - -which will build `mainflux-cli` in `/build` folder. - -Executing `build/mainflux-cli` without any arguments will output help with all available commands and flags: - -``` -Usage: - mainflux-cli [command] - -Available Commands: - channels Manipulation with channels - help Help about any command - msg Send or retrieve messages - things things - users users create/token - version Get version of Mainflux Things Service - -Flags: - -c, --content-type string Mainflux message content type (default "application/senml+json") - -h, --help help for mainflux-cli - -a, --http-prefix string Mainflux http adapter prefix (default "http") - -i, --insecure Do not check for TLS cert - -l, --limit uint limit query parameter (default 100) - -m, --mainflux-url string Mainflux host URL (default "http://localhost") - -o, --offset uint offset query parameter - -t, --things-prefix string Mainflux things service prefix - -u, --users-prefix string Mainflux users service prefix - -Use "mainflux-cli [command] --help" for more information about a command. -``` - -You can execute each command with `-h` flag for more information about that command, e.g. - -``` -./mainflux-cli channels -h -``` - -will get you usage info: - -``` -Manipulation with channels: create, delete or update channels - -Usage: - mainflux-cli channels [flags] - mainflux-cli channels [command] - -Available Commands: - create create - delete delete - get get all/ - update update - -``` - -### Service -#### Get the service verison - -``` -./mainflux-cli version -``` - -### User management -#### Create User - -``` -./mainflux-cli users create john.doe@email.com password -``` - -#### Login User - -``` -./mainflux-cli users token john.doe@email.com password -``` - -### System Provisioning -#### Provision Device - -``` -./mainflux-cli things create '{"type":"device", "name":"nyDevice"}' -``` - -#### Provision Application - -``` -./mainflux-cli things create '{"type":"app", "name":"nyDevice"}' -``` - -#### Retrieve All Things - -``` -./mainflux-cli things get all --offset=1 --limit=5 -``` - -#### Retrieve Thing By ID - -``` -./mainflux-cli things get --offset=1 --limit=5 -``` - -#### Remove Thing - -``` -./mainflux-cli things delete -``` - -#### Provision Channel - -``` -./mainflux-cli channels create '{"name":"nyChannel"}' -``` - -#### Retrieve All Channels - -``` -./mainflux-cli channels get all --offset=1 --limit=5 -``` - -#### Retrievie Channel By ID - -``` -./mainflux-cli channels get --offset=1 --limit=5 -``` - -#### Remove Channel - -``` -./mainflux-cli channels delete -``` - -### Access control -#### Connect Thing to a Channel - -``` -./mainflux-cli things connect -``` - -#### Disconnect Things from a Channel - -``` -./mainflux-cli things disconnect -``` - -### Messaging -#### Send a message over HTTP - -``` -./mainflux-cli msg send '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]' -``` - - - - - ## Add-ons The `/docker` folder contains an `addons` directory. This directory is used for various services that are not core to the Mainflux platform but could be used for providing additional features. diff --git a/mkdocs.yml b/mkdocs.yml index 9a2e5992..d4972652 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,5 +29,6 @@ pages: - License: LICENSE.txt - Architecture: architecture.md - Getting Started: getting-started.md -- Developer Guide: dev-guide.md +- Developer's Guide: dev-guide.md +- CLI: cli.md - Load Test: load-test.md