Added example to CLI

README.md

@@ -90,7 +90,21 @@ jobs:
 
 ## CLI
 
-The action is also available to use as a CLI, if you install the package `@iota/gh-tangle-release` you can run the following.
+The core features are also available to use as a CLI independently of GitHub Actions.
+
+If you install the npm package with:
+
+```shell
+npm install @iota/gh-tangle-release
+```
+
+You can then execute the following script.
+
+```shell
+gh-tangle-release
+```
+
+You will then be presented with the following options.
 
 ```shell
 GitHub Tangle Release v0.7.0 🚀
@@ -115,4 +129,7 @@ Options:
   --comment <string>          An optional comment to include in the Tangle transaction payload
   --explorer-url <string>     Url of the explorer to use for exploration link (default: "https://utils.iota.org/transaction/:hash")
   --help                      Display help
-  ```
+
+
+Example: gh-tangle-release --github-token a4d936470cb3d66f5434f787c2500bde9764f --owner my-org --repository my-repo --release-tag v1.0.1 --seed AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+  ```

dist/cli.js

@@ -32,7 +32,7 @@ program
     .option("--explorer-url <string>", chalk_1.default.yellowBright("Url of the explorer to use for exploration link"), "https://utils.iota.org/transaction/:hash")
     .helpOption("--help", chalk_1.default.yellowBright("Display help"));
 if (process.argv.length === 2) {
-    program.help();
+    program.help(str => `${str}${createExample()}`);
 }
 else {
     try {
@@ -82,10 +82,14 @@ else {
         });
     }
     catch (err) {
-        program.help(str => {
-            console.log(str);
-            console.error(chalk_1.default.red(`Error: ${err.message}`));
-            return "";
-        });
+        program.help(str => `${str}${chalk_1.default.red(`Error: ${err.message}`)}`);
     }
 }
+/**
+ * Show an example on the console.
+ * @returns The example text.
+ */
+function createExample() {
+    // eslint-disable-next-line max-len
+    return chalk_1.default.magenta("\nExample: gh-tangle-release --github-token a4d936470cb3d66f5434f787c2500bde9764f --owner my-org --repository my-repo --release-tag v1.0.1 --seed AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n");
+}

src/cli.ts

@@ -39,7 +39,7 @@ program
         chalk.yellowBright("Display help"));
 
 if (process.argv.length === 2) {
-    program.help();
+    program.help(str => `${str}${createExample()}`);
 } else {
     try {
         program.parse(process.argv);
@@ -92,10 +92,15 @@ if (process.argv.length === 2) {
                 process.exit(1);
             });
     } catch (err) {
-        program.help(str => {
-            console.log(str);
-            console.error(chalk.red(`Error: ${err.message}`));
-            return "";
-        });
+        program.help(str => `${str}${chalk.red(`Error: ${err.message}`)}`);
     }
 }
+
+/**
+ * Show an example on the console.
+ * @returns The example text.
+ */
+function createExample(): string {
+    // eslint-disable-next-line max-len
+    return chalk.magenta("\nExample: gh-tangle-release --github-token a4d936470cb3d66f5434f787c2500bde9764f --owner my-org --repository my-repo --release-tag v1.0.1 --seed AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n");
+}