Skip to content

Commit 79994dd

Browse files
authored
Merge pull request #31 from opengisch/move_doc
Link documentation from docs.qfield.org
2 parents bed3c5d + f01f74a commit 79994dd

File tree

1 file changed

+1
-193
lines changed

1 file changed

+1
-193
lines changed

README.md

Lines changed: 1 addition & 193 deletions
Original file line numberDiff line numberDiff line change
@@ -49,201 +49,9 @@ export QFIELDCLOUD_TOKEN=017478ee2464440cb8d3e98080df5e5a
4949
qfieldcloud-cli --json list-projects
5050
```
5151

52-
### Global options overview
5352

54-
```
55-
-U, --url TEXT URL to the QFieldCloud API endpoint. If not
56-
passed, gets the value from QFIELDCLOUD_URL
57-
environment variable. Default:
58-
https://app.qfield.cloud/api/v1/
59-
-u, --username TEXT Username or email.
60-
-p, --password TEXT
61-
-t, --token TEXT Session token.
62-
--json / --human Output the result as newline formatted json. Default: False
63-
--verify-ssl / --no-verify-ssl Verify SSL. Default: True
64-
--help Show this message and exit.
65-
```
66-
67-
Environment variables can be used instead of passing some common global options.
68-
69-
- `QFIELDCLOUD_API` - QFieldCloud API endpoint URL
70-
- `QFIELDCLOUD_USERNAME` - QFieldCloud username or email. Requires `QFIELDCLOUD_PASSWORD` to be set.
71-
- `QFIELDCLOUD_PASSWORD` - Password. Requires `QFIELDCLOUD_USERNAME` to be set.
72-
- `QFIELDCLOUD_TOKEN` - Token that can be used instead of passing username and password. It can be obtained by running `qfieldcloud-cli login`.
73-
- `QFIELDCLOUD_VERIFY_SSL` - When set to `0` has the same effect as passing `--no-verify-ssl`.
74-
75-
### Commands overview
76-
77-
```
78-
login Login to QFieldCloud.
79-
logout Logout and expire the token.
80-
list-projects List QFieldCloud projects.
81-
list-files List QFieldCloud project files.
82-
create-project Creates a new empty QFieldCloud project.
83-
delete-project Deletes a QFieldCloud project.
84-
upload-files Upload files to a QFieldCloud project.
85-
download-files Download QFieldCloud project files.
86-
delete-files Delete QFieldCloud project files.
87-
list-jobs List project jobs.
88-
job-trigger Triggers a new job.
89-
job-status Get job status.
90-
package-latest Check project packaging status.
91-
package-download Download packaged QFieldCloud project files.
92-
```
93-
94-
#### login
95-
96-
Login to QFieldCloud.
97-
98-
```
99-
qfieldcloud-cli login [OPTIONS] USERNAME PASSWORD
100-
```
101-
102-
#### logout
103-
104-
Logout from QFieldCloud.
105-
106-
```
107-
qfieldcloud-cli logout
108-
```
109-
110-
#### list-projects
111-
112-
List QFieldCloud projects.
113-
114-
```
115-
qfieldcloud-cli list-projects [OPTIONS]
116-
117-
Options:
118-
--include-public / --no-public Includes the public project in the list. Default: False
119-
```
120-
121-
#### list-files
122-
123-
List QFieldCloud project files.
124-
125-
```
126-
qfieldcloud-cli list-files [OPTIONS] PROJECT_ID
127-
```
128-
129-
#### create-project
130-
131-
Creates a new empty QFieldCloud project.
132-
133-
```
134-
qfieldcloud-cli create-project [OPTIONS] NAME
135-
136-
Options:
137-
--owner TEXT Owner of the project. If omitted, the current
138-
user is the owner.
139-
--description TEXT Description of the project.
140-
--is-public / --is-private Mark the project as public.
141-
```
142-
143-
#### delete-project
144-
145-
Deletes a QFieldCloud project.
146-
147-
```
148-
qfieldcloud-cli delete-project [OPTIONS] PROJECT_ID
149-
```
150-
151-
#### upload-files
53+
More detailed documentation can be found [here](https://docs.qfield.org/reference/qfieldcloud/sdk/)
15254

153-
Upload files to a QFieldCloud project.
154-
155-
```
156-
qfieldcloud-cli upload-files [OPTIONS] PROJECT_ID PROJECT_PATH
157-
158-
Options:
159-
--filter TEXT Do not upload the whole project, but only
160-
the files which match the glob.
161-
--throw-on-error / --no-throw-on-error
162-
If any project file upload fails stop
163-
uploading the rest. Default: False
164-
```
165-
166-
#### download-files
167-
168-
Download QFieldCloud project files.
169-
170-
```
171-
qfieldcloud-cli download-files [OPTIONS] PROJECT_ID LOCAL_DIR
172-
173-
Options:
174-
--filter TEXT Do not download the whole project, but only
175-
the files which match the glob.
176-
--throw-on-error / --no-throw-on-error
177-
If any project file downloads fails stop
178-
downloading the rest. Default: False
179-
```
180-
181-
#### delete-files
182-
183-
Delete QFieldCloud project files.
184-
185-
```
186-
qfieldcloud-cli delete-files [OPTIONS] PROJECT_ID PATHS...
187-
188-
Options:
189-
--throw-on-error / --no-throw-on-error
190-
If any project file delete operations fails
191-
stop, stop deleting the rest. Default: False
192-
```
193-
194-
#### job-list
195-
196-
List project jobs.
197-
198-
```
199-
qfieldcloud-cli list-jobs [OPTIONS] PROJECT_ID
200-
201-
Options:
202-
--type JOBTYPES Job type. One of package, delta_apply or
203-
process_projectfile.
204-
```
205-
206-
#### job-trigger
207-
208-
Triggers a new job.
209-
210-
```
211-
qfieldcloud-cli job-trigger [OPTIONS] PROJECT_ID JOB_TYPE
212-
213-
Options:
214-
--force / --no-force Should force creating a new job. Default: False
215-
```
216-
217-
#### job-status
218-
219-
Get job status.
220-
221-
```
222-
qfieldcloud-cli job-status [OPTIONS] JOB_ID
223-
```
224-
225-
#### package-latest
226-
227-
Check project packaging status.
228-
229-
```
230-
qfieldcloud-cli package-latest [OPTIONS] PROJECT_ID
231-
```
232-
233-
#### package-download
234-
235-
Download packaged QFieldCloud project files.
236-
237-
```
238-
qfieldcloud-cli package-download [OPTIONS] PROJECT_ID LOCAL_DIR
239-
240-
Options:
241-
--filter TEXT Do not download the whole packaged project,
242-
but only the files which match the glob.
243-
--throw-on-error / --no-throw-on-error
244-
If any packaged file downloads fails stop
245-
downloading the rest. Default: False
246-
```
24755

24856
## Development
24957

0 commit comments

Comments
 (0)