summaryrefslogtreecommitdiff
path: root/doc/cli.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-05-20 12:51:05 -0400
committerFrederic Guillot <fred@kanboard.net>2016-05-20 12:51:05 -0400
commit8d69c49da595c60dae51c77d48f397ab97fdf318 (patch)
tree7fba4edb18c5c4c161e76828d5847733aca8d27b /doc/cli.markdown
parentcbf896e74e666f102f475787202d3402f229a919 (diff)
Manage plugins from the user interface and from the command line
Diffstat (limited to 'doc/cli.markdown')
-rw-r--r--doc/cli.markdown26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/cli.markdown b/doc/cli.markdown
index 20e3566a..96bffe2d 100644
--- a/doc/cli.markdown
+++ b/doc/cli.markdown
@@ -41,6 +41,10 @@ Available commands:
locale:sync Synchronize all translations based on the fr_FR locale
notification
notification:overdue-tasks Send notifications for overdue tasks
+ plugin
+ plugin:install Install a plugin from a remote Zip archive
+ plugin:uninstall Remove a plugin
+ plugin:upgrade Update all installed plugins
projects
projects:daily-stats Calculate daily statistics for all projects
trigger
@@ -170,3 +174,25 @@ You will be prompted for a password and confirmation. Characters are not printed
```bash
./kanboard user:reset-2fa my_user
```
+
+### Install a plugin
+
+```bash
+./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip
+```
+
+Note: Installed files will have the same permissions as the current user
+
+### Remove a plugin
+
+```bash
+./kanboard plugin:uninstall Budget
+```
+
+### Upgrade all plugins
+
+```bash
+./kanboard plugin:upgrade
+* Updating plugin: Budget Planning
+* Plugin up to date: Github Authentication
+```