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), 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 diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 7260cfe309a2d..ed7d152486bf1 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -33,6 +33,11 @@ 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