docs: pass on sub-command help

cli/recipe/diff.go

@@ -5,14 +5,13 @@ import (
 	"coopcloud.tech/abra/pkg/autocomplete"
 	gitPkg "coopcloud.tech/abra/pkg/git"
 	"coopcloud.tech/abra/pkg/log"
-	"coopcloud.tech/abra/pkg/recipe"
 	"github.com/urfave/cli"
 )
 
 var recipeDiffCommand = cli.Command{
 	Name:        "diff",
 	Usage:       "Show unstaged changes in recipe config",
-	Description: "Due to limitations in our underlying Git dependency, this command requires /usr/bin/git.",
+	Description: "This command requires /usr/bin/git.",
 	Aliases:     []string{"d"},
 	ArgsUsage:   "<recipe>",
 	Flags: []cli.Flag{
@@ -22,12 +21,7 @@ var recipeDiffCommand = cli.Command{
 	Before:       internal.SubCommandBefore,
 	BashComplete: autocomplete.RecipeNameComplete,
 	Action: func(c *cli.Context) error {
-		recipeName := c.Args().First()
-		r := recipe.Get(recipeName)
-
-		if recipeName != "" {
-			internal.ValidateRecipe(c)
-		}
+		r := internal.ValidateRecipe(c)
 
 		if err := gitPkg.DiffUnstaged(r.Dir); err != nil {
 			log.Fatal(err)

cli/recipe/new.go

@@ -48,12 +48,7 @@ Create a new recipe.
 
 Abra uses the built-in example repository which is available here:
 
-    https://git.coopcloud.tech/coop-cloud/example
-
-Files within the example repository make use of the Golang templating system
-which Abra uses to inject values into the generated recipe folder (e.g. name of
-recipe and domain in the sample environment config).
-`,
+    https://git.coopcloud.tech/coop-cloud/example`,
 	Action: func(c *cli.Context) error {
 		recipeName := c.Args().First()
 		r := recipe.Get(recipeName)
@@ -100,22 +95,8 @@ recipe and domain in the sample environment config).
 			log.Fatal(err)
 		}
 
-		fmt.Print(fmt.Sprintf(`
-Your new %s recipe has been created in %s.
-
-In order to share your recipe, you can upload it the git repository to:
-
-    https://git.coopcloud.tech/coop-cloud/%s
-
-If you're not sure how to do that, come chat with us:
-
-    https://docs.coopcloud.tech/intro/contact
-
-See "abra recipe -h" for additional recipe maintainer commands.
-
-Happy Hacking!
-
-`, recipeName, path.Join(r.Dir), recipeName))
+		log.Infof("new recipe '%s' created: %s", recipeName, path.Join(r.Dir))
+		log.Info("happy hacking 🎉")
 
 		return nil
 	},

cli/recipe/recipe.go

@@ -18,9 +18,7 @@ for you.
 
 Anyone who uses a recipe can become a maintainer. Maintainers typically make
 sure the recipe is in good working order and the config upgraded in a timely
-manner. Abra supports convenient automation for recipe maintainenace, see the
-"abra recipe upgrade", "abra recipe sync" and "abra recipe release" commands.
-`,
+manner.`,
 	Subcommands: []cli.Command{
 		recipeFetchCommand,
 		recipeLintCommand,

cli/recipe/release.go

@@ -45,8 +45,7 @@ major and therefore require intervention while doing the upgrade work.
 
 Publish your new release to git.coopcloud.tech with "-p/--publish". This
 requires that you have permission to git push to these repositories and have
-your SSH keys configured on your account.
-`,
+your SSH keys configured on your account.`,
 	Flags: []cli.Flag{
 		internal.DebugFlag,
 		internal.NoInputFlag,

cli/recipe/reset.go

@@ -12,7 +12,7 @@ import (
 var recipeResetCommand = cli.Command{
 	Name:        "reset",
 	Usage:       "Remove all unstaged changes from recipe config",
-	Description: "WARNING, this will delete your changes. Be Careful.",
+	Description: "WARNING: this will delete your changes. Be Careful.",
 	Aliases:     []string{"rs"},
 	ArgsUsage:   "<recipe>",
 	Flags: []cli.Flag{

cli/recipe/sync.go

@@ -37,8 +37,7 @@ named "app") which corresponds to the following format:
 
 Where <version> can be specifed on the command-line or Abra can attempt to
 auto-generate it for you. The <recipe> configuration will be updated on the
-local file system.
-`,
+local file system.`,
 	BashComplete: autocomplete.RecipeNameComplete,
 	Action: func(c *cli.Context) error {
 		recipe := internal.ValidateRecipe(c)

cli/recipe/upgrade.go

@@ -53,10 +53,11 @@ The command is interactive and will show a select input which allows you to
 make a seclection. Use the "?" key to see more help on navigating this
 interface.
 
-You may invoke this command in "wizard" mode and be prompted for input:
+You may invoke this command in "wizard" mode and be prompted for input.
 
-    abra recipe upgrade
-`,
+EXAMPLE:
+
+    abra recipe upgrade`,
 	ArgsUsage: "<recipe>",
 	Flags: []cli.Flag{
 		internal.DebugFlag,

cli/recipe/version.go

@@ -24,11 +24,10 @@ func sortServiceByName(versions [][]string) func(i, j int) bool {
 }
 
 var recipeVersionCommand = cli.Command{
-	Name:        "versions",
-	Aliases:     []string{"v"},
-	Usage:       "List recipe versions",
-	ArgsUsage:   "<recipe>",
-	Description: "Versions are read from the recipe catalogue.",
+	Name:      "versions",
+	Aliases:   []string{"v"},
+	Usage:     "List recipe versions",
+	ArgsUsage: "<recipe>",
 	Flags: []cli.Flag{
 		internal.DebugFlag,
 		internal.OfflineFlag,