Skip to content

Commit a03bcf1

Browse files
committed
Add documentation for package-download
1 parent eaa18e2 commit a03bcf1

2 files changed

Lines changed: 27 additions & 11 deletions

File tree

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,16 @@ Environment variables can be used instead of passing some common global options.
7474
### Commands overview
7575

7676
```
77-
login Login to QFieldCloud.
78-
logout Logout and expire the token.
79-
list-projects List QFieldCloud projects.
80-
list-files List QFieldCloud project files.
81-
create-project Creates a new empty QFieldCloud project.
82-
upload-files Upload files to a QFieldCloud project.
83-
download-files Download QFieldCloud project files.
84-
package-trigger Initiate project packaging for QField.
85-
package-status Check project packaging status.
77+
login Login to QFieldCloud.
78+
logout Logout and expire the token.
79+
list-projects List QFieldCloud projects.
80+
list-files List QFieldCloud project files.
81+
create-project Creates a new empty QFieldCloud project.
82+
upload-files Upload files to a QFieldCloud project.
83+
download-files Download QFieldCloud project files.
84+
package-trigger Initiate project packaging for QField.
85+
package-status Check project packaging status.
86+
package-download Download packaged QFieldCloud project files.
8687
```
8788

8889
#### login
@@ -164,6 +165,21 @@ Options:
164165
downloading the rest. Default: False
165166
```
166167

168+
#### download-files
169+
170+
Download packaged QFieldCloud project files.
171+
172+
```
173+
qfieldcloud-cli package-download [OPTIONS] PROJECT_ID LOCAL_DIR
174+
175+
Options:
176+
--filter TEXT Do not download the whole packaged project,
177+
but only the files which match the glob.
178+
--exit-on-error / --no-exit-on-error
179+
If any packaged file downloads fails stop
180+
downloading the rest. Default: False
181+
```
182+
167183
#### package-trigger
168184

169185
Initiate project packaging for QField.

src/bin/qfieldcloud-cli

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,15 +321,15 @@ def package_status(ctx, project_id):
321321
@click.option(
322322
"--filter",
323323
"filter_glob",
324-
help="Do not download the whole project, but only the files which match the glob.",
324+
help="Do not download the whole packaged project, but only the files which match the glob.",
325325
)
326326
@click.option(
327327
"--exit-on-error/--no-exit-on-error",
328328
help="If any packaged file downloads fails stop downloading the rest. Default: False",
329329
)
330330
@click.pass_context
331331
def package_download(ctx, project_id, local_dir, filter_glob, exit_on_error):
332-
"""Download QFieldCloud project files."""
332+
"""Download packaged QFieldCloud project files."""
333333

334334
def downloaded_cb(file):
335335
if ctx.obj["format_json"]:

0 commit comments

Comments
 (0)