docs: CLI documentation (in markdown, generated)

Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
falcosecurity · Apr 9, 2020 · d1f5393 · d1f5393
1 parent 5957b6a
commit d1f5393
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 0 deletions.
diff --git a/docs/event-generator.md b/docs/event-generator.md
@@ -0,0 +1,24 @@
+## event-generator
+
+A command line tool to perform a variety of suspect actions.
+
+### Synopsis
+
+A command line tool to perform a variety of suspect actions.
+
+```
+event-generator [flags]
+```
+
+### Options
+
+```
+  -c, --config string     config file path (default $HOME/.falco-event-generator.yaml if exists)
+  -h, --help              help for event-generator
+  -l, --loglevel string   log level (default "info")
+```
+
+### SEE ALSO
+
+* [event-generator run](event-generator_run.md)	 - Run actions
+
diff --git a/docs/event-generator_run.md b/docs/event-generator_run.md
@@ -0,0 +1,45 @@
+## event-generator run
+
+Run actions
+
+### Synopsis
+
+Run actions
+
+```
+event-generator run [regexp] [flags]
+```
+
+### Options
+
+```
+      --as string                      Username to impersonate for the operation
+      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
+      --cache-dir string               Default HTTP cache directory (default "/Users/leodido/.kube/http-cache")
+      --certificate-authority string   Path to a cert file for the certificate authority
+      --client-certificate string      Path to a client certificate file for TLS
+      --client-key string              Path to a client key file for TLS
+      --cluster string                 The name of the kubeconfig cluster to use
+      --context string                 The name of the kubeconfig context to use
+  -h, --help                           help for run
+      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
+      --match-server-version           Require server version to match client version
+  -n, --namespace string               If present, the namespace scope for this CLI request (default "default")
+      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+  -s, --server string                  The address and port of the Kubernetes API server
+      --token string                   Bearer token for authentication to the API server
+      --user string                    The name of the kubeconfig user to use
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string     config file path (default $HOME/.falco-event-generator.yaml if exists)
+  -l, --loglevel string   log level (default "info")
+```
+
+### SEE ALSO
+
+* [event-generator](event-generator.md)	 - A command line tool to perform a variety of suspect actions.
+