@twin.org/crypto-cli 0.0.1-next.3 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -126,7 +126,8 @@ function buildCommandMnemonic() {
         .default("256"))
         .addOption(new commander.Option(core.I18n.formatMessage("commands.mnemonic.options.seed-format.param"), core.I18n.formatMessage("commands.mnemonic.options.seed-format.description"))
         .choices(["hex", "base64"])
-        .default("hex"));
+        .default("hex"))
+        .addOption(new commander.Option(core.I18n.formatMessage("commands.mnemonic.options.env-prefix.param"), core.I18n.formatMessage("commands.mnemonic.options.env-prefix.description")));
     cliCore.CLIOptions.output(command, {
         noConsole: true,
         json: true,
@@ -147,17 +148,21 @@ async function actionCommandMnemonic(opts) {
     const strength = cliCore.CLIParam.integer("strength", opts.strength, false, 128, 256);
     const mnemonic = crypto.Bip39.randomMnemonic(strength);
     const seed = crypto.Bip39.mnemonicToSeed(mnemonic);
+    const envPrefix = core.Is.stringValue(opts.envPrefix) ? opts.envPrefix : "";
     const seedFormatted = opts.seedFormat === "hex" ? core.Converter.bytesToHex(seed, true) : core.Converter.bytesToBase64(seed);
     if (opts.console) {
         cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.mnemonic.labels.mnemonic"), mnemonic);
         cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.mnemonic.labels.seed"), seedFormatted);
+        if (core.Is.stringValue(opts.envPrefix)) {
+            cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.mnemonic.labels.envPrefix"), envPrefix);
+        }
         cliCore.CLIDisplay.break();
     }
     if (core.Is.stringValue(opts?.json)) {
         await cliCore.CLIUtils.writeJsonFile(opts.json, { mnemonic, seed: seedFormatted }, opts.mergeJson);
     }
     if (core.Is.stringValue(opts?.env)) {
-        await cliCore.CLIUtils.writeEnvFile(opts.env, [`MNEMONIC="${mnemonic}"`, `SEED="${seedFormatted}"`], opts.mergeEnv);
+        await cliCore.CLIUtils.writeEnvFile(opts.env, [`${envPrefix}MNEMONIC="${mnemonic}"`, `${envPrefix}SEED="${seedFormatted}"`], opts.mergeEnv);
     }
     cliCore.CLIDisplay.done();
 }
@@ -172,16 +177,19 @@ class CLI extends cliCore.CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN Crypto",
             appName: "twin-crypto",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.7",
             icon: "🌍",
-            supportsEnvFiles: true
-        }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
+            supportsEnvFiles: true,
+            overrideOutputWidth: options?.overrideOutputWidth
+        }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
     }
     /**
      * Get the commands for the CLI.

package/dist/esm/index.mjs

@@ -123,7 +123,8 @@ function buildCommandMnemonic() {
         .default("256"))
         .addOption(new Option(I18n.formatMessage("commands.mnemonic.options.seed-format.param"), I18n.formatMessage("commands.mnemonic.options.seed-format.description"))
         .choices(["hex", "base64"])
-        .default("hex"));
+        .default("hex"))
+        .addOption(new Option(I18n.formatMessage("commands.mnemonic.options.env-prefix.param"), I18n.formatMessage("commands.mnemonic.options.env-prefix.description")));
     CLIOptions.output(command, {
         noConsole: true,
         json: true,
@@ -144,17 +145,21 @@ async function actionCommandMnemonic(opts) {
     const strength = CLIParam.integer("strength", opts.strength, false, 128, 256);
     const mnemonic = Bip39.randomMnemonic(strength);
     const seed = Bip39.mnemonicToSeed(mnemonic);
+    const envPrefix = Is.stringValue(opts.envPrefix) ? opts.envPrefix : "";
     const seedFormatted = opts.seedFormat === "hex" ? Converter.bytesToHex(seed, true) : Converter.bytesToBase64(seed);
     if (opts.console) {
         CLIDisplay.value(I18n.formatMessage("commands.mnemonic.labels.mnemonic"), mnemonic);
         CLIDisplay.value(I18n.formatMessage("commands.mnemonic.labels.seed"), seedFormatted);
+        if (Is.stringValue(opts.envPrefix)) {
+            CLIDisplay.value(I18n.formatMessage("commands.mnemonic.labels.envPrefix"), envPrefix);
+        }
         CLIDisplay.break();
     }
     if (Is.stringValue(opts?.json)) {
         await CLIUtils.writeJsonFile(opts.json, { mnemonic, seed: seedFormatted }, opts.mergeJson);
     }
     if (Is.stringValue(opts?.env)) {
-        await CLIUtils.writeEnvFile(opts.env, [`MNEMONIC="${mnemonic}"`, `SEED="${seedFormatted}"`], opts.mergeEnv);
+        await CLIUtils.writeEnvFile(opts.env, [`${envPrefix}MNEMONIC="${mnemonic}"`, `${envPrefix}SEED="${seedFormatted}"`], opts.mergeEnv);
     }
     CLIDisplay.done();
 }
@@ -169,15 +174,18 @@ class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN Crypto",
             appName: "twin-crypto",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.7",
             icon: "🌍",
-            supportsEnvFiles: true
+            supportsEnvFiles: true,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
     }
     /**

package/dist/locales/en.json

@@ -185,6 +185,10 @@
         "env": {
           "param": "--env '<'filename'>'",
           "description": "Creates an env file containing the mnemonic and seed."
+        },
+        "env-prefix": {
+          "param": "--env-prefix '<'prefix'>'",
+          "description": "Prefixes the env variables with the value."
         }
       },
       "progress": {
@@ -193,7 +197,8 @@
       },
       "labels": {
         "mnemonic": "Mnemonic",
-        "seed": "Seed"
+        "seed": "Seed",
+        "envPrefix": "Env Prefix"
       }
     },
     "address": {

package/dist/types/cli.d.ts

@@ -7,7 +7,11 @@ export declare class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    run(argv: string[], localesDirectory?: string): Promise<number>;
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): Promise<number>;
 }

package/dist/types/commands/mnemonic.d.ts

@@ -14,4 +14,5 @@ export declare function buildCommandMnemonic(): Command;
 export declare function actionCommandMnemonic(opts: {
     strength: string;
     seedFormat: "hex" | "base64";
+    envPrefix?: string;
 } & CliOutputOptions): Promise<void>;

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/crypto-cli - Changelog
 
-## 0.0.1-next.3
+## 0.0.1-next.7
 
 - Initial Release

package/docs/examples.md

@@ -1,22 +1,21 @@
 # @twin.org/crypto-cli - Examples
 
-## Command Line Tool
+## Running
 
-First install the tool with the following script.
+To install and run the CLI locally use the following commands:
 
 ```shell
-npm install @twin.org/crypto-cli
+npm install @twin.org/crypto-cli -g
+twin-crypto
 ```
 
-## Running
-
-If you run the tool with no command line options:
+or run directly using NPX:
 
 ```shell
-twin-crypto
+npx "@twin.org/crypto-cli"
 ```
 
-You should see output similar to the following
+You should see output similar to the following:
 
 ```shell
 🌍 TWIN Crypto v1.0.0

package/docs/reference/classes/CLI.md

@@ -22,63 +22,9 @@ The main entry point for the CLI.
 
 ## Methods
 
-### execute()
-
-> **execute**(`options`, `localesDirectory`, `argv`): `Promise`\<`number`\>
-
-Execute the command line processing.
-
-#### Parameters
-
-• **options**: `ICliOptions`
-
-The options for the CLI.
-
-• **localesDirectory**: `string`
-
-The path to load the locales from.
-
-• **argv**: `string`[]
-
-The process arguments.
-
-#### Returns
-
-`Promise`\<`number`\>
-
-The exit code.
-
-#### Inherited from
-
-`CLIBase.execute`
-
-***
-
-### configureRoot()
-
-> `protected` **configureRoot**(`program`): `void`
-
-Configure any options or actions at the root program level.
-
-#### Parameters
-
-• **program**: `Command`
-
-The root program command.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`CLIBase.configureRoot`
-
-***
-
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
 
 Run the app.
 
@@ -92,6 +38,14 @@ The process arguments.
 
 The directory for the locales, default to relative to the script.
 
+• **options?**
+
+Additional options.
+
+• **options.overrideOutputWidth?**: `number`
+
+Override the output width.
+
 #### Returns
 
 `Promise`\<`number`\>

package/locales/en.json

@@ -32,6 +32,10 @@
 				"env": {
 					"param": "--env '<'filename'>'",
 					"description": "Creates an env file containing the mnemonic and seed."
+				},
+				"env-prefix": {
+					"param": "--env-prefix '<'prefix'>'",
+					"description": "Prefixes the env variables with the value."
 				}
 			},
 			"progress": {
@@ -40,7 +44,8 @@
 			},
 			"labels": {
 				"mnemonic": "Mnemonic",
-				"seed": "Seed"
+				"seed": "Seed",
+				"envPrefix": "Env Prefix"
 			}
 		},
 		"address": {

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/crypto-cli",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.7",
 	"description": "A command line interface for interacting with the crypto tools",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/framework.git",
-		"directory": "packages/crypto-cli"
+		"directory": "apps/crypto-cli"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -13,42 +13,13 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"merge-locales": "merge-locales",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
-		"@twin.org/cli-core": "0.0.1-next.3",
-		"@twin.org/core": "0.0.1-next.3",
-		"@twin.org/crypto": "0.0.1-next.3",
+		"@twin.org/cli-core": "0.0.1-next.7",
+		"@twin.org/core": "0.0.1-next.7",
+		"@twin.org/crypto": "0.0.1-next.7",
 		"@twin.org/nameof": "next",
 		"commander": "12.1.0"
 	},
-	"devDependencies": {
-		"@twin.org/merge-locales": "next",
-		"@twin.org/nameof-transformer": "next",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",