diff --git a/commands/accounts/create.go b/commands/accounts/create.go index 6502c6119..cfc76f8db 100644 --- a/commands/accounts/create.go +++ b/commands/accounts/create.go @@ -37,6 +37,8 @@ func NewCreateCmd(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ Use: "create", Example: "everestctl accounts create --username user1 --password $USER_PASS", + Short: "Create a new Everest user account", + Long: "Create a new Everest user account", Run: func(cmd *cobra.Command, args []string) { //nolint:revive initCreateViperFlags(cmd) diff --git a/commands/accounts/delete.go b/commands/accounts/delete.go index 717f3fe16..dfdf5c5df 100644 --- a/commands/accounts/delete.go +++ b/commands/accounts/delete.go @@ -35,6 +35,8 @@ func NewDeleteCmd(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ Use: "delete", Example: "everestctl accounts delete --username user1", + Short: "Delete an existing Everest user account", + Long: "Delete an existing Everest user account", Run: func(cmd *cobra.Command, args []string) { //nolint:revive initDeleteViperFlags(cmd) diff --git a/commands/accounts/initial_admin_password.go b/commands/accounts/initial_admin_password.go index 67fdf4b95..87a455796 100644 --- a/commands/accounts/initial_admin_password.go +++ b/commands/accounts/initial_admin_password.go @@ -22,6 +22,7 @@ func NewInitialAdminPasswdCommand(l *zap.SugaredLogger) *cobra.Command { Use: "initial-admin-password", Example: "everestctl accounts initial-admin-password", Long: "Get the initial admin password for Everest", + Short: "Get the initial admin password for Everest", Run: func(cmd *cobra.Command, args []string) { //nolint:revive viper.BindEnv("kubeconfig") //nolint:errcheck,gosec viper.BindPFlag("kubeconfig", cmd.Flags().Lookup("kubeconfig")) //nolint:errcheck,gosec diff --git a/commands/accounts/list.go b/commands/accounts/list.go index 8620d6731..c1ed09e04 100644 --- a/commands/accounts/list.go +++ b/commands/accounts/list.go @@ -35,6 +35,8 @@ func NewListCmd(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ Use: "list", Example: "everestctl accounts list", + Long: "List all Everest user accounts", + Short: "List all Everest user accounts", Run: func(cmd *cobra.Command, args []string) { //nolint:revive initListViperFlags(cmd) o := &accountscli.ListOptions{} diff --git a/commands/accounts/reset_jwt_keys.go b/commands/accounts/reset_jwt_keys.go index 7ba575320..34fd7791f 100644 --- a/commands/accounts/reset_jwt_keys.go +++ b/commands/accounts/reset_jwt_keys.go @@ -20,6 +20,7 @@ func NewResetJWTKeysCommand(l *zap.SugaredLogger) *cobra.Command { Use: "reset-jwt-keys", Example: "everestctl accounts reset-jwt-keys", Long: "Reset the JWT keys used for Everest user authentication", + Short: "Reset the JWT keys used for Everest user authentication", Run: func(cmd *cobra.Command, args []string) { //nolint:revive viper.BindEnv("kubeconfig") //nolint:errcheck,gosec viper.BindPFlag("kubeconfig", cmd.Flags().Lookup("kubeconfig")) //nolint:errcheck,gosec diff --git a/commands/accounts/set_password.go b/commands/accounts/set_password.go index 3272fc5f0..0e0ee814b 100644 --- a/commands/accounts/set_password.go +++ b/commands/accounts/set_password.go @@ -22,6 +22,8 @@ func NewSetPwCommand(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ Use: "set-password", Example: "everestctl accounts set-password --username user1 --new-password $USER_PASS", + Long: "Set a new password for an existing Everest user account", + Short: "Set a new password for an existing Everest user account", Run: func(cmd *cobra.Command, args []string) { //nolint:revive initSetPwViperFlags(cmd) diff --git a/commands/settings/oidc.go b/commands/settings/oidc.go index dbd275a8b..f47eddfab 100644 --- a/commands/settings/oidc.go +++ b/commands/settings/oidc.go @@ -27,7 +27,7 @@ import ( func NewOIDCCmd(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ Use: "oidc", - Long: "Configure OIDC settings", + Long: "Manage settings related to OIDC", } cmd.AddCommand(oidc.NewConfigureCommand(l)) diff --git a/commands/settings/oidc/configure.go b/commands/settings/oidc/configure.go index fc0d9d9b2..6fb9cc81b 100644 --- a/commands/settings/oidc/configure.go +++ b/commands/settings/oidc/configure.go @@ -30,7 +30,9 @@ import ( // NewConfigureCommand returns the command to configure OIDC. func NewConfigureCommand(l *zap.SugaredLogger) *cobra.Command { cmd := &cobra.Command{ - Use: "configure", + Use: "configure", + Long: "Configure OIDC settings", + Short: "Configure OIDC settings", Run: func(cmd *cobra.Command, args []string) { //nolint:revive initOIDCViperFlags(cmd) c, err := parseOIDCConfig()