From 6494ac3fbce13fffeee486a8a280cf4e00ac5373 Mon Sep 17 00:00:00 2001 From: phm07 <22707808+phm07@users.noreply.github.com> Date: Thu, 20 Jun 2024 12:46:16 +0200 Subject: [PATCH] docs(server): update ssh command usage string (#787) The current usage string creates confusion about whether it is possible to pass flags to the ssh binary or not (See #782). The new usage strings explicitly states that this is possible. It also states that it is possible to use a double dash (`--`) to separate hcloud flags from ssh flags. --- internal/cmd/server/ssh.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cmd/server/ssh.go b/internal/cmd/server/ssh.go index ce4085cc..eb8f8660 100644 --- a/internal/cmd/server/ssh.go +++ b/internal/cmd/server/ssh.go @@ -21,7 +21,7 @@ var SSHPath = "ssh" var SSHCmd = base.Cmd{ BaseCobraCommand: func(client hcapi2.Client) *cobra.Command { cmd := &cobra.Command{ - Use: "ssh [options] [command...]", + Use: "ssh [options] [--] [ssh options] [command [argument...]]", Short: "Spawn an SSH connection for the server", Args: util.ValidateLenient, ValidArgsFunction: cmpl.SuggestArgs(cmpl.SuggestCandidatesF(client.Server().Names)),