@twin.org/crypto-cli 0.0.3-next.22 → 0.0.3-next.24

package/README.md

@@ -1,16 +1,16 @@
 # TWIN Crypto CLI
 
-A command line interface for interacting with the crypto tools.
+This application is part of the framework workspace and provides command line interface for interacting with the crypto tools to support consistent development workflows across the ecosystem.
 
 ## Installation
 
 ```shell
-npm install @twin.org/crypto-cli
+npm install -D @twin.org/crypto-cli
 ```
 
-## Examples
+## Usage
 
-Usage of the tool is shown in the examples [docs/examples.md](docs/examples.md)
+Usage of the tool is shown in the examples [docs/usage.md](docs/usage.md)
 
 ## Reference
 

package/dist/es/cli.js

@@ -21,8 +21,8 @@ export class CLI extends CLIBase {
         return this.execute({
             title: "TWIN Crypto",
             appName: "twin-crypto",
-            version: "0.0.3-next.22", // x-release-please-version
-            icon: "🌍",
+            version: "0.0.3-next.24", // x-release-please-version
+            icon: "🔒",
             supportsEnvFiles: true,
             overrideOutputWidth: options?.overrideOutputWidth,
             showDevToolWarning: true

package/dist/es/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,OAAO;IAC/B;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,IAAc,EACd,gBAAyB,EACzB,OAA0C;QAE1C,OAAO,IAAI,CAAC,OAAO,CAClB;YACC,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,eAAe,EAAE,2BAA2B;YACrD,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,mBAAmB,EAAE,OAAO,EAAE,mBAAmB;YACjD,kBAAkB,EAAE,IAAI;SACxB,EACD,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,EACzF,IAAI,CACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,OAAgB;QACrC,OAAO,CAAC,oBAAoB,EAAE,EAAE,mBAAmB,EAAE,CAAC,CAAC;IACxD,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { CLIBase } from \"@twin.org/cli-core\";\nimport type { Command } from \"commander\";\nimport { buildCommandAddress } from \"./commands/address.js\";\nimport { buildCommandMnemonic } from \"./commands/mnemonic.js\";\n\n/**\n * The main entry point for the CLI.\n */\nexport class CLI extends CLIBase {\n\t/**\n\t * Run the app.\n\t * @param argv The process arguments.\n\t * @param localesDirectory The directory for the locales, default to relative to the script.\n\t * @param options Additional options.\n\t * @param options.overrideOutputWidth Override the output width.\n\t * @returns The exit code.\n\t */\n\tpublic async run(\n\t\targv: string[],\n\t\tlocalesDirectory?: string,\n\t\toptions?: { overrideOutputWidth?: number }\n\t): Promise<number> {\n\t\treturn this.execute(\n\t\t\t{\n\t\t\t\ttitle: \"TWIN Crypto\",\n\t\t\t\tappName: \"twin-crypto\",\n\t\t\t\tversion: \"0.0.3-next.22\", // x-release-please-version\n\t\t\t\ticon: \"🌍\",\n\t\t\t\tsupportsEnvFiles: true,\n\t\t\t\toverrideOutputWidth: options?.overrideOutputWidth,\n\t\t\t\tshowDevToolWarning: true\n\t\t\t},\n\t\t\tlocalesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), \"../locales\"),\n\t\t\targv\n\t\t);\n\t}\n\n\t/**\n\t * Get the commands for the CLI.\n\t * @param program The main program to add the commands to.\n\t * @internal\n\t */\n\tprotected getCommands(program: Command): Command[] {\n\t\treturn [buildCommandMnemonic(), buildCommandAddress()];\n\t}\n}\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,OAAO;IAC/B;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,IAAc,EACd,gBAAyB,EACzB,OAA0C;QAE1C,OAAO,IAAI,CAAC,OAAO,CAClB;YACC,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,eAAe,EAAE,2BAA2B;YACrD,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,mBAAmB,EAAE,OAAO,EAAE,mBAAmB;YACjD,kBAAkB,EAAE,IAAI;SACxB,EACD,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,EACzF,IAAI,CACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,OAAgB;QACrC,OAAO,CAAC,oBAAoB,EAAE,EAAE,mBAAmB,EAAE,CAAC,CAAC;IACxD,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { CLIBase } from \"@twin.org/cli-core\";\nimport type { Command } from \"commander\";\nimport { buildCommandAddress } from \"./commands/address.js\";\nimport { buildCommandMnemonic } from \"./commands/mnemonic.js\";\n\n/**\n * The main entry point for the CLI.\n */\nexport class CLI extends CLIBase {\n\t/**\n\t * Run the app.\n\t * @param argv The process arguments.\n\t * @param localesDirectory The directory for the locales, default to relative to the script.\n\t * @param options Additional options.\n\t * @param options.overrideOutputWidth Override the output width.\n\t * @returns The exit code.\n\t */\n\tpublic async run(\n\t\targv: string[],\n\t\tlocalesDirectory?: string,\n\t\toptions?: { overrideOutputWidth?: number }\n\t): Promise<number> {\n\t\treturn this.execute(\n\t\t\t{\n\t\t\t\ttitle: \"TWIN Crypto\",\n\t\t\t\tappName: \"twin-crypto\",\n\t\t\t\tversion: \"0.0.3-next.24\", // x-release-please-version\n\t\t\t\ticon: \"🔒\",\n\t\t\t\tsupportsEnvFiles: true,\n\t\t\t\toverrideOutputWidth: options?.overrideOutputWidth,\n\t\t\t\tshowDevToolWarning: true\n\t\t\t},\n\t\t\tlocalesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), \"../locales\"),\n\t\t\targv\n\t\t);\n\t}\n\n\t/**\n\t * Get the commands for the CLI.\n\t * @param program The main program to add the commands to.\n\t * @internal\n\t */\n\tprotected getCommands(program: Command): Command[] {\n\t\treturn [buildCommandMnemonic(), buildCommandAddress()];\n\t}\n}\n"]}

package/docs/changelog.md

@@ -1,4 +1,48 @@
-# @twin.org/crypto-cli - Changelog
+# Changelog
+
+## [0.0.3-next.24](https://github.com/twinfoundation/framework/compare/crypto-cli-v0.0.3-next.23...crypto-cli-v0.0.3-next.24) (2026-03-19)
+
+
+### Bug Fixes
+
+* ensure __decorate is defined for decorators ([103a563](https://github.com/twinfoundation/framework/commit/103a563ce01ebdef6240d2e590e7b026e8692684))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/cli-core bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/core bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/crypto bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/nameof bumped from 0.0.3-next.23 to 0.0.3-next.24
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.23 to 0.0.3-next.24
+    * @twin.org/validate-locales bumped from 0.0.3-next.23 to 0.0.3-next.24
+
+## [0.0.3-next.23](https://github.com/twinfoundation/framework/compare/crypto-cli-v0.0.3-next.22...crypto-cli-v0.0.3-next.23) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **crypto-cli:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/cli-core bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/core bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/crypto bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof bumped from 0.0.3-next.22 to 0.0.3-next.23
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/validate-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
 
 ## [0.0.3-next.22](https://github.com/twinfoundation/framework/compare/crypto-cli-v0.0.3-next.21...crypto-cli-v0.0.3-next.22) (2026-02-26)
 

package/docs/reference/classes/CLI.md

@@ -22,7 +22,69 @@ The main entry point for the CLI.
 
 ## Methods
 
-### run()
+### execute() {#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() {#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}
 
 > **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
 

package/docs/{examples.md → usage.md}

@@ -1,4 +1,6 @@
-# @twin.org/crypto-cli - Examples
+# Crypto CLI Usage
+
+Use this guide to run commands, inspect options and check expected terminal output before automation.
 
 ## Running
 
@@ -33,9 +35,7 @@ Commands:
   help [command]      display help for command
 ```
 
-## Command
-
-### mnemonic
+## Mnemonic Output
 
 The mnemonic command can be used to generate a new mnemonic for use in the other crypto functions.
 
@@ -78,7 +78,7 @@ Options:
   -h, --help              display help for command
 ```
 
-#### Example
+### Example
 
 To output generate mnemonic and base64 formatted seed, store them in a JSON and env file but not display them to the console you would enter the following.
 
@@ -102,7 +102,7 @@ and the JSON file would be:
 }
 ```
 
-### address
+## Address Output
 
 The address command can be used to generate addresses and key pairs based on the specified seed. The seed can be provided from the command line of read from an environment variable or .env file. By default 10 addresses will be generated starting at address index 0, for account 0.
 
@@ -209,7 +209,7 @@ Options:
   -h, --help             display help for command
 ```
 
-#### Examples
+### Examples
 
 To read from an env file and load the variable named SEED from the file, and output only 2 addresses, outputting the keys in base64 format.
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/crypto-cli",
-	"version": "0.0.3-next.22",
-	"description": "A command line interface for interacting with the crypto tools",
+	"version": "0.0.3-next.24",
+	"description": "Command line interface for interacting with the crypto tools",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/framework.git",
@@ -14,11 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/cli-core": "0.0.3-next.22",
-		"@twin.org/core": "0.0.3-next.22",
-		"@twin.org/crypto": "0.0.3-next.22",
-		"@twin.org/nameof": "0.0.3-next.22",
-		"commander": "14.0.2"
+		"@twin.org/cli-core": "0.0.3-next.24",
+		"@twin.org/core": "0.0.3-next.24",
+		"@twin.org/crypto": "0.0.3-next.24",
+		"@twin.org/nameof": "0.0.3-next.24",
+		"commander": "14.0.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",