Commit73251cf

and

authored

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

Closes[coder/internal#628](coder/internal#628)---------Co-authored-by: M Atif Ali <atif@coder.com>

1 parent9093dbc commit73251cfCopy full SHA for 73251cf

File tree

+16

-0

lines changed

+16

-0

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@ func (r RootCmd) ssh() serpent.Command {`
`92`	`92`	`Annotations:workspaceCommand,`
`93`	`93`	`Use:"ssh <workspace>",`
`94`	`94`	`Short:"Start a shell into a workspace",`
	`95`	+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`.",
`95`	`96`	`Middleware:serpent.Chain(`
`96`	`97`	`serpent.RequireNArgs(1),`
`97`	`98`	`r.InitClient(client),`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,10 @@ USAGE:`
`5`	`5`
`6`	`6`	`Start a shell into a workspace`
`7`	`7`
	`8`	`+ This command does not have full parity with the standard SSH command. For`
	`9`	`+ users who need the full functionality of SSH, create an ssh configuration with`
	`10`	+ `coder config-ssh`.
	`11`	`+`
`8`	`12`	`OPTIONS:`
`9`	`13`	`--disable-autostart bool, $CODER_SSH_DISABLE_AUTOSTART (default: false)`
`10`	`14`	`Disable starting the workspace automatically when connecting via SSH.`

Lines changed: 6 additions & 0 deletions

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,11 @@ coder ssh my-workspace`
`33`	`33`
`34`	`34`	`Or, you can configure plain SSH on your client below.`
`35`	`35`
	`36`	`+>[!Note]`
	`37`	+>The`coder ssh` command does not have full parity with the standard
	`38`	`+>SSH command. For users who need the full functionality of SSH, use the`
	`39`	`+>configuration method below.`
	`40`	`+`
`36`	`41`	`###Configure SSH`
`37`	`42`
`38`	`43`	`Coder generates[SSH key pairs](../../admin/security/secrets.md#ssh-keys) for`

Comments

(0)