Command line interface #
You can interact with Vikunja using its
The following commands are available:
If you don’t specify a command, the
web command will be executed.
All commands use the same standard config file.
Creates a zip file with all vikunja-related files. This includes config, version, all files and the full database.
$ vikunja dump
Shows more detailed help about any command.
$ vikunja help [command]
Run all database migrations which didn’t already run.
$ vikunja migrate [flags] $ vikunja migrate [command]
migrate list #
Shows a list with all database migrations.
$ vikunja migrate list
migrate rollback #
Roll migrations back until a certain point.
$ vikunja migrate rollback [flags]
--name string: The id of the migration you want to roll back until.
Restores a previously created dump from a zip file, see
$ vikunja restore <path to dump zip file>
Sends a test mail using the configured smtp connection.
$ vikunja testmail <email to send the test mail to>
Prints the version of Vikunja.
This is either the semantic version (something like
0.7) or version + git commit hash.
$ vikunja version
Starts Vikunja’s REST api server.
$ vikunja web