From 4f1e9dae278df000897a2dbb8b1e26b8033a4b13 Mon Sep 17 00:00:00 2001 From: Ketan Gangatirkar <33678+ketang@users.noreply.github.com> Date: Mon, 4 Jul 2022 15:48:08 -0500 Subject: [PATCH] Ketan/cli help tweak (#2803) * fix CLI help text for logout "log out" is verb, "logout" is a noun * add CLI help for port-forward command (#2802) * found another noun where a verb should be --- cli/dotfiles.go | 2 +- cli/logout.go | 2 +- cli/portforward.go | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/cli/dotfiles.go b/cli/dotfiles.go index e0310d3497..79110a3d6e 100644 --- a/cli/dotfiles.go +++ b/cli/dotfiles.go @@ -24,7 +24,7 @@ func dotfiles() *cobra.Command { cmd := &cobra.Command{ Use: "dotfiles [git_repo_url]", Args: cobra.ExactArgs(1), - Short: "Checkout and install a dotfiles repository.", + Short: "Check out and install a dotfiles repository.", Example: "coder dotfiles [-y] git@github.com:example/dotfiles.git", RunE: func(cmd *cobra.Command, args []string) error { var ( diff --git a/cli/logout.go b/cli/logout.go index 90b7f8f3d6..1860d97673 100644 --- a/cli/logout.go +++ b/cli/logout.go @@ -26,7 +26,7 @@ func logout() *cobra.Command { config := createConfig(cmd) _, err = cliui.Prompt(cmd, cliui.PromptOptions{ - Text: "Are you sure you want to logout?", + Text: "Are you sure you want to log out?", IsConfirm: true, Default: "yes", }) diff --git a/cli/portforward.go b/cli/portforward.go index de8f81ea23..bbbda6923d 100644 --- a/cli/portforward.go +++ b/cli/portforward.go @@ -29,6 +29,7 @@ func portForward() *cobra.Command { ) cmd := &cobra.Command{ Use: "port-forward ", + Short: "Forward one or more ports from the local machine to the remote workspace", Aliases: []string{"tunnel"}, Args: cobra.ExactArgs(1), Example: `