From fe3e1db13acf823f0c384709f62018987b3d01f5 Mon Sep 17 00:00:00 2001 From: Nicola Murino Date: Fri, 2 Aug 2019 00:06:44 +0200 Subject: [PATCH] Improve documentation for cli client --- scripts/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index 04d82a35..2bd911eb 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -8,7 +8,8 @@ You can see the usage with the following command: python sftpgo_api_cli.py --help ``` -Basically there is a subcommand for each REST API and a two global arguments +Basically there is a subcommand for each REST API and a two global arguments: + - `debug`, default disabled, print useful debug info. - `base_url`, default `http://127.0.0.1:8080`. Base URL for SFTPGo REST API @@ -16,7 +17,7 @@ For each subcommand `--help` shows the required arguments, try for example: ```python sftpgo_api_cli.py add_user --help``` -Let's a sample usage for each REST API. +Let's see a sample usage for each REST API. ### Add user