Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 14, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ba6e76
chore: add documentation to ssh command
brettkolodny May 14, 2025
a07a31f
chore: add more documentation to ssh command itself
brettkolodny May 14, 2025
4c71932
chore: make gen
brettkolodny May 14, 2025
4caf788
Update docs/user-guides/workspace-access/index.md
brettkolodny May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cli/ssh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
4 changes: 4 additions & 0 deletions cli/testdata/coder_ssh_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cli/ssh.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions docs/user-guides/workspace-access/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading