feat(cli): Add example to argocd relogin command (argoproj#15839)

* feat: Add example to argocd relogin command Signed-off-by: Chiranjeevi R <[email protected]> * feat: Add example to argocd relogin command Signed-off-by: Chiranjeevi R <[email protected]> * correc --sso flag Signed-off-by: Chiranjeevi R <[email protected]> * Apply suggestions from code review Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Chiranjeevi R <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]> Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: Ratan Gulati <[email protected]>
Ratangulati · Oct 8, 2023 · 12de0cf · 12de0cf
1 parent 6c8bd78
commit 12de0cf
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/cmd/argocd/commands/relogin.go b/cmd/argocd/commands/relogin.go
@@ -24,10 +24,9 @@ func NewReloginCommand(globalClientOpts *argocdclient.ClientOptions) *cobra.Comm
 		ssoPort  int
 	)
 	var command = &cobra.Command{
-		Use:     "relogin",
-		Short:   "Refresh an expired authenticate token",
-		Long:    "Refresh an expired authenticate token",
-		Example: "argocd relogin --password YOUR_PASSWORD",
+		Use:   "relogin",
+		Short: "Refresh an expired authenticate token",
+		Long:  "Refresh an expired authenticate token",
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 
@@ -85,6 +84,18 @@ func NewReloginCommand(globalClientOpts *argocdclient.ClientOptions) *cobra.Comm
 			errors.CheckError(err)
 			fmt.Printf("Context '%s' updated\n", localCfg.CurrentContext)
 		},
+		Example: `  
+# Reinitiates the login with previous contexts
+argocd relogin
+
+# Reinitiates the login with password
+argocd relogin --password YOUR_PASSWORD
+
+# Configure direct access using Kubernetes API server
+argocd login cd.argoproj.io --core
+
+# If user logged in with - "argocd login cd.argoproj.io" with sso login
+# The command - "argocd relogin" will Reinitiates SSO login and updates the server context`,
 	}
 	command.Flags().StringVar(&password, "password", "", "The password of an account to authenticate")
 	command.Flags().IntVar(&ssoPort, "sso-port", DefaultSSOLocalPort, "Port to run local OAuth2 login application")

diff --git a/docs/user-guide/commands/argocd_relogin.md b/docs/user-guide/commands/argocd_relogin.md
@@ -15,7 +15,18 @@ argocd relogin [flags]
 ### Examples
 
 ```
+  
+# Reinitiates the login with previous contexts
+argocd relogin
+
+# Reinitiates the login with password
 argocd relogin --password YOUR_PASSWORD
+
+# Configure direct access using Kubernetes API server
+argocd login cd.argoproj.io --core
+
+# If user logged in with - "argocd login cd.argoproj.io" with sso login
+# The command - "argocd relogin" will Reinitiates SSO login and updates the server context
 ```
 
 ### Options