Update CLI documentation

nono · nono · commit 5931d7da394d · 2018-03-12T10:57:29.000+01:00
diff --git a/docs/cli/cozy-stack.md b/docs/cli/cozy-stack.md
@@ -27,17 +27,18 @@ cozy-stack [flags]
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 * [cozy-stack bug](cozy-stack_bug.md)	 - start a bug report
 * [cozy-stack completion](cozy-stack_completion.md)	 - Output shell completion code for the specified shell
 * [cozy-stack config](cozy-stack_config.md)	 - Show and manage configuration elements
 * [cozy-stack doc](cozy-stack_doc.md)	 - Print the documentation
 * [cozy-stack files](cozy-stack_files.md)	 - Interact with the cozy filesystem
 * [cozy-stack fixer](cozy-stack_fixer.md)	 - A set of tools to fix issues or migrate content for retro-compatibility.
 * [cozy-stack instances](cozy-stack_instances.md)	 - Manage instances of a stack
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 * [cozy-stack serve](cozy-stack_serve.md)	 - Starts the stack and listens for HTTP calls
 * [cozy-stack settings](cozy-stack_settings.md)	 - Display and update settings
 * [cozy-stack status](cozy-stack_status.md)	 - Check if the HTTP server is running
+* [cozy-stack triggers](cozy-stack_triggers.md)	 - Interact with the triggers
 * [cozy-stack version](cozy-stack_version.md)	 - Print the version number
 
diff --git a/docs/cli/cozy-stack_apps.md b/docs/cli/cozy-stack_apps.md
@@ -1,6 +1,6 @@
 ## cozy-stack apps
 
-Interact with the cozy applications
+Interact with the applications
 
 ### Synopsis
 
diff --git a/docs/cli/cozy-stack_apps_install.md b/docs/cli/cozy-stack_apps_install.md
@@ -39,5 +39,5 @@ $ cozy-stack apps install --domain cozy.tools:8080 drive 'git://github.com/cozy/
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 
diff --git a/docs/cli/cozy-stack_apps_ls.md b/docs/cli/cozy-stack_apps_ls.md
@@ -31,5 +31,5 @@ cozy-stack apps ls [flags]
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 
diff --git a/docs/cli/cozy-stack_apps_show.md b/docs/cli/cozy-stack_apps_show.md
@@ -31,5 +31,5 @@ cozy-stack apps show [slug] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 
diff --git a/docs/cli/cozy-stack_apps_uninstall.md b/docs/cli/cozy-stack_apps_uninstall.md
@@ -31,5 +31,5 @@ cozy-stack apps uninstall [slug] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 
diff --git a/docs/cli/cozy-stack_apps_update.md b/docs/cli/cozy-stack_apps_update.md
@@ -31,5 +31,5 @@ cozy-stack apps update [slug] [sourceurl] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the cozy applications
+* [cozy-stack apps](cozy-stack_apps.md)	 - Interact with the applications
 
diff --git a/docs/cli/cozy-stack_config.md b/docs/cli/cozy-stack_config.md
@@ -28,6 +28,7 @@ cozy-stack config allows to print and generate some parts of the configuration
 ### SEE ALSO
 
 * [cozy-stack](cozy-stack.md)	 - cozy-stack is the main command
+* [cozy-stack config decrypt-creds](cozy-stack_config_decrypt-creds.md)	 - Decrypt the given credentials cipher text with the specified decryption keyfile.
 * [cozy-stack config gen-keys](cozy-stack_config_gen-keys.md)	 - Generate an key pair for encryption and decryption of credentials
 * [cozy-stack config passwd](cozy-stack_config_passwd.md)	 - Generate an admin passphrase
 * [cozy-stack config print](cozy-stack_config_print.md)	 - Display the configuration
