Mirrors/sftpgo
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2025-12-06 22:30:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for cli client

Browse Source
This commit is contained in:
Nicola Murino
2019-08-02 00:06:44 +02:00
parent 266216e372
commit fe3e1db13a
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
scripts/README.md
View File

@@ -8,7 +8,8 @@ You can see the usage with the following command:
python sftpgo_api_cli.py --help 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. - `debug`, default disabled, print useful debug info.
- `base_url`, default `http://127.0.0.1:8080`. Base URL for SFTPGo REST API - `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``` ```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 ### Add user