Update SSH command format to "workspace.coder"

matifali · matifali · commit 11b59c7e2e9b · 2025-05-28T16:34:45.000Z
Refactor the workspace SSH command syntax across the project to use the
"workspace.coder" format instead of "coder.workspace". This standardizes
the SSH host entries for better consistency and clarity.

- Adjust command strings in configuration, documentation, and UI components
- Ensure alignment between code examples and actual command usage
diff --git a/cli/configssh.go b/cli/configssh.go
@@ -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 \"ssh coder.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
@@ -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
diff --git a/cli/testdata/coder_config-ssh_--help.golden b/cli/testdata/coder_config-ssh_--help.golden
@@ -3,7 +3,7 @@ coder v0.0.0-devel
 USAGE:
   coder config-ssh [flags]
 
-  Add an SSH Host entry for your workspaces "ssh coder.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/admin/networking/index.md b/docs/admin/networking/index.md
@@ -44,7 +44,7 @@ In order for clients to be able to establish direct connections:
   `coder port-forward`). Note that the
   [VSCode extension](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
   and [JetBrains Plugin](https://plugins.jetbrains.com/plugin/19620-coder/), and
-  [`ssh coder.<workspace>`](../../reference/cli/config-ssh.md) all utilize the
+  [`ssh <workspace>.coder`](../../reference/cli/config-ssh.md) all utilize the
   CLI to establish a workspace connection.
 - Either the client or workspace agent are able to discover a reachable
   `ip:port` of their counterpart. If the agent and client are able to
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -1062,7 +1062,7 @@
 						},
 						{
 							"title": "config-ssh",
-							"description": "Add an SSH Host entry for your workspaces \"ssh coder.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
@@ -105,7 +105,7 @@ jobs:
           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
-          ssh coder.test-${{ steps.name.outputs.version_name }} -- make build
+          ssh test-${{ steps.name.outputs.version_name }}.coder -- make build
 
       - name: Delete the test workspace
         if: always()
diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md
@@ -69,11 +69,11 @@ successful, you'll see the following message:
    You should now be able to ssh into your workspace.
    For example, try running:
    
-   $ ssh coder.<workspaceName>
+   $ ssh <workspaceName>.coder
    ```
 
-Your workspace is now accessible via `ssh coder.<workspace_name>`
-(for example, `ssh coder.myEnv` if your workspace is named `myEnv`).
+Your workspace is now accessible via `ssh <workspace_name>.coder`
+(for example, `ssh myEnv.coder` if your workspace is named `myEnv`).
 
 ## Visual Studio Code
 
diff --git a/site/src/modules/resources/AgentRow.tsx b/site/src/modules/resources/AgentRow.tsx
@@ -48,7 +48,7 @@ export interface AgentRowProps {
 	workspace: Workspace;
 	showApps: boolean;
 	showBuiltinApps?: boolean;
-	sshPrefix?: string;
+	sshSuffix?: string;
 	hideSSHButton?: boolean;
 	hideVSCodeDesktopButton?: boolean;
 	serverVersion: string;
@@ -70,7 +70,7 @@ export const AgentRow: FC<AgentRowProps> = ({
 	serverAPIVersion,
 	onUpdateAgent,
 	storybookAgentMetadata,
-	sshPrefix,
+	sshSuffix,
 }) => {
 	// Apps visibility
 	const visibleApps = agent.apps.filter((app) => !app.hidden);
@@ -207,7 +207,7 @@ export const AgentRow: FC<AgentRowProps> = ({
 							<AgentSSHButton
 								workspaceName={workspace.name}
 								agentName={agent.name}
-								sshPrefix={sshPrefix}
+								sshSuffix={sshSuffix}
 							/>
 						)}
 						{proxy.preferredWildcardHostname !== "" &&
diff --git a/site/src/modules/resources/SSHButton/SSHButton.stories.tsx b/site/src/modules/resources/SSHButton/SSHButton.stories.tsx
@@ -16,15 +16,15 @@ export const Closed: Story = {
 	args: {
 		workspaceName: MockWorkspace.name,
 		agentName: MockWorkspaceAgent.name,
-		sshPrefix: "coder.",
+		sshSuffix: "coder",
 	},
 };
 
 export const Opened: Story = {
 	args: {
 		workspaceName: MockWorkspace.name,
 		agentName: MockWorkspaceAgent.name,
-		sshPrefix: "coder.",
+		sshSuffix: "coder",
 	},
 	play: async ({ canvasElement }) => {
 		const canvas = within(canvasElement);
@@ -33,3 +33,11 @@ export const Opened: Story = {
 	},
 	decorators: [withDesktopViewport],
 };
+
+export const WithSuffix: Story = {
+	args: {
+		workspaceName: MockWorkspace.name,
+		agentName: MockWorkspaceAgent.name,
+		sshSuffix: "coder",
+	},
+};
diff --git a/site/src/modules/resources/SSHButton/SSHButton.tsx b/site/src/modules/resources/SSHButton/SSHButton.tsx
@@ -20,13 +20,12 @@ import { docs } from "utils/docs";
 interface AgentSSHButtonProps {
 	workspaceName: string;
 	agentName: string;
-	sshPrefix?: string;
+	sshSuffix?: string;
 }
 
 export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
 	workspaceName,
-	agentName,
-	sshPrefix,
+	sshSuffix,
 }) => {
 	const paper = useClassName(classNames.paper, []);
 
@@ -56,7 +55,7 @@ export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
 						/>
 						<SSHStep
 							helpText="Connect to the agent:"
-							codeExample={`ssh ${sshPrefix}${workspaceName}.${agentName}`}
+							codeExample={`ssh ${workspaceName}.${sshSuffix}`}
 						/>
 					</Stack>
 				</ol>
diff --git a/site/src/pages/WorkspacePage/Workspace.tsx b/site/src/pages/WorkspacePage/Workspace.tsx
@@ -34,7 +34,7 @@ interface WorkspaceProps {
 	hideSSHButton?: boolean;
 	hideVSCodeDesktopButton?: boolean;
 	buildInfo?: TypesGen.BuildInfoResponse;
-	sshPrefix?: string;
+	sshSuffix?: string;
 	buildLogs?: TypesGen.ProvisionerJobLog[];
 	latestVersion?: TypesGen.TemplateVersion;
 	timings?: TypesGen.WorkspaceBuildTimings;
@@ -59,7 +59,7 @@ export const Workspace: FC<WorkspaceProps> = ({
 	hideSSHButton,
 	hideVSCodeDesktopButton,
 	buildInfo,
-	sshPrefix,
+	sshSuffix,
 	template,
 	buildLogs,
 	latestVersion,
@@ -252,7 +252,7 @@ export const Workspace: FC<WorkspaceProps> = ({
 										agent={agent}
 										workspace={workspace}
 										template={template}
-										sshPrefix={sshPrefix}
+										sshSuffix={sshSuffix}
 										showApps={permissions.updateWorkspace}
 										showBuiltinApps={permissions.updateWorkspace}
 										hideSSHButton={hideSSHButton}
diff --git a/site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx b/site/src/pages/WorkspacePage/WorkspaceReadyPage.tsx
@@ -65,8 +65,8 @@ export const WorkspaceReadyPage: FC<WorkspaceReadyPageProps> = ({
 			mutationFn: API.restartWorkspace,
 		});
 
-	// SSH Prefix
-	const sshPrefixQuery = useQuery(deploymentSSHConfig());
+	// SSH Prefix and Suffix
+	const sshConfigQuery = useQuery(deploymentSSHConfig());
 
 	// Favicon
 	const favicon = getFaviconByStatus(workspace.latest_build);
@@ -206,7 +206,7 @@ export const WorkspaceReadyPage: FC<WorkspaceReadyPageProps> = ({
 				hideSSHButton={featureVisibility.browser_only}
 				hideVSCodeDesktopButton={featureVisibility.browser_only}
 				buildInfo={buildInfoQuery.data}
-				sshPrefix={sshPrefixQuery.data?.hostname_prefix}
+				sshSuffix={sshConfigQuery.data?.hostname_suffix}
 				template={template}
 				buildLogs={buildLogs}
 				timings={timingsQuery.data}

Original file line number	Diff line number	Diff line change
`@@ -1062,7 +1062,7 @@`
`1062`	`1062`	`},`
`1063`	`1063`	`{`
`1064`	`1064`	`"title": "config-ssh",`
`1065`		`- "description": "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",`
	`1065`	`+ "description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",`
`1066`	`1066`	`"path": "reference/cli/config-ssh.md"`
`1067`	`1067`	`},`
`1068`	`1068`	`{`