Jun 3, 2025 · May 30, 2025
diff --git a/cli/configssh.go b/cli/configssh.go
 cmd := &serpent.Command{
 Annotations: workspaceCommand,
 Use:         "config-ssh",
 Short:       "Add an SSH Host entry for your workspaces \"sshcoder.workspace\"",
 Short:       "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
 Long: FormatExamples(
 Example{
 Description: "You can use -o (or --ssh-option) so set SSH options to be used for all your workspaces",
diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
    completion        Install or update shell completion scripts for the
                      detected or chosen shell.
    config-ssh        Add an SSH Host entry for your workspaces "ssh
 coder.workspace"
                      workspace.coder"
    create            Create a workspace
    delete            Delete a workspace
    dotfiles          Personalize your workspace by applying a canonical
diff --git a/cli/testdata/coder_config-ssh_--help.golden b/cli/testdata/coder_config-ssh_--help.golden
 USAGE:
  coder config-ssh [flags]

  Add an SSH Host entry for your workspaces "sshcoder.workspace"
  Add an SSH Host entry for your workspaces "ssh workspace.coder"

    - You can use -o (or --ssh-option) so set SSH options to be used for all
  your
diff --git a/docs/manifest.json b/docs/manifest.json
 },
 {
 "title": "config-ssh",
 "description": "Add an SSH Host entry for your workspaces \"sshcoder.workspace\"",
 "description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
 "path": "reference/cli/config-ssh.md"
 },
 {
diff --git a/docs/reference/cli/config-ssh.md b/docs/reference/cli/config-ssh.md
diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md
diff --git a/docs/tutorials/testing-templates.md b/docs/tutorials/testing-templates.md
      - name: Create a test workspace and run some example commands
        run: |
          coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} test-${{ steps.name.outputs.version_name }} --yes
          coder config-ssh --yes
          # run some example commands
          sshcoder.test-${{ steps.name.outputs.version_name }} -- make build
 coderssh test-${{ steps.name.outputs.version_name }} -- make build

      - name: Delete the test workspace
        if: always()
diff --git a/site/src/modules/resources/AgentRow.tsx b/site/src/modules/resources/AgentRow.tsx
 <AgentSSHButton
 workspaceName={workspace.name}
 agentName={agent.name}
 workspaceOwnerUsername={workspace.owner_name}
 />
 )}
 {proxy.preferredWildcardHostname !== "" &&
diff --git a/site/src/modules/resources/SSHButton/SSHButton.tsx b/site/src/modules/resources/SSHButton/SSHButton.tsx
 interface AgentSSHButtonProps {
 workspaceName: string;
 agentName: string;
 workspaceOwnerUsername: string;
 }

 export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
 workspaceName,
 agentName,
 workspaceOwnerUsername,
 }) => {
 const paper = useClassName(classNames.paper, []);
 const { data } = useQuery(deploymentSSHConfig());
 constsshPrefix = data?.hostname_prefix;
 constsshSuffix = data?.hostname_suffix;

 return (
 <Popover>
 />
 <SSHStep
 helpText="Connect to the agent:"
 codeExample={`ssh ${sshPrefix}${workspaceName}.${agentName}`}
 codeExample={`ssh ${workspaceName}.${agentName}.${workspaceOwnerUsername}.${sshSuffix}`}
 />
 </Stack>
 </ol>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -235,7 +235,7 @@ func (r RootCmd) configSSH() serpent.Command {
		cmd := &serpent.Command{
		Annotations: workspaceCommand,
		Use: "config-ssh",
		Short: "Add an SSH Host entry for your workspaces \"sshcoder.workspace\"",
		Short: "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
		Long: FormatExamples(
		Example{
		Description: "You can use -o (or --ssh-option) so set SSH options to be used for all your workspaces",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,7 +18,7 @@ SUBCOMMANDS:
		completion Install or update shell completion scripts for the
		detected or chosen shell.
		config-ssh Add an SSH Host entry for your workspaces "ssh
		coder.workspace"
		workspace.coder"
		create Create a workspace
		delete Delete a workspace
		dotfiles Personalize your workspace by applying a canonical
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,7 +3,7 @@ coder v0.0.0-devel
		USAGE:
		coder config-ssh [flags]

		Add an SSH Host entry for your workspaces "sshcoder.workspace"
		Add an SSH Host entry for your workspaces "ssh workspace.coder"

		- You can use -o (or --ssh-option) so set SSH options to be used for all
		your
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1091,7 +1091,7 @@
		},
		{
		"title": "config-ssh",
		"description": "Add an SSH Host entry for your workspaces \"sshcoder.workspace\"",
		"description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
		"path": "reference/cli/config-ssh.md"
		},
		{
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -103,9 +103,8 @@ jobs:
		- name: Create a test workspace and run some example commands
		run: \|
		coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} test-${{ steps.name.outputs.version_name }} --yes
		coder config-ssh --yes
		# run some example commands
		sshcoder.test-${{ steps.name.outputs.version_name }} -- make build
		coderssh test-${{ steps.name.outputs.version_name }} -- make build

		- name: Delete the test workspace
		if: always()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -196,6 +196,7 @@ export const AgentRow: FC<AgentRowProps> = ({
		<AgentSSHButton
		workspaceName={workspace.name}
		agentName={agent.name}
		workspaceOwnerUsername={workspace.owner_name}
		/>
		)}
		{proxy.preferredWildcardHostname !== "" &&
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,15 +22,17 @@ import { docs } from "utils/docs";
		interface AgentSSHButtonProps {
		workspaceName: string;
		agentName: string;
		workspaceOwnerUsername: string;
		}

		export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
		workspaceName,
		agentName,
		workspaceOwnerUsername,
		}) => {
		const paper = useClassName(classNames.paper, []);
		const { data } = useQuery(deploymentSSHConfig());
		constsshPrefix = data?.hostname_prefix;
		constsshSuffix = data?.hostname_suffix;

		return (
		<Popover>
Expand DownExpand Up		@@ -58,7 +60,7 @@ export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
		/>
		<SSHStep
		helpText="Connect to the agent:"
		codeExample={`ssh ${sshPrefix}${workspaceName}.${agentName}`}
		codeExample={`ssh ${workspaceName}.${agentName}.${workspaceOwnerUsername}.${sshSuffix}`}
		/>
		</Stack>
		</ol>
Expand Down