浏览代码

Adding short description to improve help on compose subcommands

Signed-off-by: Guillaume Tardif <[email protected]>
Guillaume Tardif 4 年之前
父节点
当前提交
cf0e10a431

+ 2 - 1
cli/cmd/compose/build.go

@@ -33,7 +33,8 @@ type buildOptions struct {
 func buildCommand() *cobra.Command {
 	opts := buildOptions{}
 	buildCmd := &cobra.Command{
-		Use: "build [SERVICE...]",
+		Use:   "build [SERVICE...]",
+		Short: "Build or rebuild services",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runBuild(cmd.Context(), opts, args)
 		},

+ 2 - 1
cli/cmd/compose/down.go

@@ -28,7 +28,8 @@ import (
 func downCommand() *cobra.Command {
 	opts := composeOptions{}
 	downCmd := &cobra.Command{
-		Use: "down",
+		Use:   "down",
+		Short: "Stop and remove containers, networks",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runDown(cmd.Context(), opts)
 		},

+ 2 - 1
cli/cmd/compose/list.go

@@ -33,7 +33,8 @@ import (
 func listCommand() *cobra.Command {
 	opts := composeOptions{}
 	lsCmd := &cobra.Command{
-		Use: "ls",
+		Use:   "ls",
+		Short: "List running compose projects",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runList(cmd.Context(), opts)
 		},

+ 2 - 1
cli/cmd/compose/logs.go

@@ -29,7 +29,8 @@ import (
 func logsCommand() *cobra.Command {
 	opts := composeOptions{}
 	logsCmd := &cobra.Command{
-		Use: "logs",
+		Use:   "logs",
+		Short: "View output from containers",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runLogs(cmd.Context(), opts)
 		},

+ 2 - 1
cli/cmd/compose/ps.go

@@ -33,7 +33,8 @@ import (
 func psCommand() *cobra.Command {
 	opts := composeOptions{}
 	psCmd := &cobra.Command{
-		Use: "ps",
+		Use:   "ps",
+		Short: "List containers",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPs(cmd.Context(), opts)
 		},

+ 2 - 1
cli/cmd/compose/pull.go

@@ -33,7 +33,8 @@ type pullOptions struct {
 func pullCommand() *cobra.Command {
 	opts := pullOptions{}
 	pullCmd := &cobra.Command{
-		Use: "pull [SERVICE...]",
+		Use:   "pull [SERVICE...]",
+		Short: "Pull service images",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPull(cmd.Context(), opts, args)
 		},

+ 2 - 1
cli/cmd/compose/push.go

@@ -33,7 +33,8 @@ type pushOptions struct {
 func pushCommand() *cobra.Command {
 	opts := pushOptions{}
 	pushCmd := &cobra.Command{
-		Use: "push [SERVICE...]",
+		Use:   "push [SERVICE...]",
+		Short: "Push service images",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPush(cmd.Context(), opts, args)
 		},

+ 2 - 1
cli/cmd/compose/up.go

@@ -36,7 +36,8 @@ import (
 func upCommand(contextType string) *cobra.Command {
 	opts := composeOptions{}
 	upCmd := &cobra.Command{
-		Use: "up [SERVICE...]",
+		Use:   "up [SERVICE...]",
+		Short: "Create and start containers",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			switch contextType {
 			case store.LocalContextType, store.DefaultContextType: