feat(cli): Add examples to --help output for "gpg_list" (#16017)

* feat: Add examples to --help output for list Signed-off-by: Ratan Gulati <[email protected]> * updated file Signed-off-by: Ratan Gulati <[email protected]> --------- Signed-off-by: Ratan Gulati <[email protected]>
argoproj · Oct 27, 2023 · 9b1fb1d · 9b1fb1d
1 parent 0c91395
commit 9b1fb1d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/cmd/argocd/commands/gpg.go b/cmd/argocd/commands/gpg.go
@@ -43,6 +43,17 @@ func NewGPGListCommand(clientOpts *argocdclient.ClientOptions) *cobra.Command {
 	var command = &cobra.Command{
 		Use:   "list",
 		Short: "List configured GPG public keys",
+		Example: templates.Examples(`
+  # List all configured GPG public keys in wide format (default).
+  argocd gpg list
+		
+  # List all configured GPG public keys in JSON format.
+  argocd gpg list -o json
+		
+  # List all configured GPG public keys in YAML format.
+  argocd gpg list -o yaml
+  		`),
+
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 

diff --git a/docs/user-guide/commands/argocd_gpg_list.md b/docs/user-guide/commands/argocd_gpg_list.md
@@ -8,6 +8,19 @@ List configured GPG public keys
 argocd gpg list [flags]
 ```
 
+### Examples
+
+```
+  # List all configured GPG public keys in wide format (default).
+  argocd gpg list
+  
+  # List all configured GPG public keys in JSON format.
+  argocd gpg list -o json
+  
+  # List all configured GPG public keys in YAML format.
+  argocd gpg list -o yaml
+```
+
 ### Options
 
 ```