diff --git a/docs/cli/cozy-stack_config_decrypt-creds.md b/docs/cli/cozy-stack_config_decrypt-creds.md
@@ -0,0 +1,33 @@
+## cozy-stack config decrypt-creds
+
+Decrypt the given credentials cipher text with the specified decryption keyfile.
+
+### Synopsis
+
+Decrypt the given credentials cipher text with the specified decryption keyfile.
+
+```
+cozy-stack config decrypt-creds [keyfile] [ciphertext] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for decrypt-creds
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+      --client-use-https    if set the client will use https to communicate with the server
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack config](cozy-stack_config.md)	 - Show and manage configuration elements
+
diff --git a/docs/cli/cozy-stack_instances.md b/docs/cli/cozy-stack_instances.md
@@ -53,6 +53,7 @@ cozy-stack instances [command] [flags]
 * [cozy-stack instances show](cozy-stack_instances_show.md)	 - Show the instance of the specified domain
 * [cozy-stack instances token-app](cozy-stack_instances_token-app.md)	 - Generate a new application token
 * [cozy-stack instances token-cli](cozy-stack_instances_token-cli.md)	 - Generate a new CLI access token (global access)
+* [cozy-stack instances token-konnector](cozy-stack_instances_token-konnector.md)	 - Generate a new konnector token
 * [cozy-stack instances token-oauth](cozy-stack_instances_token-oauth.md)	 - Generate a new OAuth access token
 * [cozy-stack instances update](cozy-stack_instances_update.md)	 - Start the updates for the specified domain instance.
 
diff --git a/docs/cli/cozy-stack_instances_token-konnector.md b/docs/cli/cozy-stack_instances_token-konnector.md
@@ -0,0 +1,33 @@
+## cozy-stack instances token-konnector
+
+Generate a new konnector token
+
+### Synopsis
+
+Generate a new konnector token
+
+```
+cozy-stack instances token-konnector [domain] [slug] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for token-konnector
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+      --client-use-https    if set the client will use https to communicate with the server
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack instances](cozy-stack_instances.md)	 - Manage instances of a stack
+
diff --git a/docs/cli/cozy-stack_konnectors.md b/docs/cli/cozy-stack_konnectors.md
@@ -1,6 +1,6 @@
 ## cozy-stack konnectors
 
-Interact with the cozy applications
+Interact with the konnectors
 
 ### Synopsis
 
diff --git a/docs/cli/cozy-stack_konnectors_install.md b/docs/cli/cozy-stack_konnectors_install.md
@@ -40,5 +40,5 @@ $ cozy-stack konnectors install --domain cozy.tools:8080 trainline 'git://github
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_konnectors_ls.md b/docs/cli/cozy-stack_konnectors_ls.md
@@ -32,5 +32,5 @@ cozy-stack konnectors ls [flags]
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_konnectors_run.md b/docs/cli/cozy-stack_konnectors_run.md
@@ -33,5 +33,5 @@ cozy-stack konnectors run [slug] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_konnectors_show.md b/docs/cli/cozy-stack_konnectors_show.md
@@ -32,5 +32,5 @@ cozy-stack konnectors show [slug] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_konnectors_uninstall.md b/docs/cli/cozy-stack_konnectors_uninstall.md
@@ -32,5 +32,5 @@ cozy-stack konnectors uninstall [slug] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_konnectors_update.md b/docs/cli/cozy-stack_konnectors_update.md
@@ -32,5 +32,5 @@ cozy-stack konnectors update [slug] [sourceurl] [flags]
 
 ### SEE ALSO
 
-* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the cozy applications
+* [cozy-stack konnectors](cozy-stack_konnectors.md)	 - Interact with the konnectors
 
diff --git a/docs/cli/cozy-stack_serve.md b/docs/cli/cozy-stack_serve.md
@@ -45,7 +45,7 @@ example), you can use the --appdir flag like this:
       --disable-csp                      Disable the Content Security Policy (only available for development)
       --doctypes string                  path to the directory with the doctypes (for developing/testing a remote doctype)
       --downloads-url string             URL for the download secret storage, redis or in-memory
-      --fs-url string                    filesystem url (default "file:///Users/pierre/go/src/github.com/cozy/cozy-stack/storage")
+      --fs-url string                    filesystem url (default "file:///storage")
       --geodb string                     define the location of the database for IP -> City lookups (default ".")
   -h, --help                             help for serve
       --hooks string                     define the directory used for hook scripts (default ".")
