synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add documentation to the coder ssh command regarding feature parity with ssh (#17827)

Browse Source 
Closes
[coder/internal#628](https://github.com/coder/internal/issues/628)

---------

Co-authored-by: M Atif Ali <atif@coder.com>
This commit is contained in:
brettkolodny
2025-05-14 15:42:44 -04:00
committed by GitHub
parent 9093dbc516
commit 73251cf5b2
4 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
cli/ssh.go
View File

@ -92,6 +92,7 @@ func (r *RootCmd) ssh() *serpent.Command {
Annotations: workspaceCommand,
Use: "ssh <workspace>",
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),

4
cli/testdata/coder_ssh_--help.golden vendored
View File

@ -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.

6
docs/reference/cli/ssh.md generated
View File

@ -9,6 +9,12 @@ Start a shell into a workspace
coder ssh [flags] <workspace>
```
## 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

5
docs/user-guides/workspace-access/index.md
View File

@ -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