Skip to content

Commit

Permalink
[CLI] Update Documentation for all cmds
Browse files Browse the repository at this point in the history
  • Loading branch information
khrm committed Sep 4, 2023
1 parent ff55d32 commit f6231e8
Show file tree
Hide file tree
Showing 6 changed files with 124 additions and 0 deletions.
1 change: 1 addition & 0 deletions tools/tkn-results/docs/tkn-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Config:
### SEE ALSO

* [tkn-results list](tkn-results_list.md) - List Results
* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs
* [tkn-results records](tkn-results_records.md) - Command sub-group for querying Records

###### Auto generated by spf13/cobra on 31-Aug-2023
26 changes: 26 additions & 0 deletions tools/tkn-results/docs/tkn-results_logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## tkn-results logs

Commands for finding and retrieving logs

### Options

```
-h, --help help for logs
```

### Options inherited from parent commands

```
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
-t, --authtoken string authorization bearer token to use for authenticated requests
--insecure determines whether to run insecure GRPC tls request
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true)
```

### SEE ALSO

* [tkn-results](tkn-results.md) - tkn CLI plugin for Tekton Results API
* [tkn-results logs get](tkn-results_logs_get.md) - Get Log
* [tkn-results logs list](tkn-results_logs_list.md) - List Logs

###### Auto generated by spf13/cobra on 31-Aug-2023
31 changes: 31 additions & 0 deletions tools/tkn-results/docs/tkn-results_logs_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## tkn-results logs get

Get Log

```
tkn-results logs get [flags] <log>
<log path>: Log full name to query. This is typically "<namespace>/results/<result name>/logs/<log name>".
```

### Options

```
-h, --help help for get
-o, --output string output format. Valid values: textproto|json (default "json")
```

### Options inherited from parent commands

```
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
-t, --authtoken string authorization bearer token to use for authenticated requests
--insecure determines whether to run insecure GRPC tls request
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true)
```

### SEE ALSO

* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs

###### Auto generated by spf13/cobra on 31-Aug-2023
34 changes: 34 additions & 0 deletions tools/tkn-results/docs/tkn-results_logs_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## tkn-results logs list

List Logs

```
tkn-results logs list [flags] <result parent>
<result parent>: Result parent name to query. This is typically "<namespace>/results/<result name>", but may vary depending on the API Server. "-" may be used as <result name> to query all Logs for a given parent.
```

### Options

```
-f, --filter string CEL Filter
-h, --help help for list
-l, --limit int32 number of items to return. Response may be truncated due to server limits.
-o, --output string output format. Valid values: tab|textproto|json (default "tab")
-p, --page string pagination token to use for next page
```

### Options inherited from parent commands

```
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
-t, --authtoken string authorization bearer token to use for authenticated requests
--insecure determines whether to run insecure GRPC tls request
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true)
```

### SEE ALSO

* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs

###### Auto generated by spf13/cobra on 31-Aug-2023
1 change: 1 addition & 0 deletions tools/tkn-results/docs/tkn-results_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Command sub-group for querying Records
### SEE ALSO

* [tkn-results](tkn-results.md) - tkn CLI plugin for Tekton Results API
* [tkn-results records get](tkn-results_records_get.md) - Get Record
* [tkn-results records list](tkn-results_records_list.md) - List Records

###### Auto generated by spf13/cobra on 31-Aug-2023
31 changes: 31 additions & 0 deletions tools/tkn-results/docs/tkn-results_records_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## tkn-results records get

Get Record

```
tkn-results records get [flags] <record_path>
<record name>: Fully qualified name of the record. This is typically "<namespace>/results/<result name>/records/<record uid>".
```

### Options

```
-h, --help help for get
-o, --output string output format. Valid values: textproto|json (default "json")
```

### Options inherited from parent commands

```
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
-t, --authtoken string authorization bearer token to use for authenticated requests
--insecure determines whether to run insecure GRPC tls request
--portforward enable auto portforwarding to tekton-results-api-service, when addr is set and portforward is true, tkn-results will portforward tekton-results-api-service automatically (default true)
```

### SEE ALSO

* [tkn-results records](tkn-results_records.md) - Command sub-group for querying Records

###### Auto generated by spf13/cobra on 31-Aug-2023

0 comments on commit f6231e8

Please sign in to comment.