Update docs with testmail command + reorder
This commit is contained in:
parent
3a9360a57b
commit
3d709e3bb7
1 changed files with 30 additions and 19 deletions
|
@ -13,8 +13,11 @@ menu:
|
||||||
You can interact with Vikunja using its `cli` interface.
|
You can interact with Vikunja using its `cli` interface.
|
||||||
The following commands are available:
|
The following commands are available:
|
||||||
|
|
||||||
|
* [dump](#dump)
|
||||||
* [help](#help)
|
* [help](#help)
|
||||||
* [migrate](#migrate)
|
* [migrate](#migrate)
|
||||||
|
* [restore](#restore)
|
||||||
|
* [testmail](#testmail)
|
||||||
* [version](#version)
|
* [version](#version)
|
||||||
* [web](#web)
|
* [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">}}).
|
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`
|
### `help`
|
||||||
|
|
||||||
Shows more detailed help about any command.
|
Shows more detailed help about any command.
|
||||||
|
@ -63,6 +76,23 @@ $ vikunja migrate rollback [flags]
|
||||||
Flags:
|
Flags:
|
||||||
* `-n`, `--name` string: The id of the migration you want to roll back until.
|
* `-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 <path to dump zip file>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
### testmail
|
||||||
|
|
||||||
|
Sends a test mail using the configured smtp connection.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{{< highlight bash >}}
|
||||||
|
$ vikunja testmail <email to send the test mail to>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
### `version`
|
### `version`
|
||||||
|
|
||||||
|
@ -82,22 +112,3 @@ Usage:
|
||||||
{{< highlight bash >}}
|
{{< highlight bash >}}
|
||||||
$ vikunja web
|
$ vikunja web
|
||||||
{{< /highlight >}}
|
{{< /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 <path to dump zip file>
|
|
||||||
{{< /highlight >}}
|
|
||||||
|
|
Loading…
Reference in a new issue