@twin.org/crypto-cli 0.0.3-next.4 → 0.0.3-next.40

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,10 +1,10 @@
 {
 	"name": "@twin.org/crypto-cli",
-	"version": "0.0.3-next.4",
-	"description": "A command line interface for interacting with the crypto tools",
+	"version": "0.0.3-next.40",
+	"description": "Command line interface for interacting with the crypto tools",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/framework.git",
+		"url": "git+https://github.com/iotaledger/framework.git",
 		"directory": "apps/crypto-cli"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,11 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/cli-core": "0.0.3-next.4",
-		"@twin.org/core": "0.0.3-next.4",
-		"@twin.org/crypto": "0.0.3-next.4",
-		"@twin.org/nameof": "0.0.3-next.4",
-		"commander": "14.0.2"
+		"@twin.org/cli-core": "0.0.3-next.40",
+		"@twin.org/core": "0.0.3-next.40",
+		"@twin.org/crypto": "0.0.3-next.40",
+		"@twin.org/nameof": "0.0.3-next.40",
+		"commander": "14.0.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -52,7 +52,7 @@
 		"security"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/framework/issues"
+		"url": "git+https://github.com/iotaledger/framework/issues"
 	},
 	"homepage": "https://twindev.org"
 }