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

package/docs/reference/classes/CLI.md

@@ -0,0 +1,99 @@
+# Class: CLI
+
+The main entry point for the CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### new CLI()
+
+> **new CLI**(): [`CLI`](CLI.md)
+
+#### Returns
+
+[`CLI`](CLI.md)
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## 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 the app.
+
+#### Parameters
+
+• **argv**: `string`[]
+
+The process arguments.
+
+• **localesDirectory?**: `string`
+
+The directory for the locales, default to relative to the script.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.

package/docs/reference/functions/actionCommandAddress.md

@@ -0,0 +1,15 @@
+# Function: actionCommandAddress()
+
+> **actionCommandAddress**(`opts`): `Promise`\<`void`\>
+
+Action the address command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/actionCommandMnemonic.md

@@ -0,0 +1,15 @@
+# Function: actionCommandMnemonic()
+
+> **actionCommandMnemonic**(`opts`): `Promise`\<`void`\>
+
+Action the mnemonic command.
+
+## Parameters
+
+• **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/buildCommandAddress.md

@@ -0,0 +1,11 @@
+# Function: buildCommandAddress()
+
+> **buildCommandAddress**(): `Command`
+
+Build the address command to be consumed by the CLI.
+
+## Returns
+
+`Command`
+
+The command.

package/docs/reference/functions/buildCommandMnemonic.md

@@ -0,0 +1,11 @@
+# Function: buildCommandMnemonic()
+
+> **buildCommandMnemonic**(): `Command`
+
+Build the mnemonic command to be consumed by the CLI.
+
+## Returns
+
+`Command`
+
+The command.

package/docs/reference/index.md

@@ -0,0 +1,12 @@
+# @twin.org/crypto-cli
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Functions
+
+- [buildCommandAddress](functions/buildCommandAddress.md)
+- [actionCommandAddress](functions/actionCommandAddress.md)
+- [buildCommandMnemonic](functions/buildCommandMnemonic.md)
+- [actionCommandMnemonic](functions/actionCommandMnemonic.md)

package/locales/en.json

@@ -0,0 +1,102 @@
+{
+	"error": {
+		"commands": {
+			"address": {
+				"seedMissingEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there is no environment variable with the name \"{env}\" set.",
+				"seedInvalidEnv": "The seed does not appear to be hex or base64, assuming it is an environment variable, but there the environment variable is neither hex or base64. \"{envValue}\"",
+				"seedInvalidFormat": "The seed does not appear to be hex, base64 or an environment variable. \"{seed}\""
+			}
+		}
+	},
+	"commands": {
+		"mnemonic": {
+			"summary": "Create a mnemonic.",
+			"description": "Create a mnemonic, will also generate the equivalent seed in hex and base64 format.",
+			"options": {
+				"strength": {
+					"param": "--strength '<'number'>'",
+					"description": "The number of words in the mnemonic, defaults to 256 which produces 24 words."
+				},
+				"seed-format": {
+					"param": "--seed-format '<'format'>'",
+					"description": "The format to output the seed."
+				},
+				"no-console": {
+					"param": "--no-console",
+					"description": "Hides the mnemonic and seed in the console."
+				},
+				"json": {
+					"param": "--json '<'filename'>'",
+					"description": "Creates a JSON file containing the mnemonic and seed."
+				},
+				"env": {
+					"param": "--env '<'filename'>'",
+					"description": "Creates an env file containing the mnemonic and seed."
+				}
+			},
+			"progress": {
+				"writingJsonFile": "Writing JSON file",
+				"writingEnvFile": "Writing env file"
+			},
+			"labels": {
+				"mnemonic": "Mnemonic",
+				"seed": "Seed"
+			}
+		},
+		"address": {
+			"summary": "Create bech32 addresses and keys from the seed.",
+			"description": "Create a number of bech32 addresses and their associated key pairs from the seed.",
+			"options": {
+				"seed": {
+					"param": "--seed '<'seed'>'",
+					"description": "The seed to use for generating the addresses, this can be either hex, base64 or an environment variable name. For an environment variable start the value with a !"
+				},
+				"start": {
+					"param": "--start '<'number'>'",
+					"description": "The index of the first address to create."
+				},
+				"count": {
+					"param": "--count '<'number'>'",
+					"description": "The number of addresses to create, max 100."
+				},
+				"account": {
+					"param": "--account '<'number'>'",
+					"description": "The account used to generate the bech32 addresses."
+				},
+				"hrp": {
+					"param": "--hrp '<'hrp'>'",
+					"description": "The human readable part of the bech32 addresses."
+				},
+				"coin": {
+					"param": "--coin '<'coin'>'",
+					"description": "The coin type used to generate the bech32 addresses."
+				},
+				"key-type": {
+					"param": "--key-type '<'type'>'",
+					"description": "The type of key to generate."
+				},
+				"key-format": {
+					"param": "--key-format '<'format'>'",
+					"description": "The format to output the keys."
+				}
+			},
+			"progress": {
+				"generatingAddresses": "Generating addresses"
+			},
+			"labels": {
+				"seed": "Seed",
+				"start": "Start",
+				"count": "Count",
+				"account": "Account",
+				"hrp": "HRP",
+				"coin": "Coin",
+				"key-type": "Key Type",
+				"key-format": "Key Format",
+				"index": "Index",
+				"address": "Address",
+				"public-key": "Public Key",
+				"private-key": "Private Key"
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+	"name": "@twin.org/crypto-cli",
+	"version": "0.0.1-next.3",
+	"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"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"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/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",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/locales",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"twin-crypto": "bin/index.js"
+	}
+}