Skip to content

Commit 7bed706

Browse files
authored
improve cli help text (#2034)
fix %s issue and improve help text
1 parent 662939c commit 7bed706

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

cmd/installer/cli/join.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func JoinCmd(ctx context.Context, name string) *cobra.Command {
5353

5454
cmd := &cobra.Command{
5555
Use: "join <url> <token>",
56-
Short: fmt.Sprintf("Join %s", name),
56+
Short: fmt.Sprintf("Join a node to the %s cluster", name),
5757
Args: cobra.ExactArgs(2),
5858
PreRunE: func(cmd *cobra.Command, args []string) error {
5959
if err := preRunJoin(&flags); err != nil {

cmd/installer/cli/reset.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func ResetCmd(ctx context.Context, name string) *cobra.Command {
5050

5151
cmd := &cobra.Command{
5252
Use: "reset",
53-
Short: "Remove %s from the current node",
53+
Short: fmt.Sprintf("Remove %s from the current node", name),
5454
PreRunE: func(cmd *cobra.Command, args []string) error {
5555
if os.Getuid() != 0 {
5656
return fmt.Errorf("reset command must be run as root")

cmd/installer/cli/restore.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ func RestoreCmd(ctx context.Context, name string) *cobra.Command {
9292

9393
cmd := &cobra.Command{
9494
Use: "restore",
95-
Short: fmt.Sprintf("Restore a %s cluster", name),
95+
Short: fmt.Sprintf("Restore %s from a backup", name),
9696
PreRunE: func(cmd *cobra.Command, args []string) error {
9797
if err := preRunInstall(cmd, &flags); err != nil {
9898
return err

cmd/installer/cli/shell.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const welcome = `
3030
func ShellCmd(ctx context.Context, name string) *cobra.Command {
3131
cmd := &cobra.Command{
3232
Use: "shell",
33-
Short: "Start a shell with access to the cluster",
33+
Short: fmt.Sprintf("Start a shell with access to the %s cluster", name),
3434
PreRunE: func(cmd *cobra.Command, args []string) error {
3535
if os.Getuid() != 0 {
3636
return fmt.Errorf("shell command must be run as root")

cmd/installer/cli/supportbundle.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
func SupportBundleCmd(ctx context.Context, name string) *cobra.Command {
2121
cmd := &cobra.Command{
2222
Use: "support-bundle",
23-
Short: "Generate a support bundle for the embedded-cluster",
23+
Short: "Generate a support bundle",
2424
PreRunE: func(cmd *cobra.Command, args []string) error {
2525
if os.Getuid() != 0 {
2626
return fmt.Errorf("support-bundle command must be run as root")

cmd/installer/cli/update.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func UpdateCmd(ctx context.Context, name string) *cobra.Command {
2020

2121
cmd := &cobra.Command{
2222
Use: "update",
23-
Short: fmt.Sprintf("Update %s", name),
23+
Short: fmt.Sprintf("Update %s with a new air gap bundle", name),
2424
PreRunE: func(cmd *cobra.Command, args []string) error {
2525
if os.Getuid() != 0 {
2626
return fmt.Errorf("update command must be run as root")

0 commit comments

Comments
 (0)