Add users cli commands to docs
All checks were successful
continuous-integration/drone/pr Build is passing
All checks were successful
continuous-integration/drone/pr Build is passing
This commit is contained in:
parent
93c9b9c291
commit
5e0ce4641c
|
@ -18,6 +18,7 @@ The following commands are available:
|
||||||
* [migrate](#migrate)
|
* [migrate](#migrate)
|
||||||
* [restore](#restore)
|
* [restore](#restore)
|
||||||
* [testmail](#testmail)
|
* [testmail](#testmail)
|
||||||
|
* [user](#user)
|
||||||
* [version](#version)
|
* [version](#version)
|
||||||
* [web](#web)
|
* [web](#web)
|
||||||
|
|
||||||
|
@ -85,7 +86,7 @@ Usage:
|
||||||
$ vikunja restore <path to dump zip file>
|
$ vikunja restore <path to dump zip file>
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
|
||||||
### testmail
|
### `testmail`
|
||||||
|
|
||||||
Sends a test mail using the configured smtp connection.
|
Sends a test mail using the configured smtp connection.
|
||||||
|
|
||||||
|
@ -94,6 +95,74 @@ Usage:
|
||||||
$ vikunja testmail <email to send the test mail to>
|
$ vikunja testmail <email to send the test mail to>
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
### `user`
|
||||||
|
|
||||||
|
Bundles a few commands to manage users.
|
||||||
|
|
||||||
|
#### `user change-status`
|
||||||
|
|
||||||
|
Enable or disable a user. Will toggle the current status if no flag (`--enable` or `--disable`) is provided.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja user change-status <user id> <flags>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
* `-d`, `--disable`: Disable the user.
|
||||||
|
* `-e`, `--enable`: Enable the user.
|
||||||
|
|
||||||
|
#### `user create`
|
||||||
|
|
||||||
|
Create a new user.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja user create <flags>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
* `-a`, `--avatar-provider`: The avatar provider of the new user. Optional.
|
||||||
|
* `-e`, `--email`: The email address of the new user.
|
||||||
|
* `-p`, `--password`: The password of the new user. You will be asked to enter it if not provided through the flag.
|
||||||
|
* `-u`, `--username`: The username of the new user.
|
||||||
|
|
||||||
|
#### `user list`
|
||||||
|
|
||||||
|
Shows a list of all users.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja user list
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
#### `user reset-password`
|
||||||
|
|
||||||
|
Reset a users password, either through mailing them a reset link or directly.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja user reset-password <flags>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
* `-d`, `--direct`: If provided, reset the password directly instead of sending the user a reset mail.
|
||||||
|
* `-p`, `--password`: The new password of the user. Only used in combination with --direct. You will be asked to enter it if not provided through the flag.
|
||||||
|
|
||||||
|
#### `user update`
|
||||||
|
|
||||||
|
Update an existing user.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja user update <user id>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
* `-a`, `--avatar-provider`: The new avatar provider of the new user.
|
||||||
|
* `-e`, `--email`: The new email address of the user.
|
||||||
|
* `-u`, `--username`: The new username of the user.
|
||||||
|
|
||||||
### `version`
|
### `version`
|
||||||
|
|
||||||
Prints the version of Vikunja.
|
Prints the version of Vikunja.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user