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.
Usage:
$ vikunja dump
help
#
Shows more detailed help about any command.
Usage:
$ vikunja help [command]
migrate
#
Run all database migrations which didn’t already run.
Usage:
$ vikunja migrate [flags]
$ vikunja migrate [command]
migrate list
#
Shows a list with all database migrations.
Usage:
$ vikunja migrate list
migrate rollback
#
Roll migrations back until a certain point.
Usage:
$ 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:
$ vikunja restore <path to dump zip file>
testmail
#
Sends a test mail using the configured smtp connection.
Usage:
$ vikunja testmail <email to send the test mail to>
user
#
Bundles a few commands to manage users.
user change-status
#
Enable or disable a user. Will toggle the current status if no flag (--enable
or --disable
) is provided.
Usage:
$ vikunja user change-status <user id> <flags>
Flags:
-d
,--disable
: Disable the user.-e
,--enable
: Enable the user.
user create
#
Create a new user.
Usage:
$ vikunja user create <flags>
Flags:
-a
,--avatar-provider
: The avatar provider of the new user. Optional.-e
,--email
: The email address of the new user.-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 list
#
Shows a list of all users.
Usage:
$ vikunja user list
user reset-password
#
Reset a users password, either through mailing them a reset link or directly.
Usage:
$ vikunja user reset-password <flags>
Flags:
-d
,--direct
: If provided, reset the password directly instead of sending the user a reset mail.-p
,--password
: The new password of the user. Only used in combination with –direct. You will be asked to enter it if not provided through the flag.
user update
#
Update an existing user.
Usage:
$ vikunja user update <user id>
Flags:
-a
,--avatar-provider
: The new avatar provider of the new user.-e
,--email
: The new email address of the user.-u
,--username
: The new username of the user.
version
#
Prints the version of Vikunja.
This is either the semantic version (something like 0.7
) or version + git commit hash.
Usage:
$ vikunja version
web
#
Starts Vikunja’s REST api server.
Usage:
$ vikunja web