Skip to content

Commit

Permalink
docs(server): update ssh command usage string (#787)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
phm07 committed Jun 20, 2024
1 parent b4df982 commit 6494ac3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion internal/cmd/server/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var SSHPath = "ssh"
var SSHCmd = base.Cmd{
BaseCobraCommand: func(client hcapi2.Client) *cobra.Command {
cmd := &cobra.Command{
Use: "ssh [options] <server> [command...]",
Use: "ssh [options] <server> [--] [ssh options] [command [argument...]]",
Short: "Spawn an SSH connection for the server",
Args: util.ValidateLenient,
ValidArgsFunction: cmpl.SuggestArgs(cmpl.SuggestCandidatesF(client.Server().Names)),
Expand Down

0 comments on commit 6494ac3

Please sign in to comment.