Skip to content

Commit

Permalink
Improve cli help texts (#311)
Browse files Browse the repository at this point in the history
* Improve cli help texts

* Adjust dev mark
  • Loading branch information
marcauberer committed Apr 22, 2022
1 parent 3fc829b commit f6426a5
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 17 deletions.
14 changes: 7 additions & 7 deletions src/cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,28 @@ var CliCommands = []*cli.Command{
{
Name: "generate",
Aliases: []string{"g", "gen"},
Usage: "Generates a docker compose configuration",
Usage: "Generate a Docker Compose configuration",
Flags: GenerateCliFlags,
Action: Generate,
},
{
Name: "add",
Aliases: []string{"a"},
Usage: "Adds a service to an existing compose file",
Usage: "Add a service to an existing Compose file",
Flags: AddCliFlags,
Action: Add,
},
{
Name: "remove",
Aliases: []string{"r", "rm"},
Usage: "Removes a service from an existing compose file",
Usage: "Remove a service from an existing Compose file",
Flags: RemoveCliFlags,
Action: Remove,
},
{
Name: "template",
Aliases: []string{"t"},
Usage: "Manages snapshots of your compose configuration for later use",
Usage: "Manage snapshots of your Compose configuration for later use",
Subcommands: []*cli.Command{
{
Name: "save",
Expand Down Expand Up @@ -63,20 +63,20 @@ var CliCommands = []*cli.Command{
{
Name: "install",
Aliases: []string{"i", "in"},
Usage: "Installs Docker and Docker Compose with a single command",
Usage: "Install Docker and Docker Compose with a single command",
Hidden: isDockerizedEnvironment(),
Action: Install,
},
{
Name: "predefined-template",
Aliases: []string{"p", "pd"},
Usage: "Manages predefined service templates (this command does only exist in dev environments)",
Usage: "Manage predefined service templates [DEV]",
Hidden: !isDevVersion(),
Subcommands: []*cli.Command{
{
Name: "new",
Aliases: []string{"n"},
Usage: "Creates a blank predefined service template",
Usage: "Create a blank predefined service template",
Flags: PredefinedTemplateNewCliFlags,
Action: NewPredefinedTemplate,
},
Expand Down
8 changes: 4 additions & 4 deletions src/cmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var GenerateCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "advanced",
Aliases: []string{"a"},
Usage: "Generate compose file in advanced mode",
Usage: "Generate Compose file in advanced mode",
Value: false,
},
&cli.PathFlag{
Expand All @@ -32,7 +32,7 @@ var GenerateCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "detached",
Aliases: []string{"d"},
Usage: "Run docker compose detached after creating the compose file",
Usage: "Run Docker Compose detached after creating the Compose file",
Value: false,
},
&cli.BoolFlag{
Expand All @@ -44,13 +44,13 @@ var GenerateCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "with-instructions",
Aliases: []string{"i"},
Usage: "Generates a README.md file with instructions to use the template",
Usage: "Generate a README.md file with instructions to use the template",
Value: false,
},
&cli.BoolFlag{
Name: "run",
Aliases: []string{"r"},
Usage: "Run docker compose after creating the compose file",
Usage: "Run Docker Compose after creating the compose file",
Value: false,
},
}
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/remove.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ var RemoveCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "run",
Aliases: []string{"r"},
Usage: "Run docker compose after creating the compose file",
Usage: "Run Docker Compose after creating the Compose file",
Value: false,
},
&cli.BoolFlag{
Name: "detached",
Aliases: []string{"d"},
Usage: "Run docker compose detached after creating the compose file",
Usage: "Run Docker Compose detached after creating the Compose file",
Value: false,
},
&cli.BoolFlag{
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/template-delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ var TemplateDeleteCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "No safety checks",
Usage: "Skip safety checks",
Value: false,
},
}
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/template-load.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ var TemplateLoadCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "No safety checks",
Usage: "Skip safety checks",
Value: false,
},
&cli.BoolFlag{
Name: "show",
Aliases: []string{"s"},
Usage: "Do not load a template. Instead only list all templates and terminate",
Usage: "Instead only list all templates and terminate instead of loading one",
Value: false,
},
}
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/template-save.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ var TemplateSaveCliFlags = []cli.Flag{
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "No safety checks",
Usage: "Skip safety checks",
Value: false,
},
}
Expand Down

0 comments on commit f6426a5

Please sign in to comment.