Merge pull request #266 from planetscale/jg_help

Rework some of the short help messages
planetscale · May 21, 2021 · 7e38647 · 7e38647
2 parents 1bd7252 + 70023eb
commit 7e38647
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 12 deletions.
diff --git a/internal/cmd/auth/auth.go b/internal/cmd/auth/auth.go
@@ -9,7 +9,7 @@ import (
 func AuthCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "auth <command>",
-		Short: "Login, logout, and refresh your authentication",
+		Short: "Login and logout via the PlanetScale API",
 		Long:  "Manage authentication",
 	}
 

diff --git a/internal/cmd/auth/login.go b/internal/cmd/auth/login.go
@@ -27,7 +27,7 @@ func LoginCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "login",
 		Args:  cobra.ExactArgs(0),
-		Short: "Authenticate with PlanetScale",
+		Short: "Authenticate with the PlanetScale API",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if !printer.IsTTY {
 				return errors.New("The 'login' command requires an interactive shell")

diff --git a/internal/cmd/backup/backup.go b/internal/cmd/backup/backup.go
@@ -16,7 +16,7 @@ import (
 func BackupCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "backup <command>",
-		Short:             "Create, read, destroy, and update branch backups",
+		Short:             "Create, list, show, and delete branch backups",
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}
 

diff --git a/internal/cmd/branch/branch.go b/internal/cmd/branch/branch.go
@@ -13,7 +13,7 @@ import (
 func BranchCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "branch <command>",
-		Short:             "Create, delete, and manage branches",
+		Short:             "Create, delete, diff, and manage branches",
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}
 

diff --git a/internal/cmd/connect/connect.go b/internal/cmd/connect/connect.go
@@ -35,7 +35,7 @@ func ConnectCmd(ch *cmdutil.Helper) *cobra.Command {
 		Use: "connect [database] [branch]",
 		// we only require database, because we deduct branch automatically
 		Args:  cmdutil.RequiredArgs("database"),
-		Short: "Create a secure connection to the given database and branch",
+		Short: "Create a secure connection to a database and branch for a local client",
 		Example: `The connect subcommand establishes a secure connection between your host and PlanetScale. 
 
 By default, if no branch names are given and there is only one branch, it

diff --git a/internal/cmd/database/database.go b/internal/cmd/database/database.go
@@ -14,7 +14,7 @@ import (
 func DatabaseCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "database <command>",
-		Short:             "Create, read, destroy, and update databases",
+		Short:             "Create, read, delete, and dump/restore databases",
 		Aliases:           []string{"db"},
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}

diff --git a/internal/cmd/deployrequest/close.go b/internal/cmd/deployrequest/close.go
@@ -16,7 +16,7 @@ import (
 func CloseCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "close <database> <number>",
-		Short: "Close deploy requests",
+		Short: "Close a deploy request",
 		Args:  cmdutil.RequiredArgs("database", "number"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

diff --git a/internal/cmd/deployrequest/deploy.go b/internal/cmd/deployrequest/deploy.go
@@ -16,7 +16,7 @@ import (
 func DeployCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "deploy <database> <number>",
-		Short: "Deploy a specific deploy request by its number",
+		Short: "Deploy a specific deploy request",
 		Args:  cmdutil.RequiredArgs("database", "number"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()

diff --git a/internal/cmd/deployrequest/dr.go b/internal/cmd/deployrequest/dr.go
@@ -12,7 +12,7 @@ import (
 func DeployRequestCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "deploy-request <command>",
-		Short:             "Create, approve, diff, and manage deploy requests",
+		Short:             "Create, review, diff, and manage deploy requests",
 		Aliases:           []string{"dr"},
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}

diff --git a/internal/cmd/org/org.go b/internal/cmd/org/org.go
@@ -10,7 +10,7 @@ import (
 func OrgCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "org <command>",
-		Short:             "Modify and manage organization options",
+		Short:             "List, show, and switch organizations",
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}
 

diff --git a/internal/cmd/shell/shell.go b/internal/cmd/shell/shell.go
@@ -38,7 +38,7 @@ func ShellCmd(ch *cmdutil.Helper) *cobra.Command {
 		Use: "shell [database] [branch]",
 		// we only require database, because we deduct branch automatically
 		Args:  cmdutil.RequiredArgs("database"),
-		Short: "Open a MySQL shell instance to the given database and branch",
+		Short: "Open a MySQL shell instance to a database and branch",
 		Example: `The shell subcommand opens a secure MySQL shell instance to your database.
 
 It uses the MySQL command-line client ("mysql"), which needs to be installed.

diff --git a/internal/cmd/token/token.go b/internal/cmd/token/token.go
@@ -12,7 +12,7 @@ import (
 func TokenCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "service-token <action>",
-		Short:             "Create, get, and list service tokens",
+		Short:             "Create, list, and manage access for service tokens",
 		PersistentPreRunE: cmdutil.CheckAuthentication(ch.Config),
 	}