Skip to content

Commit

Permalink
docs: cli docs generated (#1014)
Browse files Browse the repository at this point in the history
  • Loading branch information
exu authored Feb 22, 2022
1 parent 3d8939d commit a76bdc1
Show file tree
Hide file tree
Showing 51 changed files with 254 additions and 94 deletions.
10 changes: 6 additions & 4 deletions docs/cli/testkube.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ testkube [flags]
### Options

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-h, --help help for testkube
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-h, --help help for testkube
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO

* [testkube analytics](testkube_analytics.md) - Analytics management actions
* [testkube artifacts](testkube_artifacts.md) - Artifacts management commands
* [testkube completion](testkube_completion.md) - generate the autocompletion script for the specified shell
* [testkube crd](testkube_crd.md) - CRDs management commands
Expand Down
30 changes: 30 additions & 0 deletions docs/cli/testkube_analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## testkube analytics

Analytics management actions

```
testkube analytics [flags]
```

### Options

```
-h, --help help for analytics
```

### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO

* [testkube](testkube.md) - testkube entrypoint for plugin
* [testkube analytics disable](testkube_analytics_disable.md) - disable collecting of anonymous analytics
* [testkube analytics enable](testkube_analytics_enable.md) - Enable collecting of anonymous analytics
* [testkube analytics status](testkube_analytics_status.md) - Get analytics status

27 changes: 27 additions & 0 deletions docs/cli/testkube_analytics_disable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## testkube analytics disable

disable collecting of anonymous analytics

```
testkube analytics disable [flags]
```

### Options

```
-h, --help help for disable
```

### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO

* [testkube analytics](testkube_analytics.md) - Analytics management actions

27 changes: 27 additions & 0 deletions docs/cli/testkube_analytics_enable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## testkube analytics enable

Enable collecting of anonymous analytics

```
testkube analytics enable [flags]
```

### Options

```
-h, --help help for enable
```

### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO

* [testkube analytics](testkube_analytics.md) - Analytics management actions

27 changes: 27 additions & 0 deletions docs/cli/testkube_analytics_status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## testkube analytics status

Get analytics status

```
testkube analytics status [flags]
```

### Options

```
-h, --help help for status
```

### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO

* [testkube analytics](testkube_analytics.md) - Analytics management actions

7 changes: 4 additions & 3 deletions docs/cli/testkube_artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ testkube artifacts [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_artifacts_download-one.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ testkube artifacts download-one <executionID> <fileName> <destinationDir> [flags
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_artifacts_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ testkube artifacts download <executionID> [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_artifacts_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ testkube artifacts list <executionID> [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ See each sub-command's help for details on how to use the generated script.
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ testkube completion bash
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ testkube completion fish [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ testkube completion powershell [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ testkube completion zsh [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ testkube crd [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_crd_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ testkube crd tests <manifestDirectory> [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ testkube dashboard [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ testkube doc [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_executors.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ testkube executors [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
1 change: 1 addition & 0 deletions docs/cli/testkube_executors_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ testkube executors create [flags]
### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
--go-template string in case of choosing output==go pass golang template (default "{{ . | printf \"%+v\" }}")
-s, --namespace string kubernetes namespace (default "testkube")
Expand Down
1 change: 1 addition & 0 deletions docs/cli/testkube_executors_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ testkube executors delete <executorName> [flags]
### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
--go-template string in case of choosing output==go pass golang template (default "{{ . | printf \"%+v\" }}")
-s, --namespace string kubernetes namespace (default "testkube")
Expand Down
1 change: 1 addition & 0 deletions docs/cli/testkube_executors_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ testkube executors get <executorName> [flags]
### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
--go-template string in case of choosing output==go pass golang template (default "{{ . | printf \"%+v\" }}")
-s, --namespace string kubernetes namespace (default "testkube")
Expand Down
1 change: 1 addition & 0 deletions docs/cli/testkube_executors_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ testkube executors list [flags]
### Options inherited from parent commands

```
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
--go-template string in case of choosing output==go pass golang template (default "{{ . | printf \"%+v\" }}")
-s, --namespace string kubernetes namespace (default "testkube")
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ testkube install [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/testkube_migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ testkube migrate [flags]
### Options inherited from parent commands

```
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
--analytics-enabled should analytics be enabled (default true)
-c, --client string Client used for connecting to testkube API one of proxy|direct (default "proxy")
-s, --namespace string kubernetes namespace (default "testkube")
-v, --verbose should I show additional debug messages
```

### SEE ALSO
Expand Down
Loading

0 comments on commit a76bdc1

Please sign in to comment.