Update cli doc's with newly introduced flags and examples

nikhilsbhat · Jan 8, 2024 · 4dba812 · 4dba812
1 parent ad0d5f4
commit 4dba812
Show file tree

Hide file tree

Showing 145 changed files with 412 additions and 146 deletions.
diff --git a/docs/doc/gocd-cli.md b/docs/doc/gocd-cli.md
@@ -29,6 +29,7 @@ gocd-cli [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -56,4 +57,4 @@ gocd-cli [flags]
 * [gocd-cli version](gocd-cli_version.md)	 - Command to fetch the version of gocd-cli installed
 * [gocd-cli who-am-i](gocd-cli_who-am-i.md)	 - Command to check which user being used by GoCD Command line interface
 
-###### Auto generated by spf13/cobra on 2-Jan-2024
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents.md b/docs/doc/gocd-cli_agents.md
@@ -35,6 +35,7 @@ gocd-cli agents [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -48,4 +49,4 @@ gocd-cli agents [flags]
 * [gocd-cli agents list](gocd-cli_agents_list.md)	 - Command to LIST all the agents present in GoCD [https://api.gocd.org/current/#get-all-agents]
 * [gocd-cli agents update](gocd-cli_agents_update.md)	 - Command to UPDATE an agent with all specified configuration [https://api.gocd.org/current/#update-an-agent]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_delete.md b/docs/doc/gocd-cli_agents_delete.md
@@ -39,10 +39,11 @@ gocd-cli agents delete --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_get-all.md b/docs/doc/gocd-cli_agents_get-all.md
@@ -35,10 +35,11 @@ gocd-cli agents get-all [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_get.md b/docs/doc/gocd-cli_agents_get.md
@@ -39,10 +39,11 @@ gocd-cli agents get --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_job-history.md b/docs/doc/gocd-cli_agents_job-history.md
@@ -39,10 +39,11 @@ gocd-cli agents job-history --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_kill-task.md b/docs/doc/gocd-cli_agents_kill-task.md
@@ -39,10 +39,11 @@ gocd-cli agents kill-task --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_list.md b/docs/doc/gocd-cli_agents_list.md
@@ -35,10 +35,11 @@ gocd-cli agents list [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_agents_update.md b/docs/doc/gocd-cli_agents_update.md
@@ -30,10 +30,11 @@ gocd-cli agents update [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli agents](gocd-cli_agents.md)	 - Command to operate on agents present in GoCD [https://api.gocd.org/current/#agents]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact.md b/docs/doc/gocd-cli_artifact.md
@@ -35,6 +35,7 @@ gocd-cli artifact [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -51,4 +52,4 @@ gocd-cli artifact [flags]
 * [gocd-cli artifact update-config](gocd-cli_artifact_update-config.md)	 - Command to UPDATE artifact config specified configurations in GoCD [https://api.gocd.org/current/#update-artifacts-config]
 * [gocd-cli artifact update-store](gocd-cli_artifact_update-store.md)	 - Command to UPDATE an artifact store with all specified configurations in GoCD [https://api.gocd.org/current/#update-an-artifact-store]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_create-store.md b/docs/doc/gocd-cli_artifact_create-store.md
@@ -30,10 +30,11 @@ gocd-cli artifact create-store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_delete-store.md b/docs/doc/gocd-cli_artifact_delete-store.md
@@ -30,10 +30,11 @@ gocd-cli artifact delete-store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_get-all-stores.md b/docs/doc/gocd-cli_artifact_get-all-stores.md
@@ -30,10 +30,11 @@ gocd-cli artifact get-all-stores [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_get-config.md b/docs/doc/gocd-cli_artifact_get-config.md
@@ -30,10 +30,11 @@ gocd-cli artifact get-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_get-store.md b/docs/doc/gocd-cli_artifact_get-store.md
@@ -30,10 +30,11 @@ gocd-cli artifact get-store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_job-history.md b/docs/doc/gocd-cli_artifact_job-history.md
@@ -39,10 +39,11 @@ gocd-cli agents job-history --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_kill-task.md b/docs/doc/gocd-cli_artifact_kill-task.md
@@ -39,10 +39,11 @@ gocd-cli agents kill-task --id 938d1935-bdca-4728-83d5-e96cbf0a4f8b
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_list-store.md b/docs/doc/gocd-cli_artifact_list-store.md
@@ -30,10 +30,11 @@ gocd-cli artifact list-store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_update-config.md b/docs/doc/gocd-cli_artifact_update-config.md
@@ -30,10 +30,11 @@ gocd-cli artifact update-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_artifact_update-store.md b/docs/doc/gocd-cli_artifact_update-store.md
@@ -30,10 +30,11 @@ gocd-cli artifact update-store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli artifact](gocd-cli_artifact.md)	 - Command to operate on artifacts store/config present in GoCD
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_auth-config.md b/docs/doc/gocd-cli_auth-config.md
@@ -35,6 +35,7 @@ gocd-cli auth-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -43,4 +44,4 @@ gocd-cli auth-config [flags]
 * [gocd-cli auth-config remove](gocd-cli_auth-config_remove.md)	 - Command to remove the cached GoCD authorization configuration that is used by the cli.
 * [gocd-cli auth-config store](gocd-cli_auth-config_store.md)	 - Command to cache the GoCD authorization configuration to be used by the cli
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_auth-config_remove.md b/docs/doc/gocd-cli_auth-config_remove.md
@@ -30,10 +30,11 @@ gocd-cli auth-config remove [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli auth-config](gocd-cli_auth-config.md)	 - Command to store/remove the authorization configuration to be used by the cli
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_auth-config_store.md b/docs/doc/gocd-cli_auth-config_store.md
@@ -30,10 +30,11 @@ gocd-cli auth-config store [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli auth-config](gocd-cli_auth-config.md)	 - Command to store/remove the authorization configuration to be used by the cli
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup.md b/docs/doc/gocd-cli_backup.md
@@ -37,6 +37,7 @@ gocd-cli backup [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -48,4 +49,4 @@ gocd-cli backup [flags]
 * [gocd-cli backup schedule](gocd-cli_backup_schedule.md)	 - Command to SCHEDULE backups in GoCD [https://api.gocd.org/current/#schedule-backup]
 * [gocd-cli backup stats](gocd-cli_backup_stats.md)	 - Command to GET stats of the specific backup taken in GoCD [https://api.gocd.org/current/#get-backup]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup_create-config.md b/docs/doc/gocd-cli_backup_create-config.md
@@ -32,10 +32,11 @@ gocd-cli backup create-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli backup](gocd-cli_backup.md)	 - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup_delete-config.md b/docs/doc/gocd-cli_backup_delete-config.md
@@ -32,10 +32,11 @@ gocd-cli backup delete-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli backup](gocd-cli_backup.md)	 - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup_get-config.md b/docs/doc/gocd-cli_backup_get-config.md
@@ -32,10 +32,11 @@ gocd-cli backup get-config [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli backup](gocd-cli_backup.md)	 - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup_schedule.md b/docs/doc/gocd-cli_backup_schedule.md
@@ -32,10 +32,11 @@ gocd-cli backup schedule [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli backup](gocd-cli_backup.md)	 - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_backup_stats.md b/docs/doc/gocd-cli_backup_stats.md
@@ -32,10 +32,11 @@ gocd-cli backup stats [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
 
 * [gocd-cli backup](gocd-cli_backup.md)	 - Command to operate on backup in GoCD [https://api.gocd.org/current/#backups]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024
diff --git a/docs/doc/gocd-cli_cluster-profile.md b/docs/doc/gocd-cli_cluster-profile.md
@@ -35,6 +35,7 @@ gocd-cli cluster-profile [flags]
       --to-file string         file to which the output needs to be written
   -u, --username string        username to authenticate with GoCD server
       --yaml                   enable this to Render output in YAML format
+  -y, --yes                    when enabled, end user confirmation would be skipped
 ```
 
 ### SEE ALSO
@@ -47,4 +48,4 @@ gocd-cli cluster-profile [flags]
 * [gocd-cli cluster-profile list](gocd-cli_cluster-profile_list.md)	 - Command to LIST all cluster profiles present in GoCD [https://api.gocd.org/current/#get-all-cluster-profiles]
 * [gocd-cli cluster-profile update](gocd-cli_cluster-profile_update.md)	 - Command to UPDATE a cluster profile with all specified configurations in GoCD [https://api.gocd.org/current/#update-a-cluster-profile]
 
-###### Auto generated by spf13/cobra on 22-Dec-2023
+###### Auto generated by spf13/cobra on 8-Jan-2024