feat: add --quiet flag to coder ssh command

blink-so[bot] · kylecarbs · blink-so[bot] · commit 180a9acaf007 · 2025-07-15T18:28:53.000Z
Adds a --quiet (-q) flag to suppress machine setup logs and connection
indicators when connecting to workspaces via SSH. This provides a cleaner
SSH experience for users who don't want to see the startup logs.

Changes:
- Add Quiet field to AgentOptions struct
- Modify Agent() function to skip logging in quiet mode
- Add --quiet flag with -q shorthand to SSH command
- Support CODER_SSH_QUIET environment variable

Co-authored-by: kylecarbs &lt;7122116+kylecarbs@users.noreply.github.com&gt;
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -25,6 +25,7 @@ type AgentOptions struct {
 	Fetch         func(ctx context.Context, agentID uuid.UUID) (codersdk.WorkspaceAgent, error)
 	FetchLogs     func(ctx context.Context, agentID uuid.UUID, after int64, follow bool) (<-chan []codersdk.WorkspaceAgentLog, io.Closer, error)
 	Wait          bool // If true, wait for the agent to be ready (startup script).
+	Quiet         bool // If true, suppress startup logs and connection indicators.
 	DocsURL       string
 }
 
@@ -103,6 +104,18 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
 			return errAgentShuttingDown
 		}
 
+		// In quiet mode, skip all logging and just wait for ready state
+		if opts.Quiet {
+			if agent.Status == codersdk.WorkspaceAgentConnected && agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady {
+				return nil
+			}
+			// Just fetch the next state without showing any output
+			if agent, err = fetch(); err != nil {
+				return xerrors.Errorf("fetch: %w", err)
+			}
+			continue
+		}
+
 		switch agent.Status {
 		case codersdk.WorkspaceAgentConnecting, codersdk.WorkspaceAgentTimeout:
 			// Since we were waiting for the agent to connect, also show
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -74,6 +74,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 		wsPollInterval      time.Duration
 		waitEnum            string
 		noWait              bool
+		quiet               bool
 		logDirPath          string
 		remoteForwards      []string
 		env                 []string
@@ -288,6 +289,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 				Fetch:         client.WorkspaceAgent,
 				FetchLogs:     client.WorkspaceAgentLogsAfter,
 				Wait:          wait,
+				Quiet:         quiet,
 				DocsURL:       appearanceConfig.DocsURL,
 			})
 			if err != nil {
@@ -670,6 +672,13 @@ func (r *RootCmd) ssh() *serpent.Command {
 			Value:       serpent.BoolOf(&noWait),
 			UseInstead:  []serpent.Option{waitOption},
 		},
+		{
+			Flag:        "quiet",
+			FlagShorthand: "q",
+			Env:         "CODER_SSH_QUIET",
+			Description: "Suppress machine setup logs and connection indicators.",
+			Value:       serpent.BoolOf(&quiet),
+		},
 		{
 			Flag:          "log-dir",
 			Description:   "Specify the directory containing SSH diagnostic log files.",
