feat: Add examples to --help output for remaining "argocd account"

Signed-off-by: Michele Caci <michele.caci@gmail.com>
argoproj · Oct 4, 2023 · c0b4019 · c0b4019
1 parent 43fe01a
commit c0b4019
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/cmd/argocd/commands/account.go b/cmd/argocd/commands/account.go
@@ -26,12 +26,26 @@ import (
 	"github.com/argoproj/argo-cd/v2/util/io"
 	"github.com/argoproj/argo-cd/v2/util/localconfig"
 	sessionutil "github.com/argoproj/argo-cd/v2/util/session"
+	"github.com/argoproj/argo-cd/v2/util/templates"
 )
 
 func NewAccountCommand(clientOpts *argocdclient.ClientOptions) *cobra.Command {
 	var command = &cobra.Command{
 		Use:   "account",
 		Short: "Manage account settings",
+		Example: templates.Examples(`
+			# List accounts
+			argocd account list
+
+			# Update the current user's password
+			argocd account update-password
+
+			# Can I sync any app?
+			argocd account can-i sync applications '*'
+
+			# Get User information
+			argocd account get-user-info
+		`),
 		Run: func(c *cobra.Command, args []string) {
 			c.HelpFunc()(c, args)
 			os.Exit(1)
@@ -143,6 +157,13 @@ func NewAccountGetUserInfoCommand(clientOpts *argocdclient.ClientOptions) *cobra
 	var command = &cobra.Command{
 		Use:   "get-user-info",
 		Short: "Get user info",
+		Example: templates.Examples(`
+			# Get User information
+			argocd account get-user-info
+
+			# Get User information in yaml format
+			argocd account get-user-info -o yaml
+		`),
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 

diff --git a/docs/user-guide/commands/argocd_account.md b/docs/user-guide/commands/argocd_account.md
@@ -8,6 +8,22 @@ Manage account settings
 argocd account [flags]
 ```
 
+### Examples
+
+```
+  # List accounts
+  argocd account list
+  
+  # Update the current user's password
+  argocd account update-password
+  
+  # Can I sync any app?
+  argocd account can-i sync applications '*'
+  
+  # Get User information
+  argocd account get-user-info
+```
+
 ### Options
 
 ```

diff --git a/docs/user-guide/commands/argocd_account_get-user-info.md b/docs/user-guide/commands/argocd_account_get-user-info.md
@@ -8,6 +8,16 @@ Get user info
 argocd account get-user-info [flags]
 ```
 
+### Examples
+
+```
+  # Get User information
+  argocd account get-user-info
+  
+  # Get User information in yaml format
+  argocd account get-user-info -o yaml
+```
+
 ### Options
 
 ```