From 7e0aa2065879f2f6b025236c27d3c92b67f16142 Mon Sep 17 00:00:00 2001 From: kolaente Date: Tue, 15 Nov 2022 14:53:58 +0100 Subject: [PATCH] fix(docs): add docs about cli user delete --- docs/content/doc/usage/cli.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/content/doc/usage/cli.md b/docs/content/doc/usage/cli.md index 364a06703..915a1c1f2 100644 --- a/docs/content/doc/usage/cli.md +++ b/docs/content/doc/usage/cli.md @@ -136,6 +136,21 @@ Flags: * `-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 delete` + +Start the user deletion process. +If called without the `--now` flag, this command will only trigger an email to the user in order for them to confirm and start the deletion process (this is the same behavoir as if the user requested their deletion via the web interface). +With the flag the user is deleted **immediately**. + +**USE WITH CAUTION.** + +{{< highlight bash >}} +$ vikunja user delete +{{< /highlight >}} + +Flags: +* `-n`, `--now` If provided, deletes the user immediately instead of emailing them first. + #### `user list` Shows a list of all users.