From 9ba6e76aa04bdf17dca6732ebe8919cdee98df57 Mon Sep 17 00:00:00 2001 From: Brett Kolodny Date: Wed, 14 May 2025 14:23:58 +0000 Subject: [PATCH 1/4] chore: add documentation to ssh command --- docs/user-guides/workspace-access/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 7260cfe309a2d..935aadacc537c 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -33,6 +33,10 @@ coder ssh my-workspace Or, you can configure plain SSH on your client below. +> **Note:** The `coder ssh` command does not have full parity with the standard +SSH command. For users who need the full functionality of SSH, use the +configuration method below. + ### Configure SSH Coder generates [SSH key pairs](../../admin/security/secrets.md#ssh-keys) for From a07a31f5e52136167d9d3ee81e3cb424b3379fca Mon Sep 17 00:00:00 2001 From: Brett Kolodny Date: Wed, 14 May 2025 15:23:47 +0000 Subject: [PATCH 2/4] chore: add more documentation to ssh command itself --- cli/ssh.go | 1 + 1 file changed, 1 insertion(+) diff --git a/cli/ssh.go b/cli/ssh.go index 7c5bda073f973..ea812082b9882 100644 --- a/cli/ssh.go +++ b/cli/ssh.go @@ -92,6 +92,7 @@ func (r *RootCmd) ssh() *serpent.Command { Annotations: workspaceCommand, Use: "ssh ", Short: "Start a shell into a workspace", + Long: "This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`.", Middleware: serpent.Chain( serpent.RequireNArgs(1), r.InitClient(client), From 4c71932117fe30079445093acc86f1011f4aa780 Mon Sep 17 00:00:00 2001 From: Brett Kolodny Date: Wed, 14 May 2025 15:27:17 +0000 Subject: [PATCH 3/4] chore: make gen --- cli/testdata/coder_ssh_--help.golden | 4 ++++ docs/reference/cli/ssh.md | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden index 1f7122dd655a2..63a944a3fa2ea 100644 --- a/cli/testdata/coder_ssh_--help.golden +++ b/cli/testdata/coder_ssh_--help.golden @@ -5,6 +5,10 @@ USAGE: Start a shell into a workspace + This command does not have full parity with the standard SSH command. For + users who need the full functionality of SSH, create an ssh configuration with + `coder config-ssh`. + OPTIONS: --disable-autostart bool, $CODER_SSH_DISABLE_AUTOSTART (default: false) Disable starting the workspace automatically when connecting via SSH. diff --git a/docs/reference/cli/ssh.md b/docs/reference/cli/ssh.md index c5bae755c8419..959b75de5f89a 100644 --- a/docs/reference/cli/ssh.md +++ b/docs/reference/cli/ssh.md @@ -9,6 +9,12 @@ Start a shell into a workspace coder ssh [flags] ``` +## Description + +```console +This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`. +``` + ## Options ### --stdio From 4caf788a18b4ffb9716eb9004bdc9e31cc25dbcd Mon Sep 17 00:00:00 2001 From: brettkolodny Date: Wed, 14 May 2025 13:53:52 -0400 Subject: [PATCH 4/4] Update docs/user-guides/workspace-access/index.md Co-authored-by: M Atif Ali --- docs/user-guides/workspace-access/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 935aadacc537c..ed7d152486bf1 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -33,9 +33,10 @@ coder ssh my-workspace Or, you can configure plain SSH on your client below. -> **Note:** The `coder ssh` command does not have full parity with the standard -SSH command. For users who need the full functionality of SSH, use the -configuration method below. +> [!Note] +> The `coder ssh` command does not have full parity with the standard +> SSH command. For users who need the full functionality of SSH, use the +> configuration method below. ### Configure SSH