Command line interface #

You can interact with Vikunja using its cli interface. 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.

dump #

Creates a zip file with all vikunja-related files. This includes config, version, all files and the full database.


$ vikunja dump

help #

Shows more detailed help about any command.


$ vikunja help [command]

migrate #

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]    

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.


$ vikunja restore <path to dump zip file>

testmail #

Sends a test mail using the configured smtp connection.


$ vikunja testmail <email to send the test mail to>

version #

Prints the version of Vikunja. This is either the semantic version (something like 0.7) or version + git commit hash.


$ vikunja version    

web #

Starts Vikunja’s REST api server.


$ vikunja web