Browse Source

add cli doc for installing a community module

nico 8 years ago
parent
commit
743ebd6360
1 changed files with 18 additions and 1 deletions
  1. 18 1
      Docs/kalliope_cli.md

+ 18 - 1
Docs/kalliope_cli.md

@@ -32,6 +32,19 @@ Example of use
 kalliope gui
 ```
 
+### install
+Install a community module. You must set an install type option. Currently the only available option is `--git-url`.
+
+Syntax
+```
+kalliope install --git-url "<url>"
+```
+
+Example of use
+```
+kalliope install --git-url "https://github.com/kalliope-project/kalliope_neuron_wikipedia.git"
+```
+
 ## OPTIONS
 
 Commands can be completed by the following options:
@@ -67,4 +80,8 @@ Show debug output in the console
 Example of use
 ```
 kalliope start --debug
-```
+```
+
+### --git-url
+
+Used by the `install` argument to specify the URL of a git repository of the module to install.