Skip to content

Commit 90e6cbb

Browse files
0405ysj0405ysj
committed
Make cvdr help message clear
1 parent 4e171cb commit 90e6cbb

1 file changed

Lines changed: 24 additions & 26 deletions

File tree

‎pkg/cli/cli.go‎

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,6 @@ const (
128128
)
129129

130130
const (
131-
ConnectCommandName = "connect"
132-
DisconnectCommandName = "disconnect"
133131
ConnectionWebRTCAgentCommandName = "webrtc"
134132
ConnectionWebSocketAgentCommandName = "websocket"
135133
)
@@ -446,7 +444,7 @@ func NewCVDRemoteCommand(o *CommandOptions) *CVDRemoteCommand {
446444
flags := &ServiceFlags{RootFlags: &RootFlags{}}
447445
rootCmd := &cobra.Command{
448446
Use: "cvdr",
449-
Short: "Manages Cuttlefish Virtual Devices (CVDs) in the cloud.",
447+
Short: "Manage Cuttlefish Virtual Devices (CVDs) remotely.",
450448
SilenceUsage: true,
451449
SilenceErrors: true,
452450
CompletionOptions: cobra.CompletionOptions{DisableDefaultCmd: true},
@@ -513,7 +511,7 @@ func (c *CVDRemoteCommand) Execute() error {
513511
func hostCommand(opts *subCommandOpts) *cobra.Command {
514512
host := &cobra.Command{
515513
Use: "host",
516-
Short: "Work with hosts",
514+
Short: "Manage hosts",
517515
}
518516
host.AddCommand(hostCreateCommand(opts))
519517
host.AddCommand(hostListCommand(opts))
@@ -526,7 +524,7 @@ func hostCreateCommand(opts *subCommandOpts) *cobra.Command {
526524
createFlags := &CreateHostFlags{ServiceFlags: opts.ServiceFlags, CreateHostOpts: &CreateHostOpts{}}
527525
create := &cobra.Command{
528526
Use: "create",
529-
Short: "Creates a host.",
527+
Short: "Create a host",
530528
PreRunE: preRunE(createFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
531529
RunE: func(c *cobra.Command, args []string) error {
532530
configs, err := parseAcceleratorFlag(acceleratorFlagValues)
@@ -551,7 +549,7 @@ func hostCreateCommand(opts *subCommandOpts) *cobra.Command {
551549
func hostListCommand(opts *subCommandOpts) *cobra.Command {
552550
list := &cobra.Command{
553551
Use: "list",
554-
Short: "Lists hosts.",
552+
Short: "List hosts",
555553
PreRunE: preRunE(opts.ServiceFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
556554
RunE: func(c *cobra.Command, args []string) error {
557555
return runListHostCommand(c, opts.ServiceFlags, opts)
@@ -562,8 +560,8 @@ func hostListCommand(opts *subCommandOpts) *cobra.Command {
562560

563561
func hostDeleteCommand(opts *subCommandOpts) *cobra.Command {
564562
del := &cobra.Command{
565-
Use: "delete <foo> <bar> <baz>",
566-
Short: "Delete hosts.",
563+
Use: "delete [HOST...]",
564+
Short: "Delete hosts",
567565
PreRunE: preRunE(opts.ServiceFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
568566
RunE: func(c *cobra.Command, args []string) error {
569567
return runDeleteHostsCommand(c, args, opts.ServiceFlags, opts)
@@ -594,7 +592,7 @@ func createCommand(opts *subCommandOpts) *cobra.Command {
594592
}
595593
create := &cobra.Command{
596594
Use: "create [config.json]",
597-
Short: "Creates a CVD",
595+
Short: "Create a CVD group with CVD instances",
598596
PreRunE: preRunE(createFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
599597
RunE: func(c *cobra.Command, args []string) error {
600598
configs, err := parseAcceleratorFlag(gcpAcceleratorFlagValues)
@@ -705,7 +703,7 @@ func listCommand(opts *subCommandOpts) *cobra.Command {
705703
listFlags := &ListCVDsFlags{ServiceFlags: opts.ServiceFlags}
706704
list := &cobra.Command{
707705
Use: "list",
708-
Short: "List CVDs",
706+
Short: "List CVD groups and their instances",
709707
PreRunE: preRunE(listFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
710708
RunE: func(c *cobra.Command, args []string) error {
711709
return runListCVDsCommand(c, listFlags, opts)
@@ -719,7 +717,7 @@ func bugreportCommand(opts *subCommandOpts) *cobra.Command {
719717
brFlags := &BugreportFlags{ServiceFlags: opts.ServiceFlags}
720718
br := &cobra.Command{
721719
Use: "bugreport [--host HOST [--group GROUP]]",
722-
Short: "Pull cvd runtime artifacts",
720+
Short: "Pull runtime artifacts of a CVD group",
723721
PreRunE: preRunE(opts.ServiceFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
724722
RunE: func(c *cobra.Command, args []string) error {
725723
return runBugreportCommand(c, brFlags, opts)
@@ -733,8 +731,8 @@ func bugreportCommand(opts *subCommandOpts) *cobra.Command {
733731
func deleteCommand(opts *subCommandOpts) *cobra.Command {
734732
delFlags := &DeleteCVDFlags{ServiceFlags: opts.ServiceFlags}
735733
del := &cobra.Command{
736-
Use: "delete [--host=HOST] [id]",
737-
Short: "Deletes cvd instance",
734+
Use: "delete --host=HOST GROUP",
735+
Short: "Delete a CVD group",
738736
PreRunE: preRunE(delFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
739737
RunE: func(c *cobra.Command, args []string) error {
740738
return runDeleteCVDCommand(c, args, delFlags, opts)
@@ -748,8 +746,8 @@ func deleteCommand(opts *subCommandOpts) *cobra.Command {
748746
func stopCommand(opts *subCommandOpts) *cobra.Command {
749747
stopFlags := &StopCVDFlags{ServiceFlags: opts.ServiceFlags}
750748
stop := &cobra.Command{
751-
Use: "stop --host=HOST --group=GROUP --name=NAME",
752-
Short: "Stops a running instance",
749+
Use: "stop --host=HOST --group=GROUP --name=INSTANCE",
750+
Short: "Stop a running CVD instance",
753751
PreRunE: preRunE(stopFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
754752
RunE: func(c *cobra.Command, args []string) error {
755753
return runStopCVDCommand(c, args, stopFlags, opts)
@@ -767,8 +765,8 @@ func stopCommand(opts *subCommandOpts) *cobra.Command {
767765
func startCommand(opts *subCommandOpts) *cobra.Command {
768766
startFlags := &StartCVDFlags{ServiceFlags: opts.ServiceFlags}
769767
start := &cobra.Command{
770-
Use: "start --host=HOST --group=GROUP --name=NAME",
771-
Short: "Start a stopped instance",
768+
Use: "start --host=HOST --group=GROUP --name=INSTANCE",
769+
Short: "Start a stopped CVD instance",
772770
PreRunE: preRunE(startFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
773771
RunE: func(c *cobra.Command, args []string) error {
774772
return runStartCVDCommand(c, args, startFlags, opts)
@@ -787,8 +785,8 @@ func startCommand(opts *subCommandOpts) *cobra.Command {
787785
func snapshotCommand(opts *subCommandOpts) *cobra.Command {
788786
snapshotFlags := &SnapshotCVDFlags{ServiceFlags: opts.ServiceFlags}
789787
snapshot := &cobra.Command{
790-
Use: "snapshot --host=HOST --group=GROUP --name=NAME",
791-
Short: "Snapshot a device",
788+
Use: "snapshot --host=HOST --group=GROUP --name=INSTANCE",
789+
Short: "Snapshot a CVD instance",
792790
PreRunE: preRunE(snapshotFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
793791
RunE: func(c *cobra.Command, args []string) error {
794792
return runSnapshotCVDCommand(c, args, snapshotFlags, opts)
@@ -806,8 +804,8 @@ func snapshotCommand(opts *subCommandOpts) *cobra.Command {
806804
func resetCommand(opts *subCommandOpts) *cobra.Command {
807805
resetFlags := &ResetHostFlags{ServiceFlags: opts.ServiceFlags}
808806
reset := &cobra.Command{
809-
Use: "reset --host=HOST [-y]",
810-
Short: "Reset all devices in a host",
807+
Use: "reset --host=HOST",
808+
Short: "Reset all CVD instances and CVD groups in a host",
811809
PreRunE: preRunE(resetFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
812810
RunE: func(c *cobra.Command, args []string) error {
813811
return runResetHostCommand(c, args, resetFlags, opts)
@@ -831,8 +829,8 @@ func connectionCommands(opts *subCommandOpts) []*cobra.Command {
831829

832830
func connectCommand(connFlags *ConnectFlags, opts *subCommandOpts) *cobra.Command {
833831
connect := &cobra.Command{
834-
Use: ConnectCommandName,
835-
Short: "(Re)Connects to a CVD and tunnels ADB messages",
832+
Use: "connect",
833+
Short: "Establish ADB connections to CVD instances",
836834
PreRunE: preRunE(connFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
837835
RunE: func(c *cobra.Command, args []string) error {
838836
return runConnectCommand(connFlags, &command{c, &connFlags.Verbose}, args, opts)
@@ -848,8 +846,8 @@ func connectCommand(connFlags *ConnectFlags, opts *subCommandOpts) *cobra.Comman
848846

849847
func disconnectCommand(connFlags *ConnectFlags, opts *subCommandOpts) *cobra.Command {
850848
disconnect := &cobra.Command{
851-
Use: fmt.Sprintf("%s <foo> <bar> <baz>", DisconnectCommandName),
852-
Short: "Disconnect (ADB) from CVD",
849+
Use: "disconnect",
850+
Short: "Terminate established ADB connections to CVD instances",
853851
PreRunE: preRunE(connFlags, &opts.ServiceFlags.Service, &opts.InitialConfig),
854852
RunE: func(c *cobra.Command, args []string) error {
855853
return runDisconnectCommand(connFlags, &command{c, &connFlags.Verbose}, args, opts)
@@ -1094,7 +1092,7 @@ func runDeleteCVDCommand(c *cobra.Command, args []string, flags *DeleteCVDFlags,
10941092
return err
10951093
}
10961094
if len(args) == 0 {
1097-
return errors.New("missing id")
1095+
return errors.New("missing group")
10981096
}
10991097
if len(args) > 1 {
11001098
return errors.New("deleting multiple instances is not supported yet")

0 commit comments

Comments
 (0)