feat: add --quiet flag to coder ssh command #18883
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![blink-so[bot]](https://avatars.githubusercontent.com/in/1271127?s=60&v=4){kind=small}
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 <7122116+kylecarbs@users.noreply.github.com>
Fix Go formatting for the quiet flag to match existing code style. Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Generate updated CLI documentation that includes the new --quiet flag for the SSH command. Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Run markdownlint and markdown-table-formatter to fix formatting issues in the generated CLI documentation. Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds a --quiet flag to the coder ssh command to suppress machine setup logs and connection indicators when connecting to workspaces via SSH.
- Adds quiet mode support to the Agent function in cliui package
- Implements
--quietflag with-qshorthand andCODER_SSH_QUIETenvironment variable in SSH command - Updates documentation to reflect the new flag functionality
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| cli/cliui/agent.go | Adds Quiet field to AgentOptions struct and implements quiet mode logic to skip all logging |
| cli/ssh.go | Adds --quiet flag, environment variable support, and passes quiet option to agent |
| docs/reference/cli/ssh.md | Documents the new --quiet flag with usage information |
| docs/manifest.json | Formatting changes to JSON structure (unrelated to quiet flag functionality) |
| } | ||
| "versions": [ | ||
| "main" | ||
| ], |
There was a problem hiding this comment.
The formatting changes in this file appear unrelated to the quiet flag feature. Consider separating formatting changes from functional changes in different commits or PRs.
Copilot uses AI. Check for mistakes.
| @@ -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 { | |||
There was a problem hiding this comment.
The quiet mode logic duplicates the ready state check that exists later in the function. Consider extracting this condition into a helper function or variable to avoid duplication.
Suggested change
| if agent.Status == codersdk.WorkspaceAgentConnected && agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady { | |
| if isAgentReady(agent) { |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a
--quiet(-q) flag to suppress machine setup logs and connection indicators when connecting to workspaces via SSH.Changes
Quietfield toAgentOptionsstruct incli/cliui/agent.goAgent()function to skip all logging when quiet mode is enabled--quietflag with-qshorthand to SSH commandCODER_SSH_QUIETenvironment variableUsage
Testing
coder ssh --help