diff --git a/docs/cli/cozy-stack_triggers.md b/docs/cli/cozy-stack_triggers.md
@@ -0,0 +1,39 @@
+## cozy-stack triggers
+
+Interact with the triggers
+
+### Synopsis
+
+
+cozy-stack apps allows to interact with the cozy triggers.
+
+It provides command to run a specific trigger.
+
+
+```
+cozy-stack triggers [command] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for triggers
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+      --client-use-https    if set the client will use https to communicate with the server
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack](cozy-stack.md)	 - cozy-stack is the main command
+* [cozy-stack triggers launch](cozy-stack_triggers_launch.md)	 - Creates a job from a specific trigger
+* [cozy-stack triggers show-from-app](cozy-stack_triggers_show-from-app.md)	 - Show the application triggers
+
diff --git a/docs/cli/cozy-stack_triggers_launch.md b/docs/cli/cozy-stack_triggers_launch.md
@@ -0,0 +1,39 @@
+## cozy-stack triggers launch
+
+Creates a job from a specific trigger
+
+### Synopsis
+
+Creates a job from a specific trigger
+
+```
+cozy-stack triggers launch [triggerId] [flags]
+```
+
+### Examples
+
+```
+$ cozy-stack triggers launch --domain cozy.tools:8080 748f42b65aca8c99ec2492eb660d1891
+```
+
+### Options
+
+```
+  -h, --help   help for launch
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+      --client-use-https    if set the client will use https to communicate with the server
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack triggers](cozy-stack_triggers.md)	 - Interact with the triggers
+
diff --git a/docs/cli/cozy-stack_triggers_show-from-app.md b/docs/cli/cozy-stack_triggers_show-from-app.md
@@ -0,0 +1,33 @@
+## cozy-stack triggers show-from-app
+
+Show the application triggers
+
+### Synopsis
+
+Show the application triggers
+
+```
+cozy-stack triggers show-from-app [slug] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for show-from-app
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+      --client-use-https    if set the client will use https to communicate with the server
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack triggers](cozy-stack_triggers.md)	 - Interact with the triggers
+

Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,5 @@ $ cozy-stack apps install --domain cozy.tools:8080 drive 'git://github.com/cozy/`
`39`	`39`
`40`	`40`	`### SEE ALSO`
`41`	`41`
`42`		`-* [cozy-stack apps](cozy-stack_apps.md) - Interact with the cozy applications`
	`42`	`+* [cozy-stack apps](cozy-stack_apps.md) - Interact with the applications`
`43`	`43`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,5 @@ cozy-stack apps ls [flags]`
`31`	`31`
`32`	`32`	`### SEE ALSO`
`33`	`33`
`34`		`-* [cozy-stack apps](cozy-stack_apps.md) - Interact with the cozy applications`
	`34`	`+* [cozy-stack apps](cozy-stack_apps.md) - Interact with the applications`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,5 @@ cozy-stack apps show [slug] [flags]`
`31`	`31`
`32`	`32`	`### SEE ALSO`
`33`	`33`
`34`		`-* [cozy-stack apps](cozy-stack_apps.md) - Interact with the cozy applications`
	`34`	`+* [cozy-stack apps](cozy-stack_apps.md) - Interact with the applications`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,5 @@ cozy-stack apps uninstall [slug] [flags]`
`31`	`31`
`32`	`32`	`### SEE ALSO`
`33`	`33`
`34`		`-* [cozy-stack apps](cozy-stack_apps.md) - Interact with the cozy applications`
	`34`	`+* [cozy-stack apps](cozy-stack_apps.md) - Interact with the applications`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,5 @@ cozy-stack apps update [slug] [sourceurl] [flags]`
`31`	`31`
`32`	`32`	`### SEE ALSO`
`33`	`33`
`34`		`-* [cozy-stack apps](cozy-stack_apps.md) - Interact with the cozy applications`
	`34`	`+* [cozy-stack apps](cozy-stack_apps.md) - Interact with the applications`
`35`	`35`