Skip to content

Commit

Permalink
docs: update commands documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Leonardo Grasso <[email protected]>
  • Loading branch information
leogr authored and poiana committed Nov 10, 2020
1 parent 7c60375 commit 71efb92
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
11 changes: 4 additions & 7 deletions docs/event-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@

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")
-c, --config string Config file path (default $HOME/.falco-event-generator.yaml if exists)
-h, --help help for event-generator
--logformat string available formats: "text" or "json" (default "text")
-l, --loglevel string Log level (default "info")
```

### SEE ALSO
Expand Down
6 changes: 4 additions & 2 deletions docs/event-generator_bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ event-generator bench [regexp] [flags]
--grpc-port uint16 Port for connecting to a Falco gRPC server (default 5060)
--grpc-unix-socket string Unix socket path for connecting to a Falco gRPC server (default "unix:///var/run/falco.sock")
-h, --help help for bench
--humanize Humanize values when printing statistics (default true)
--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.
--loop Run in a loop
Expand All @@ -71,8 +72,9 @@ event-generator bench [regexp] [flags]
### 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")
-c, --config string Config file path (default $HOME/.falco-event-generator.yaml if exists)
--logformat string available formats: "text" or "json" (default "text")
-l, --loglevel string Log level (default "info")
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/event-generator_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ event-generator list [regexp] [flags]
### 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")
-c, --config string Config file path (default $HOME/.falco-event-generator.yaml if exists)
--logformat string available formats: "text" or "json" (default "text")
-l, --loglevel string Log level (default "info")
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/event-generator_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ event-generator run [regexp] [flags]
### 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")
-c, --config string Config file path (default $HOME/.falco-event-generator.yaml if exists)
--logformat string available formats: "text" or "json" (default "text")
-l, --loglevel string Log level (default "info")
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/event-generator_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ event-generator test [regexp] [flags]
### 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")
-c, --config string Config file path (default $HOME/.falco-event-generator.yaml if exists)
--logformat string available formats: "text" or "json" (default "text")
-l, --loglevel string Log level (default "info")
```

### SEE ALSO
Expand Down

0 comments on commit 71efb92

Please sign in to comment.