diff --git a/cmd/build.go b/cmd/build.go index e6eff8726..c72bf45dd 100644 --- a/cmd/build.go +++ b/cmd/build.go @@ -37,7 +37,7 @@ func NewBuildCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } buildCmd := &cobra.Command{ - Use: "build", + Use: "build [flags] [workspace-path|workspace-name]", Short: "Builds a workspace", RunE: func(_ *cobra.Command, args []string) error { ctx := context.Background() diff --git a/cmd/delete.go b/cmd/delete.go index 7f5422f62..fa025e2b4 100644 --- a/cmd/delete.go +++ b/cmd/delete.go @@ -26,7 +26,7 @@ func NewDeleteCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } deleteCmd := &cobra.Command{ - Use: "delete", + Use: "delete [flags] [workspace-path|workspace-name]", Short: "Deletes an existing workspace", RunE: func(_ *cobra.Command, args []string) error { _, err := clientimplementation.DecodeOptionsFromEnv(clientimplementation.DevPodFlagsDelete, &cmd.DeleteOptions) diff --git a/cmd/export.go b/cmd/export.go index 2ec4bf46b..f2483f5fd 100644 --- a/cmd/export.go +++ b/cmd/export.go @@ -24,7 +24,7 @@ func NewExportCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } exportCmd := &cobra.Command{ - Use: "export", + Use: "export [flags] [workspace-path|workspace-name]", Short: "Exports a workspace configuration", RunE: func(_ *cobra.Command, args []string) error { ctx := context.Background() diff --git a/cmd/ide/use.go b/cmd/ide/use.go index 7251140f3..d56310ab0 100644 --- a/cmd/ide/use.go +++ b/cmd/ide/use.go @@ -27,10 +27,13 @@ func NewUseCmd(flags *flags.GlobalFlags) *cobra.Command { } useCmd := &cobra.Command{ Use: "use", - Short: "Configure the default IDE to use", + Short: "Configure the default IDE to use (list available IDEs with 'devpod ide list')", + Long: `Configure the default IDE to use + +Available IDEs can be listed with 'devpod ide list'`, RunE: func(_ *cobra.Command, args []string) error { if len(args) != 1 { - return fmt.Errorf("please specify the ide to use") + return fmt.Errorf("please specify the ide to use, list available IDEs with 'devpod ide list'") } return cmd.Run(context.Background(), args[0]) diff --git a/cmd/logs.go b/cmd/logs.go index 871ea2c23..bdf6b2cde 100644 --- a/cmd/logs.go +++ b/cmd/logs.go @@ -28,7 +28,7 @@ func NewLogsCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } startCmd := &cobra.Command{ - Use: "logs", + Use: "logs [flags] [workspace-path|workspace-name]", Short: "Prints the workspace logs on the machine", RunE: func(_ *cobra.Command, args []string) error { return cmd.Run(context.Background(), args) diff --git a/cmd/ssh.go b/cmd/ssh.go index 5bfd60db7..adafa5e6a 100644 --- a/cmd/ssh.go +++ b/cmd/ssh.go @@ -62,7 +62,7 @@ func NewSSHCmd(f *flags.GlobalFlags) *cobra.Command { GlobalFlags: f, } sshCmd := &cobra.Command{ - Use: "ssh", + Use: "ssh [flags] [workspace-folder|workspace-name]", Short: "Starts a new ssh session to a workspace", RunE: func(_ *cobra.Command, args []string) error { devPodConfig, err := config.LoadConfig(cmd.Context, cmd.Provider) diff --git a/cmd/status.go b/cmd/status.go index aed74b4fc..7e2330e29 100644 --- a/cmd/status.go +++ b/cmd/status.go @@ -31,7 +31,7 @@ func NewStatusCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } statusCmd := &cobra.Command{ - Use: "status", + Use: "status [flags] [workspace-path|workspace-name]", Short: "Shows the status of a workspace", RunE: func(_ *cobra.Command, args []string) error { _, err := clientimplementation.DecodeOptionsFromEnv(clientimplementation.DevPodFlagsStatus, &cmd.StatusOptions) diff --git a/cmd/stop.go b/cmd/stop.go index e140bbd92..06ff556f7 100644 --- a/cmd/stop.go +++ b/cmd/stop.go @@ -24,7 +24,7 @@ func NewStopCmd(flags *flags.GlobalFlags) *cobra.Command { GlobalFlags: flags, } stopCmd := &cobra.Command{ - Use: "stop", + Use: "stop [flags] [workspace-path|workspace-name]", Aliases: []string{"down"}, Short: "Stops an existing workspace", RunE: func(_ *cobra.Command, args []string) error { diff --git a/cmd/up.go b/cmd/up.go index b3c8760ce..086b740d9 100644 --- a/cmd/up.go +++ b/cmd/up.go @@ -71,7 +71,7 @@ func NewUpCmd(f *flags.GlobalFlags) *cobra.Command { GlobalFlags: f, } upCmd := &cobra.Command{ - Use: "up", + Use: "up [flags] [workspace-path|workspace-name]", Short: "Starts a new workspace", RunE: func(_ *cobra.Command, args []string) error { devPodConfig, err := config.LoadConfig(cmd.Context, cmd.Provider)