Skip to content

Commit f6231e8

Browse files
committed
[CLI] Update Documentation for all cmds
1 parent ff55d32 commit f6231e8

6 files changed

+124
-0
lines changed

tools/tkn-results/docs/tkn-results.md

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Config:
5454
### SEE ALSO
5555

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

5960
###### Auto generated by spf13/cobra on 31-Aug-2023
+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## tkn-results logs
2+
3+
Commands for finding and retrieving logs
4+
5+
### Options
6+
7+
```
8+
-h, --help help for logs
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
15+
-t, --authtoken string authorization bearer token to use for authenticated requests
16+
--insecure determines whether to run insecure GRPC tls request
17+
--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)
18+
```
19+
20+
### SEE ALSO
21+
22+
* [tkn-results](tkn-results.md) - tkn CLI plugin for Tekton Results API
23+
* [tkn-results logs get](tkn-results_logs_get.md) - Get Log
24+
* [tkn-results logs list](tkn-results_logs_list.md) - List Logs
25+
26+
###### Auto generated by spf13/cobra on 31-Aug-2023
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## tkn-results logs get
2+
3+
Get Log
4+
5+
```
6+
tkn-results logs get [flags] <log>
7+
8+
<log path>: Log full name to query. This is typically "<namespace>/results/<result name>/logs/<log name>".
9+
```
10+
11+
### Options
12+
13+
```
14+
-h, --help help for get
15+
-o, --output string output format. Valid values: textproto|json (default "json")
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
22+
-t, --authtoken string authorization bearer token to use for authenticated requests
23+
--insecure determines whether to run insecure GRPC tls request
24+
--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)
25+
```
26+
27+
### SEE ALSO
28+
29+
* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs
30+
31+
###### Auto generated by spf13/cobra on 31-Aug-2023
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## tkn-results logs list
2+
3+
List Logs
4+
5+
```
6+
tkn-results logs list [flags] <result parent>
7+
8+
<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.
9+
```
10+
11+
### Options
12+
13+
```
14+
-f, --filter string CEL Filter
15+
-h, --help help for list
16+
-l, --limit int32 number of items to return. Response may be truncated due to server limits.
17+
-o, --output string output format. Valid values: tab|textproto|json (default "tab")
18+
-p, --page string pagination token to use for next page
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
25+
-t, --authtoken string authorization bearer token to use for authenticated requests
26+
--insecure determines whether to run insecure GRPC tls request
27+
--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)
28+
```
29+
30+
### SEE ALSO
31+
32+
* [tkn-results logs](tkn-results_logs.md) - Commands for finding and retrieving logs
33+
34+
###### Auto generated by spf13/cobra on 31-Aug-2023

tools/tkn-results/docs/tkn-results_records.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Command sub-group for querying Records
2222
### SEE ALSO
2323

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

2728
###### Auto generated by spf13/cobra on 31-Aug-2023
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## tkn-results records get
2+
3+
Get Record
4+
5+
```
6+
tkn-results records get [flags] <record_path>
7+
8+
<record name>: Fully qualified name of the record. This is typically "<namespace>/results/<result name>/records/<record uid>".
9+
```
10+
11+
### Options
12+
13+
```
14+
-h, --help help for get
15+
-o, --output string output format. Valid values: textproto|json (default "json")
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-a, --addr string Result API server address. If not specified, tkn-result would port-forward to service/tekton-results-api-service automatically
22+
-t, --authtoken string authorization bearer token to use for authenticated requests
23+
--insecure determines whether to run insecure GRPC tls request
24+
--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)
25+
```
26+
27+
### SEE ALSO
28+
29+
* [tkn-results records](tkn-results_records.md) - Command sub-group for querying Records
30+
31+
###### Auto generated by spf13/cobra on 31-Aug-2023

0 commit comments

Comments
 (0)