Skip to content

Commit 54897f5

Browse files
committed
Update readme based on the current CLI usage help
1 parent dafe08d commit 54897f5

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,15 @@ $ mergin --help
3636
Usage: mergin [OPTIONS] COMMAND [ARGS]...
3737
3838
Command line interface for the Mergin client module. For user
39-
authentication on server there are two options: 1. authorization token
40-
environment variable (MERGIN_AUTH) is defined, or 2. username and
41-
password need to be given either as environment variables
42-
(MERGIN_USERNAME, MERGIN_PASSWORD), or as command options (--username,
43-
--password). Run `mergin --username <your_user> login` to see how to set
44-
the token variable manually.
39+
authentication on server there are two options:
40+
41+
1. authorization token environment variable (MERGIN_AUTH) is defined, or
42+
2. username and password need to be given either as environment variables
43+
(MERGIN_USERNAME, MERGIN_PASSWORD), or as command options (--username,
44+
--password).
45+
46+
Run `mergin --username <your_user> login` to see how to set the token
47+
variable manually.
4548
4649
Options:
4750
--url TEXT Mergin server URL. Default is:
@@ -55,18 +58,19 @@ Commands:
5558
clone Clone project from server.
5659
create Create a new project on Mergin server.
5760
download Download last version of mergin project
61+
download-file Download project file at specified version.
5862
list-projects List projects on the server
5963
login Login to the service and see how to set the token...
6064
pull Fetch changes from Mergin repository
6165
push Upload local changes into Mergin repository
6266
remove Remove project from server.
67+
share Fetch permissions to project
68+
share-add Add permissions to [users] to project
69+
share-remove Remove [users] permissions from project
6370
show-file-changeset Displays information about project changes.
6471
show-file-history Displays information about a single version of a...
6572
show-version Displays information about a single version of a...
6673
status Show all changes in project files - upstream and...
67-
share Show project permissions
68-
share-add Add user to project permissions
69-
share-remove Remove user from project's collaborators
7074
```
7175

7276
For example, to download a project:

0 commit comments

Comments
 (0)