coder · DanielleMaywood · Sep 17, 2024 · Sep 13, 2024 · Sep 13, 2024 · Sep 13, 2024
diff --git a/cli/cliui/cliui.go b/cli/cliui/cliui.go
@@ -2,7 +2,9 @@ package cliui
 
 import (
 	"flag"
+	"fmt"
 	"os"
+	"slices"
 	"sync"
 	"time"
 
@@ -12,6 +14,8 @@ import (
 	"github.com/coder/pretty"
 )
 
+const NoColorFlag = "no-color"
+
 var Canceled = xerrors.New("canceled")
 
 // DefaultStyles compose visual elements of the UI.
@@ -37,22 +41,37 @@ var (
 )
 
 var (
-	Green   = Color("#04B575")
-	Red     = Color("#ED567A")
-	Fuchsia = Color("#EE6FF8")
-	Yellow  = Color("#ECFD65")
-	Blue    = Color("#5000ff")
+	// ANSI color codes
+	red           = Color("1")
+	green         = Color("2")
+	yellow        = Color("3")
+	magenta       = Color("5")
+	white         = Color("7")
+	brightBlue    = Color("12")
+	brightMagenta = Color("13")
 )
 
 // Color returns a color for the given string.
 func Color(s string) termenv.Color {
 	colorOnce.Do(func() {
 		color = termenv.NewOutput(os.Stdout).ColorProfile()
+
 		if flag.Lookup("test.v") != nil {
 			// Use a consistent colorless profile in tests so that results
 			// are deterministic.
 			color = termenv.Ascii
 		}
+
+		// Currently it appears there is no way to use the flag from
+		// serpent as it isn't possible to create a root middleware that
+		// runs for every command. For now we just check if `os.Args`
+		// has the flag.
+		if slices.Contains(os.Args, fmt.Sprintf("--%s", NoColorFlag)) ||
+			slices.Contains(os.Args, fmt.Sprintf("--%s=true", NoColorFlag)) ||
+			os.Getenv("CODER_NO_COLOR") != "" ||
+			os.Getenv("NO_COLOR") != "" {
+			color = termenv.Ascii
+		}
 	})
 	return color.Color(s)
 }
@@ -109,11 +128,11 @@ func Field(s string) string {
 	return pretty.Sprint(DefaultStyles.Field, s)
 }
 
-func ifTerm(fmt pretty.Formatter) pretty.Formatter {
+func ifTerm(f pretty.Formatter) pretty.Formatter {
 	if !isTerm() {
 		return pretty.Nop
 	}
-	return fmt
+	return f
 }
 
 func init() {
@@ -123,42 +142,45 @@ func init() {
 	DefaultStyles = Styles{
 		Code: pretty.Style{
 			ifTerm(pretty.XPad(1, 1)),
-			pretty.FgColor(Red),
-			pretty.BgColor(color.Color("#2c2c2c")),
+			pretty.FgColor(color.Color("#ED567A")),
+			pretty.BgColor(color.Color("#2C2C2C")),
 		},
 		DateTimeStamp: pretty.Style{
-			pretty.FgColor(color.Color("#7571F9")),
+			pretty.FgColor(brightBlue),
 		},
 		Error: pretty.Style{
-			pretty.FgColor(Red),
+			pretty.FgColor(red),
 		},
 		Field: pretty.Style{
 			pretty.XPad(1, 1),
 			pretty.FgColor(color.Color("#FFFFFF")),
-			pretty.BgColor(color.Color("#2b2a2a")),
+			pretty.BgColor(color.Color("#2B2A2A")),
+		},
+		Fuchsia: pretty.Style{
+			pretty.FgColor(brightMagenta),
+		},
+		FocusedPrompt: pretty.Style{
+			pretty.FgColor(white),
+			pretty.Wrap("> ", ""),
+			pretty.FgColor(brightBlue),
 		},
 		Keyword: pretty.Style{
-			pretty.FgColor(Green),
+			pretty.FgColor(green),
 		},
 		Placeholder: pretty.Style{
-			pretty.FgColor(color.Color("#4d46b3")),
+			pretty.FgColor(magenta),
 		},
 		Prompt: pretty.Style{
-			pretty.FgColor(color.Color("#5C5C5C")),
-			pretty.Wrap("> ", ""),
+			pretty.FgColor(white),
+			pretty.Wrap("  ", ""),
 		},
 		Warn: pretty.Style{
-			pretty.FgColor(Yellow),
+			pretty.FgColor(yellow),
 		},
 		Wrap: pretty.Style{
 			pretty.LineWrap(80),
 		},
 	}
-
-	DefaultStyles.FocusedPrompt = append(
-		DefaultStyles.Prompt,
-		pretty.FgColor(Blue),
-	)
 }
 
 // ValidateNotEmpty is a helper function to disallow empty inputs!

diff --git a/cli/cliui/select.go b/cli/cliui/select.go
@@ -256,7 +256,7 @@ func (m selectModel) View() string {
 		if m.cursor == start+i {
 			style = pretty.Style{
 				pretty.Wrap("> ", ""),
-				pretty.FgColor(Green),
+				DefaultStyles.Keyword,
 			}
 		}
 
@@ -481,13 +481,13 @@ func (m multiSelectModel) View() string {
 		o := option.option
 
 		if m.cursor == i {
-			cursor = pretty.Sprint(pretty.FgColor(Green), "> ")
-			chosen = pretty.Sprint(pretty.FgColor(Green), "[ ]")
-			o = pretty.Sprint(pretty.FgColor(Green), o)
+			cursor = pretty.Sprint(DefaultStyles.Keyword, "> ")
+			chosen = pretty.Sprint(DefaultStyles.Keyword, "[ ]")
+			o = pretty.Sprint(DefaultStyles.Keyword, o)
 		}
 
 		if option.chosen {
-			chosen = pretty.Sprint(pretty.FgColor(Green), "[x]")
+			chosen = pretty.Sprint(DefaultStyles.Keyword, "[x]")
 		}
 
 		_, _ = s.WriteString(fmt.Sprintf(

diff --git a/cli/root.go b/cli/root.go
@@ -331,6 +331,13 @@ func (r *RootCmd) Command(subcommands []*serpent.Command) (*serpent.Command, err
 		r.clientURL = new(url.URL)
 	}
 
+	// NOTE(Danielle): It appears there is no way to have a 'global' middleware in
+	// 				   serpent so we manually handle the ENV/flag lookup and setup
+	//				   the option in the below OptionSet so it is documented.
+	//                 We use (and discard) this local variable to get the correct
+	//                 behavior from the CLI when the option is passed.
+	var noColorDiscarded bool
+
 	globalGroup := &serpent.Group{
 		Name:        "Global",
 		Description: `Global options are applied to all commands. They can be set using environment variables or flags.`,
@@ -461,6 +468,14 @@ func (r *RootCmd) Command(subcommands []*serpent.Command) (*serpent.Command, err
 			Value:       serpent.StringOf(&r.globalConfig),
 			Group:       globalGroup,
 		},
+		{
+			Flag:        cliui.NoColorFlag,
+			Env:         "CODER_NO_COLOR",
+			Default:     "false",
+			Description: "Disable use of color in CLI output.",
+			Group:       globalGroup,
+			Value:       serpent.BoolOf(&noColorDiscarded),
+		},
 		{
 			Flag: "version",
 			// This was requested by a customer to assist with their migration.

@@ -89,6 +89,9 @@ variables or flags.
           requests. The command must output each header as `key=value` on its
           own line.
 
+      --no-color bool, $CODER_NO_COLOR (default: false)
+          Disable use of color in CLI output.
+
       --no-feature-warning bool, $CODER_NO_FEATURE_WARNING
           Suppress warnings about unlicensed features.
 

@@ -18,6 +18,7 @@ import (
 	"github.com/coder/coder/v2/cli/cliui"
 	"github.com/coder/coder/v2/coderd/database/dbtime"
 	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/pretty"
 	"github.com/coder/serpent"
 )
 
@@ -37,6 +38,53 @@ func main() {
 		},
 	}
 
+	var noColorDiscarded bool
+
+	root.Options = []serpent.Option{
+		{
+			Default: "false",
+			Flag:    cliui.NoColorFlag,
+			Value:   serpent.BoolOf(&noColorDiscarded),
+		},
+	}
+
+	root.Children = append(root.Children, &serpent.Command{
+		Use: "colors",
+		Handler: func(inv *serpent.Invocation) error {
+			msg := pretty.Sprint(cliui.DefaultStyles.Code, "This is a code message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.DateTimeStamp, "This is a datetimestamp message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Error, "This is an error message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Field, "This is a field message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Keyword, "This is a keyword message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Placeholder, "This is a placeholder message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Prompt, "This is a prompt message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.FocusedPrompt, "This is a focused prompt message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Fuchsia, "This is a fuchsia message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			msg = pretty.Sprint(cliui.DefaultStyles.Warn, "This is a warning message")
+			_, _ = fmt.Fprintln(inv.Stdout, msg)
+
+			return nil
+		},
+	})
+
 	root.Children = append(root.Children, &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {

@@ -49,6 +49,9 @@ variables or flags.
           requests. The command must output each header as `key=value` on its
           own line.
 
+      --no-color bool, $CODER_NO_COLOR (default: false)
+          Disable use of color in CLI output.
+
       --no-feature-warning bool, $CODER_NO_FEATURE_WARNING
           Suppress warnings about unlicensed features.