From d3a900421ae8e6ebf0c153350cfe131133fc47c9 Mon Sep 17 00:00:00 2001 From: Washington Kigani Kamadi Date: Wed, 26 Jul 2023 23:14:16 +0300 Subject: [PATCH] NOISSUE - Fix cli documentation (#151) * Fix cli documentation Signed-off-by: WashingtonKK * Add flags Signed-off-by: WashingtonKK * Correct channel commands Signed-off-by: WashingtonKK --------- Signed-off-by: WashingtonKK Co-authored-by: Drasko DRASKOVIC --- docs/cli.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 1fb7c401..ffc16570 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -25,17 +25,19 @@ Usage: mainflux-cli [command] Available Commands: - bootstrap Bootstrap management - certs Certificates management - channels Channels management - completion Generate the autocompletion script for the specified shell - groups Groups management - health Health Check - help Help about any command - messages Send or read messages - provision Provision things and channels from a config file - things Things management - users Users management + bootstrap Bootstrap management + certs Certificates management + channels Channels management + completion Generate the autocompletion script for the specified shell + groups Groups management + health Health Check + help Help about any command + messages Send or read messages + policies Policies management + provision Provision things and channels from a config file + subscription Subscription management + things Things management + users Users management Flags: -b, --bootstrap-url string Bootstrap service URL (default "http://localhost") @@ -52,8 +54,11 @@ Flags: -o, --offset uint Offset query parameter -r, --raw Enables raw output mode for easier parsing of output -R, --reader-url string Reader URL (default "http://localhost") + -z, --state string Bootstrap state query parameter -S, --status string User status query parameter -t, --things-url string Things service URL (default "http://localhost") + -t, --things-url string Things service URL (default "http://localhost") + -T, --topic string Subscription topic query parameter -u, --users-url string Users service URL (default "http://localhost") Use "mainflux-cli [command] --help" for more information about a command. @@ -108,6 +113,7 @@ Global Flags: -c, --config string Config path -y, --content-type string Message content type (default "application/senml+json") -e, --email string User email query parameter + -h, --help help for mainflux-cli -p, --http-url string HTTP adapter URL (default "http://localhost/http") -i, --insecure Do not check for TLS cert -l, --limit uint Limit query parameter (default 100) @@ -116,10 +122,14 @@ Global Flags: -o, --offset uint Offset query parameter -r, --raw Enables raw output mode for easier parsing of output -R, --reader-url string Reader URL (default "http://localhost") + -z, --state string Bootstrap state query parameter -S, --status string User status query parameter -t, --things-url string Things service URL (default "http://localhost") + -t, --things-url string Things service URL (default "http://localhost") + -T, --topic string Subscription topic query parameter -u, --users-url string Users service URL (default "http://localhost") + Use "mainflux-cli channels [command] --help" for more information about a command. ```