[CLI] Update Documentation for all cmds

khrm · khrm · commit f60f74ab9ba0 · 2023-08-31T18:52:40.000+05:30
diff --git a/tools/tkn-results/docs/tkn-results.md b/tools/tkn-results/docs/tkn-results.md
@@ -45,13 +45,14 @@ Config:
   -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
   -h, --help               help for tkn-results
-      --insecure           insecure GRPC tls request (default true)
+      --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 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 24-Aug-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/tools/tkn-results/docs/tkn-results_list.md b/tools/tkn-results/docs/tkn-results_list.md
@@ -23,12 +23,12 @@ tkn-results list [flags] <parent>
 ```
   -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           insecure GRPC tls request (default true)
+      --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
 
-###### Auto generated by spf13/cobra on 24-Aug-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/tools/tkn-results/docs/tkn-results_logs.md b/tools/tkn-results/docs/tkn-results_logs.md
@@ -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
diff --git a/tools/tkn-results/docs/tkn-results_logs_get.md b/tools/tkn-results/docs/tkn-results_logs_get.md
@@ -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
diff --git a/tools/tkn-results/docs/tkn-results_logs_list.md b/tools/tkn-results/docs/tkn-results_logs_list.md
@@ -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
diff --git a/tools/tkn-results/docs/tkn-results_records.md b/tools/tkn-results/docs/tkn-results_records.md
@@ -13,13 +13,14 @@ Command sub-group for querying Records
 ```
   -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           insecure GRPC tls request (default true)
+      --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 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 24-Aug-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
diff --git a/tools/tkn-results/docs/tkn-results_records_get.md b/tools/tkn-results/docs/tkn-results_records_get.md
@@ -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
diff --git a/tools/tkn-results/docs/tkn-results_records_list.md b/tools/tkn-results/docs/tkn-results_records_list.md
@@ -23,12 +23,12 @@ tkn-results records list [flags] <result parent>
 ```
   -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           insecure GRPC tls request (default true)
+      --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 24-Aug-2023
+###### Auto generated by spf13/cobra on 31-Aug-2023
