feat: added examples for commands

elasticpath · Sep 22, 2023 · 2d73304 · 2d73304
1 parent 631675e
commit 2d73304
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/packages/composable-cli/src/commands/config/config-command.tsx b/packages/composable-cli/src/commands/config/config-command.tsx
@@ -35,6 +35,8 @@ export function createConfigCommand(
             configClearCommand(ctx.store)
           },
         })
+        .example("$0 config list", "list all stored configuration")
+        .example("$0 config clear", "clear all stored configuration")
         .help()
         .demandCommand(1)
         .strict()

diff --git a/packages/composable-cli/src/commands/login/login-command.ts b/packages/composable-cli/src/commands/login/login-command.ts
@@ -66,12 +66,12 @@ export function createLoginCommand(
           type: "string",
           description: "Password of Elastic Path account",
         })
-        .example("composable login", "using interactive prompts")
+        .example("$0 login", "using interactive prompts")
         .example(
-          "composable login --region=us-east [email protected] --password=topSecret",
+          "$0 login --region=us-east [email protected] --password=topSecret",
           "using command line arguments"
         )
-        .help("h")
+        .help()
         .parserConfiguration({
           "strip-aliased": true,
         })

diff --git a/packages/composable-cli/src/composable.ts b/packages/composable-cli/src/composable.ts
@@ -57,6 +57,8 @@ export async function main({
       .command(createStoreCommand(commandContext))
       .command(createGenerateCommand(commandContext))
       .command(createInsightsCommand(commandContext))
+      .example("$0 login", "using interactive prompts")
+      .example("$0 logout", "logout of the CLI")
       .strictCommands()
       .demandCommand(1)
       .help("h").argv