diff --git a/cmd/ghcs/code.go b/cmd/ghcs/code.go index 1080fd896..ccb4788ee 100644 --- a/cmd/ghcs/code.go +++ b/cmd/ghcs/code.go @@ -15,8 +15,7 @@ import ( func NewCodeCmd() *cobra.Command { return &cobra.Command{ Use: "code", - Short: "code", - Long: "code", + Short: "Open a GitHub Codespace in VSCode.", RunE: func(cmd *cobra.Command, args []string) error { var codespaceName string if len(args) > 0 { diff --git a/cmd/ghcs/create.go b/cmd/ghcs/create.go index b23e5631b..385e5d957 100644 --- a/cmd/ghcs/create.go +++ b/cmd/ghcs/create.go @@ -17,9 +17,7 @@ var repo, branch, machine string func newCreateCmd() *cobra.Command { createCmd := &cobra.Command{ Use: "create", - Short: "Create a codespace", - Long: `Create a codespace for a given repository and branch. -You must also choose the type of machine to use.`, + Short: "Create a GitHub Codespace.", RunE: func(cmd *cobra.Command, args []string) error { return Create() }, diff --git a/cmd/ghcs/delete.go b/cmd/ghcs/delete.go index a24374a4c..0f274e987 100644 --- a/cmd/ghcs/delete.go +++ b/cmd/ghcs/delete.go @@ -13,8 +13,7 @@ import ( func NewDeleteCmd() *cobra.Command { deleteCmd := &cobra.Command{ Use: "delete CODESPACE_NAME", - Short: "delete", - Long: "delete", + Short: "Delete a GitHub Codespace.", RunE: func(cmd *cobra.Command, args []string) error { if len(args) == 0 { return errors.New("A Codespace name is required.") diff --git a/cmd/ghcs/list.go b/cmd/ghcs/list.go index e02e6a1d2..6db79af97 100644 --- a/cmd/ghcs/list.go +++ b/cmd/ghcs/list.go @@ -14,8 +14,7 @@ import ( func NewListCmd() *cobra.Command { listCmd := &cobra.Command{ Use: "list", - Short: "list", - Long: "list", + Short: "List GitHub Codespaces you have on your account.", RunE: func(cmd *cobra.Command, args []string) error { return List() }, diff --git a/cmd/ghcs/main.go b/cmd/ghcs/main.go index 696975ab5..a89a544b4 100644 --- a/cmd/ghcs/main.go +++ b/cmd/ghcs/main.go @@ -13,8 +13,8 @@ func main() { var rootCmd = &cobra.Command{ Use: "ghcs", - Short: "Codespaces", - Long: "Codespaces", + Short: "Unofficial GitHub Codespaces CLI.", + Long: "Unofficial CLI tool to manage and interact with GitHub Codespaces.", Version: "0.6.0", } diff --git a/cmd/ghcs/ports.go b/cmd/ghcs/ports.go index d5b863c82..6d2086088 100644 --- a/cmd/ghcs/ports.go +++ b/cmd/ghcs/ports.go @@ -20,8 +20,7 @@ import ( func NewPortsCmd() *cobra.Command { portsCmd := &cobra.Command{ Use: "ports", - Short: "ports", - Long: "ports", + Short: "Forward ports from a GitHub Codespace.", RunE: func(cmd *cobra.Command, args []string) error { return Ports() }, diff --git a/cmd/ghcs/ssh.go b/cmd/ghcs/ssh.go index 6c4385aaf..89aa77c1b 100644 --- a/cmd/ghcs/ssh.go +++ b/cmd/ghcs/ssh.go @@ -23,8 +23,7 @@ func NewSSHCmd() *cobra.Command { sshCmd := &cobra.Command{ Use: "ssh", - Short: "ssh", - Long: "ssh", + Short: "SSH into a GitHub Codespace, for use with running tests/editing in vim, etc.", RunE: func(cmd *cobra.Command, args []string) error { return SSH(sshProfile, sshServerPort) },