feat: add roles flag to user edit-roles command for passing in roles

brettkolodny · brettkolodny · commit 681ecba2c54e · 2025-04-15T19:30:40.000Z
diff --git a/cli/usereditroles.go b/cli/usereditroles.go
@@ -1,7 +1,9 @@
 package cli
 
 import (
+	"slices"
 	"sort"
+	"strings"
 
 	"golang.org/x/xerrors"
 
@@ -12,9 +14,20 @@ import (
 
 func (r *RootCmd) userEditRoles() *serpent.Command {
 	client := new(codersdk.Client)
+
+	var givenRoles []string
+
 	cmd := &serpent.Command{
-		Use:        "edit-roles <username|user_id>",
-		Short:      "Edit a user's roles by username or id",
+		Use:   "edit-roles <username|user_id>",
+		Short: "Edit a user's roles by username or id",
+		Options: []serpent.Option{
+			cliui.SkipPromptOption(),
+			{
+				Name:        "roles",
+				Description: "A list of roles to give to the user. This removes any existing roles the user may have.",
+				Flag:        "roles",
+				Value:       serpent.StringArrayOf(&givenRoles)},
+		},
 		Middleware: serpent.Chain(serpent.RequireNArgs(1), r.InitClient(client)),
 		Handler: func(inv *serpent.Invocation) error {
 			ctx := inv.Context()
@@ -35,20 +48,41 @@ func (r *RootCmd) userEditRoles() *serpent.Command {
 					siteRoles = append(siteRoles, role.Name)
 				}
 			}
+			sort.Strings(siteRoles)
 
 			userRoles, err := client.UserRoles(ctx, user.Username)
 			if err != nil {
 				return xerrors.Errorf("fetch user roles: %w", err)
 			}
 
-			sort.Strings(siteRoles)
-			selectedRoles, err := cliui.MultiSelect(inv, cliui.MultiSelectOptions{
-				Message:  "Select the roles you'd like to assign to the user",
-				Options:  siteRoles,
-				Defaults: userRoles.Roles,
-			})
-			if err != nil {
-				return xerrors.Errorf("selecting roles for user: %w", err)
+			var selectedRoles []string
+			if len(givenRoles) > 0 {
+				// If the none role is present ignore all other roles.
+				// This is so there is a way to clear roles from the CLI without making a
+				// new command.
+				if slices.Contains(givenRoles, "none") {
+					selectedRoles = []string{}
+				} else {
+					// Make sure all of the given roles are valid site roles
+					for _, givenRole := range givenRoles {
+						if !slices.Contains(siteRoles, givenRole) {
+							siteRolesPretty := strings.Join(siteRoles, ", ")
+							return xerrors.Errorf("The role %s is not valid. Please use one or more of the following roles: %s, or none\n", givenRole, siteRolesPretty)
+						}
+					}
+
+					selectedRoles = givenRoles
+				}
+			} else {
+				selectedRoles, err = cliui.MultiSelect(inv, cliui.MultiSelectOptions{
+					Message:  "Select the roles you'd like to assign to the user",
+					Options:  siteRoles,
+					Defaults: userRoles.Roles,
+				})
+				if err != nil {
+					return xerrors.Errorf("selecting roles for user: %w", err)
+				}
+
 			}
 
 			_, err = client.UpdateUserRoles(ctx, user.Username, codersdk.UpdateRoles{
