Skip to content

Commit ce1639f

Browse files
committed
Add env documentation in the --help message v2
1 parent 7578c25 commit ce1639f

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

src/bin/qfieldcloud-cli

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,24 @@ def cli(
8383
format_json: bool,
8484
verify_ssl: bool,
8585
):
86-
"""The official QFieldCloud CLI tool.
86+
"""The official QFieldCloud CLI tool. Allows interaction with the QFieldCloud server API.
8787
88-
Examples:
88+
Environment:
89+
90+
Environment variables can be used instead of passing some common global options.
91+
92+
QFIELDCLOUD_API - QFieldCloud API endpoint URL
93+
94+
QFIELDCLOUD_USERNAME - QFieldCloud username or email. Requires `QFIELDCLOUD_PASSWORD` to be set.
95+
96+
QFIELDCLOUD_PASSWORD - Password. Requires `QFIELDCLOUD_USERNAME` to be set.
97+
98+
QFIELDCLOUD_TOKEN - Token that can be used instead of passing username and password. It can be obtained by running `qfieldcloud-cli login`.
99+
100+
QFIELDCLOUD_VERIFY_SSL - When set to `0` has the same effect as passing `--no-verify-ssl`.
101+
102+
103+
Examples:
89104
90105
qfieldcloud-cli login user pass
91106

0 commit comments

Comments
 (0)