ENH: fix examples on CLI tool

Author: dmgav

README.md

@@ -61,11 +61,19 @@ The list of supported functions can also be extended.
 
 ## How to use `save-and-restore` CLI Tool
 
+
+Check login credentials. User password is requested interactively. Alternatively, the
+password can be passed using environment variable `SAVE_AND_RESTORE_API_USER_PASSWORD``.
+
+```bash
+save-and-restore --base-url http://localhost:8080/save-restore --user-name=user LOGIN
+```
+
 Read the configuration node named 'eiger_config'. Print the full configuration data
 (the list of PVs):
 
 ```bash
-save-and-restore --host-url http://localhost:8080/save-restore \
+save-and-restore --base-url http://localhost:8080/save-restore \
 CONFIG GET --config-name /detectors/imaging/eiger_config --show-data=ON
 ```
 
@@ -74,16 +82,16 @@ file ``eiger_pvs.sav``. Automatically create any missing parent folders in
 the path:
 
 ```bash
-save-and-restore --host-url=http://localhost:8080/save-restore --username=user\
---create-folders=true CONFIG ADD --config-name=/detectors/imaging/eiger_config \
+save-and-restore --base-url=http://localhost:8080/save-restore --user-name=user \
+--create-folders=ON CONFIG ADD --config-name=/detectors/imaging/eiger_config \
 --file-name=eiger_pvs.sav --file-format=autosave
 ```
 
 Update an existing configuration node named 'eiger_config'. Load the list of PVs
 from the file ``eiger_pvs.sav``:
 
 ```bash
-save-and-restore --host-url http://localhost:8080/save-restore --username=user\
+save-and-restore --base-url http://localhost:8080/save-restore --user-name=user \
 CONFIG UPDATE --config-name /detectors/imaging/eiger_config \
 --file-name eiger_pvs.sav --file-format autosave
 ```

src/save_and_restore_api/tools/cli.py

@@ -111,22 +111,30 @@ def formatter(prog):
         "\n"
         "Examples:\n"
         "\n"
-        "  Read the configuration node named 'eiger_config'. Print the full config data:\n"
+        "  Check login credentials. User password is requested interactively. Alternatively,\n"
+        "  the password can be passed using environment variable `SAVE_AND_RESTORE_API_USER_PASSWORD`\n"
         "\n"
-        "  save-and-restore --host-url http://localhost:8080/save-restore \\\n"
-        "      CONFIG GET --config-name /detectors/imaging/eiger_config --show-data=ON\n"
+        "  save-and-restore --base-url http://localhost:8080/save-restore --user-name=user LOGIN\n"
         "\n"
-        "  Create a new configuration node named 'eiger_config':\n"
+        "  Read the configuration node named 'eiger_config'. Print the full configuration data\n"
+        "  (the list of PVs):\n"
         "\n"
-        "  save-and-restore --host-url=http://localhost:8080/save-restore --username=user\\\n"
-        "      --create-folders=true CONFIG ADD --config-name=/detectors/imaging/eiger_config \\\n"
-        "      --file-name=eiger_pvs.sav --file-format=autosave\n"
+        "  save-and-restore --base-url http://localhost:8080/save-restore \\\n"
+        "    CONFIG GET --config-name /detectors/imaging/eiger_config --show-data=ON\n"
         "\n"
-        "  Update an existing configuration node named 'eiger_config':\n"
+        "  Create a new configuration node named 'eiger_config'. Load the list of PVs from\n"
+        "  file ``eiger_pvs.sav``. Automatically create any missing parent folders in the path:\n"
         "\n"
-        "  save-and-restore --host-url http://localhost:8080/save-restore --username=user\\\n"
-        "      CONFIG UPDATE --config-name /detectors/imaging/eiger_config \\\n"
-        "      --file-name eiger_pvs.sav --file-format autosave\n",
+        "  save-and-restore --base-url=http://localhost:8080/save-restore --user-name=user \\\n"
+        "    --create-folders=ON CONFIG ADD --config-name=/detectors/imaging/eiger_config \\\n"
+        "    --file-name=eiger_pvs.sav --file-format=autosave\n"
+        "\n"
+        "  Update an existing configuration node named 'eiger_config'. Load the list of PVs\n"
+        "  from the file ``eiger_pvs.sav``:\n"
+        "\n"
+        "  save-and-restore --base-url http://localhost:8080/save-restore --user-name=user \\\n"
+        "    CONFIG UPDATE --config-name /detectors/imaging/eiger_config \\\n"
+        "    --file-name eiger_pvs.sav --file-format autosave\n",
         formatter_class=formatter,
     )