From bd92c52eeda10ba97f6f3c94ea3f5ae8d57d993b Mon Sep 17 00:00:00 2001
From: decentral1se <lukewm@riseup.net>
Date: Tue, 2 Nov 2021 14:21:55 +0100
Subject: [PATCH] fix: document secret names more coherently

Closes https://git.coopcloud.tech/coop-cloud/organising/issues/215.
---
 cli/app/secret.go | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/cli/app/secret.go b/cli/app/secret.go
index 9db661104..d5f133438 100644
--- a/cli/app/secret.go
+++ b/cli/app/secret.go
@@ -99,7 +99,19 @@ var appSecretInsertCommand = &cli.Command{
 	Aliases:   []string{"i"},
 	Usage:     "Insert secret",
 	Flags:     []cli.Flag{internal.PassFlag},
-	ArgsUsage: "<secret> <version> <data>",
+	ArgsUsage: "<secret-name> <version> <data>",
+	Description: `
+This command inserts a secret into an app environment.
+
+This can be useful when you want to manually generate secrets for an app
+environment. Typically, you can let Abra generate them for you on app creation
+(see "abra app new --secrets" for more).
+
+Example:
+
+    abra app myapp secret insert db_pass v1 mySecretPassword
+
+`,
 	Action: func(c *cli.Context) error {
 		app := internal.ValidateApp(c)
 
@@ -131,12 +143,20 @@ var appSecretRmCommand = &cli.Command{
 	Usage:     "Remove a secret",
 	Aliases:   []string{"rm"},
 	Flags:     []cli.Flag{allSecretsFlag, internal.PassFlag},
-	ArgsUsage: "<secret>",
+	ArgsUsage: "<secret-name>",
+	Description: `
+This command removes a secret from an app environment.
+
+Example:
+
+    abra app myapp secret remove db_pass
+
+`,
 	Action: func(c *cli.Context) error {
 		app := internal.ValidateApp(c)
 
 		if c.Args().Get(1) != "" && allSecrets {
-			internal.ShowSubcommandHelpAndError(c, errors.New("cannot use '<secret>' and '--all' together"))
+			internal.ShowSubcommandHelpAndError(c, errors.New("cannot use '<secret-name>' and '--all' together"))
 		}
 
 		if c.Args().Get(1) == "" && !allSecrets {