Improve help text for all commands (#145)

* Improve help text for all commands * 0.23.1
3lvia · Dec 19, 2024 · 4463c67 · 4463c67
1 parent e311b4e
commit 4463c67
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 48 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.23.0
+0.23.1
diff --git a/pkg/build/build.go b/pkg/build/build.go
@@ -19,9 +19,10 @@ import (
 const commandName = "build"
 
 var Command *cli.Command = &cli.Command{
-	Name:    commandName,
-	Aliases: []string{"b"},
-	Usage:   "Build a Docker image from a project file.",
+	Name:      commandName,
+	Aliases:   []string{"b"},
+	Usage:     "Build a Docker image from a project file.",
+	UsageText: "3lv build [options] <application-name>",
 	Flags: []cli.Flag{
 		shared.ProjectFileFlag(),
 		shared.SystemNameFlag(
@@ -105,7 +106,7 @@ var Command *cli.Command = &cli.Command{
 
 func Build(ctx context.Context, c *cli.Command) error {
 	if c.NArg() <= 0 {
-		return cli.ShowAppHelp(c)
+		cli.ShowSubcommandHelpAndExit(c, 1)
 	}
 
 	// Required args

diff --git a/pkg/create/create.go b/pkg/create/create.go
@@ -37,9 +37,10 @@ var (
 )
 
 var Command *cli.Command = &cli.Command{
-	Name:    commandName,
-	Aliases: []string{"c"},
-	Usage:   "Create a new project",
+	Name:      commandName,
+	Aliases:   []string{"c"},
+	Usage:     "Create a new project from one of Elvia's templates.",
+	UsageText: "3lv create [options] <output-directory>",
 	Flags: []cli.Flag{
 		shared.SystemNameFlag(
 			"The name of your system (Kubernetes namespace) you want to create your application in.",
@@ -91,11 +92,9 @@ var Command *cli.Command = &cli.Command{
 
 func Create(ctx context.Context, c *cli.Command) error {
 	if c.NArg() <= 0 {
-		return cli.ShowAppHelp(c)
+		cli.ShowSubcommandHelpAndExit(c, 1)
 	}
 
-	nonInteractive := c.Bool("non-interactive")
-
 	outputDirectory := c.Args().First()
 	if outputDirectory == "" {
 		return cli.Exit("Output directory not provided", 1)
@@ -118,7 +117,9 @@ func Create(ctx context.Context, c *cli.Command) error {
 		}
 		return *parsed
 	}()
+
 	defaultBranch := c.String("default-branch")
+	nonInteractive := c.Bool("non-interactive")
 
 	checkCoooiecutterInstalledOutput := checkCookiecutterInstalledCommand(nil)
 	if command.IsError(checkCoooiecutterInstalledOutput) {

diff --git a/pkg/deploy/deploy.go b/pkg/deploy/deploy.go
@@ -16,10 +16,11 @@ import (
 )
 
 var Command *cli.Command = &cli.Command{
-	Name:    "deploy",
-	Aliases: []string{"d"},
-	Usage:   "Deploy an application to a Kubernetes cluster",
-	Hidden:  true,
+	Name:      "deploy",
+	Aliases:   []string{"d"},
+	Usage:     "Deploy an application to a one of Atlas' Kubernetes clusters.",
+	UsageText: "3lv deploy [options] <application-name>",
+	Hidden:    true,
 	Flags: []cli.Flag{
 		shared.SystemNameFlag(
 			"The name of the system (Kubernetes namespace) to deploy to.",
@@ -28,10 +29,9 @@ var Command *cli.Command = &cli.Command{
 		shared.RuntimeCloudProviderFlag(),
 		shared.HelmValuesFileFlag(),
 		&cli.StringFlag{
-			Name:     "image-tag",
-			Aliases:  []string{"i"},
-			Usage:    "The image tag to deploy.",
-			Required: true,
+			Name:    "image-tag",
+			Aliases: []string{"i"},
+			Usage:   "The image tag to deploy.",
 		},
 		&cli.StringFlag{
 			Name:    "environment",
@@ -159,7 +159,7 @@ var Command *cli.Command = &cli.Command{
 
 func Deploy(ctx context.Context, c *cli.Command) error {
 	if c.NArg() <= 0 {
-		return cli.ShowAppHelp(c)
+		cli.ShowSubcommandHelpAndExit(c, 1)
 	}
 
 	if !c.Bool("allow-deploy") {

diff --git a/pkg/githubactions/githubactions.go b/pkg/githubactions/githubactions.go
@@ -26,9 +26,10 @@ const (
 var helmValuesFileTemplate embed.FS
 
 var Command *cli.Command = &cli.Command{
-	Name:    commandName,
-	Aliases: []string{"gha"},
-	Usage:   "Add GitHub Actions to a project",
+	Name:      commandName,
+	Aliases:   []string{"gha"},
+	Usage:     "Add build and deploy with GitHub Actions to an exisiting project.",
+	UsageText: "3lv build [options] <project-directory>",
 	Flags: []cli.Flag{
 		shared.SystemNameFlag(
 			"The name of your system (Kubernetes namespace) you want to deploy to.",
@@ -51,8 +52,21 @@ var Command *cli.Command = &cli.Command{
 }
 
 func GitHubActions(ctx context.Context, c *cli.Command) error {
+	if c.NArg() <= 0 {
+		cli.ShowSubcommandHelpAndExit(c, 1)
+	}
+
+	projectDirectory := func() string {
+		first := c.Args().First()
+		if first == "" {
+			return "."
+		}
+
+		return first
+	}()
+
 	err := CreateDeployWorkflow(
-		".",
+		projectDirectory,
 		c.String("project-file"),
 		c.String("runtime-cloud-provider"),
 		c.String("system-name"),

diff --git a/pkg/run/run.go b/pkg/run/run.go
@@ -21,9 +21,10 @@ const commandName = "run"
 var composeTemplates embed.FS
 
 var Command *cli.Command = &cli.Command{
-	Name:    commandName,
-	Aliases: []string{"r"},
-	Usage:   "Run your application with Docker Compose",
+	Name:      commandName,
+	Aliases:   []string{"r"},
+	Usage:     "Run your application with Docker Compose.",
+	UsageText: "3lv run [options] <application-name>",
 	Flags: []cli.Flag{
 		shared.SystemNameFlag(
 			"The name of your system.",
@@ -39,7 +40,7 @@ var Command *cli.Command = &cli.Command{
 
 func Run(ctx context.Context, c *cli.Command) error {
 	if c.NArg() <= 0 {
-		return cli.ShowAppHelp(c)
+		cli.ShowSubcommandHelpAndExit(c, 1)
 	}
 
 	applicationName := c.Args().First()

diff --git a/pkg/scan/scan.go b/pkg/scan/scan.go
@@ -16,9 +16,10 @@ import (
 )
 
 var Command *cli.Command = &cli.Command{
-	Name:    "scan",
-	Aliases: []string{"s"},
-	Usage:   "Scan image using Trivy.",
+	Name:      "scan",
+	Aliases:   []string{"s"},
+	Usage:     "Scan a container image using Trivy.",
+	UsageText: "3lv scan [options] <image-name>",
 	Flags: []cli.Flag{
 		shared.SeverityFlag("severity"),
 		shared.FormatsFlag("formats"),
@@ -29,7 +30,7 @@ var Command *cli.Command = &cli.Command{
 
 func Scan(ctx context.Context, c *cli.Command) error {
 	if c.NArg() <= 0 {
-		return cli.ShowAppHelp(c)
+		cli.ShowSubcommandHelpAndExit(c, 1)
 	}
 
 	// Required args

diff --git a/pkg/shared/flags.go b/pkg/shared/flags.go
@@ -15,10 +15,9 @@ func nameToEnvVar(name string) string {
 
 func ProjectFileFlag() *cli.StringFlag {
 	return &cli.StringFlag{
-		Name:     "project-file",
-		Aliases:  []string{"f"},
-		Usage:    "The project file to use. We currently support .NET (*.csproj), Go (go.mod) or a generic project (Dockerfile).",
-		Required: true,
+		Name:    "project-file",
+		Aliases: []string{"f"},
+		Usage:   "The project file to use. We currently support .NET (*.csproj), Go (go.mod) or a generic project (Dockerfile).",
 	}
 }
 
@@ -47,20 +46,18 @@ func RuntimeCloudProviderFlag() *cli.StringFlag {
 
 func SystemNameFlag(usage string, required bool) *cli.StringFlag {
 	return &cli.StringFlag{
-		Name:     "system-name",
-		Aliases:  []string{"s"},
-		Usage:    usage,
-		Required: required,
-		Sources:  cli.EnvVars("3LV_SYSTEM_NAME"),
+		Name:    "system-name",
+		Aliases: []string{"s"},
+		Usage:   usage,
+		Sources: cli.EnvVars("3LV_SYSTEM_NAME"),
 	}
 }
 
 func ApplicationNameFlag(usage string) *cli.StringFlag {
 	return &cli.StringFlag{
-		Name:     "application-name",
-		Aliases:  []string{"a"},
-		Usage:    usage,
-		Required: true,
+		Name:    "application-name",
+		Aliases: []string{"a"},
+		Usage:   usage,
 	}
 }
 

diff --git a/pkg/upgrade/upgrade.go b/pkg/upgrade/upgrade.go
@@ -26,9 +26,10 @@ const defaultInstallLocation = "/usr/local/bin"
 
 func Command(version string) *cli.Command {
 	return &cli.Command{
-		Name:    commandName,
-		Aliases: []string{"u"},
-		Usage:   "Upgrade the Elvia CLI",
+		Name:      commandName,
+		Aliases:   []string{"u"},
+		Usage:     "Upgrade the Elvia CLI to the latest version.",
+		UsageText: "3lv upgrade [options]",
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:    "install-location",