diff --git a/docs/content/doc/usage/cli.md b/docs/content/doc/usage/cli.md index 65a9ff53291..8de09d9059c 100644 --- a/docs/content/doc/usage/cli.md +++ b/docs/content/doc/usage/cli.md @@ -13,8 +13,11 @@ menu: You can interact with Vikunja using its `cli` interface. The following commands are available: +* [dump](#dump) * [help](#help) * [migrate](#migrate) +* [restore](#restore) +* [testmail](#testmail) * [version](#version) * [web](#web) @@ -22,6 +25,16 @@ If you don't specify a command, the [`web`](#web) command will be executed. All commands use the same standard [config file]({{< ref "../setup/config.md">}}). +### `dump` + +Creates a zip file with all vikunja-related files. +This includes config, version, all files and the full database. + +Usage: +{{< highlight bash >}} +$ vikunja dump +{{< /highlight >}} + ### `help` Shows more detailed help about any command. @@ -63,6 +76,23 @@ $ vikunja migrate rollback [flags] Flags: * `-n`, `--name` string: The id of the migration you want to roll back until. +### `restore` + +Restores a previously created dump from a zip file, see `dump`. + +Usage: +{{< highlight bash >}} +$ vikunja restore +{{< /highlight >}} + +### testmail + +Sends a test mail using the configured smtp connection. + +Usage: +{{< highlight bash >}} +$ vikunja testmail +{{< /highlight >}} ### `version` @@ -82,22 +112,3 @@ Usage: {{< highlight bash >}} $ vikunja web {{< /highlight >}} - -### `dump` - -Creates a zip file with all vikunja-related files. -This includes config, version, all files and the full database. - -Usage: -{{< highlight bash >}} -$ vikunja dump -{{< /highlight >}} - -### `restore` - -Restores a previously created dump from a zip file, see `dump`. - -Usage: -{{< highlight bash >}} -$ vikunja restore -{{< /highlight >}}