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

package/dist/locales/en.json

@@ -0,0 +1,312 @@
+{
+  "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}\""
+      },
+      "common": {
+        "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+        "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
+        "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
+        "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
+        "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
+        "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
+        "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
+      }
+    },
+    "validation": {
+      "beEmpty": "{fieldName} must be empty",
+      "beNotEmpty": "{fieldName} must not be empty",
+      "beText": "{fieldName} must be text",
+      "beTextValue": "{fieldName} must contain some text",
+      "beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
+      "beTextMin": "{fieldName} must be longer than {minLength} characters",
+      "beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+      "beNumber": "{fieldName} must be a number",
+      "beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
+      "beNumberMin": "{fieldName} must be >= {minValue}",
+      "beNumberMax": "{fieldName} must be <= {maxValue}",
+      "beWholeNumber": "{fieldName} must be a whole number",
+      "beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
+      "beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
+      "beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
+      "beBigInteger": "{fieldName} must be a bigint",
+      "beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
+      "beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
+      "beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
+      "beBoolean": "{fieldName} must be true or false",
+      "beDate": "{fieldName} must be a date",
+      "beDateTime": "{fieldName} must be a date/time",
+      "beTime": "{fieldName} must be a time",
+      "beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
+      "beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
+      "beObject": "{fieldName} must be an object",
+      "beArray": "{fieldName} must be an array",
+      "beArrayValue": "{fieldName} must be an array with at least one item",
+      "beIncluded": "{fieldName} is unrecognised",
+      "beByteArray": "{fieldName} must be a byte array",
+      "beUrn": "{fieldName} must be a correctly formatted urn",
+      "beUrl": "{fieldName} must be a correctly formatted url",
+      "beJSON": "{fieldName} must be correctly formatted JSON",
+      "beEmail": "{fieldName} must be a correctly formatted e-mail address",
+      "failed": "Validation failed",
+      "failedObject": "Validation of \"{objectName}\" failed"
+    },
+    "guard": {
+      "undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
+      "string": "Property \"{property}\" must be a string, it is \"{value}\"",
+      "stringEmpty": "Property \"{property}\" must have a value, it is empty",
+      "stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
+      "stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+      "stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
+      "stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+      "number": "Property \"{property}\" must be a number, it is \"{value}\"",
+      "integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
+      "bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
+      "boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
+      "date": "Property \"{property}\" must be a date, it is \"{value}\"",
+      "timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
+      "timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
+      "objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
+      "object": "Property \"{property}\" must be an object, it is \"{value}\"",
+      "objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
+      "array": "Property \"{property}\" must be an array, it is \"{value}\"",
+      "arrayValue": "Property \"{property}\" must be an array with at least one item",
+      "arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+      "uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
+      "function": "Property \"{property}\" must be a function, it is \"{value}\"",
+      "urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
+      "url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
+      "email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
+      "length32Multiple": "Property \"{property}\" should be a multiple of 32, it is {value}",
+      "lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}",
+      "length3Multiple": "Property \"{property}\" should be a multiple of 3, it is {value}",
+      "greaterThan0": "Property \"{property}\" must be greater than zero, it is {value}"
+    },
+    "objectHelper": {
+      "failedBytesToJSON": "Failed converting bytes to JSON"
+    },
+    "common": {
+      "notImplementedMethod": "The method \"{method}\" has not been implemented",
+      "validation": "Validation failed"
+    },
+    "factory": {
+      "noUnregister": "There is no {typeName} registered with the name \"{name}\"",
+      "noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
+    },
+    "bitString": {
+      "outOfRange": "The index should be >= 0 and less than the length of the bit string"
+    },
+    "bip39": {
+      "missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
+      "checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
+    },
+    "ed25519": {
+      "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+      "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+    },
+    "secp256k1": {
+      "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+      "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+    },
+    "x25519": {
+      "invalidPublicKey": "Invalid Ed25519 Public Key"
+    },
+    "blake2b": {
+      "outputLength64": "The output length should be between 1 and 64, it is \"{outputLength}\"",
+      "keyLength64": "The key length should be between 1 and 64, it is \"{keyLength}\""
+    },
+    "sha512": {
+      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+    },
+    "sha256": {
+      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+    },
+    "hmacSha256": {
+      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+    },
+    "hmacSha512": {
+      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+    },
+    "base32": {
+      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+    },
+    "base64": {
+      "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+    },
+    "bech32": {
+      "decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
+      "invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
+      "separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
+      "lowerUpper": "The address my use either lowercase or uppercase, \"{bech32}\"",
+      "dataTooShort": "The address does not contain enough data to decode, \"{bech32}\""
+    },
+    "pbkdf2": {
+      "keyTooLong": "The requested key length \"{keyLength}\" is too long, based on the \"{macLength}\""
+    },
+    "chaCha20Poly1305": {
+      "noAadWithData": "You can not set the aad when there is already data",
+      "noAuthTag": "Can not finalise when the auth tag is not set",
+      "authenticationFailed": "The data could not be authenticated",
+      "authTagDecrypting": "Can not get the auth tag when decrypting",
+      "authTagEncrypting": "Can not set the auth tag when encrypting",
+      "noAuthTagSet": "The auth tag has not been set"
+    },
+    "bip44": {
+      "unsupportedKeyType": "The key type \"{keyType}\" is not supported"
+    },
+    "slip0010": {
+      "invalidSeed": "The seed is invalid \"{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"
+      }
+    }
+  },
+  "cli": {
+    "progress": {
+      "done": "Done.",
+      "error": "Error",
+      "loadingEnvFiles": "Loading env files",
+      "pleaseWait": "Please wait...",
+      "writingJsonFile": "Writing JSON file",
+      "writingEnvFile": "Writing env file",
+      "readingJsonFile": "Reading JSON file",
+      "readingEnvFile": "Reading env file"
+    },
+    "options": {
+      "lang": {
+        "param": "--lang '<'lang'>'",
+        "description": "The language to display the output in."
+      },
+      "load-env": {
+        "param": "--load-env [env...]",
+        "description": "Load the env files to initialise any environment variables."
+      },
+      "no-console": {
+        "param": "--no-console",
+        "description": "Hides the output in the console."
+      },
+      "json": {
+        "param": "--json '<'filename'>'",
+        "description": "Creates a JSON file containing the output."
+      },
+      "env": {
+        "param": "--env '<'filename'>'",
+        "description": "Creates an env file containing the output."
+      },
+      "merge-json": {
+        "param": "--merge-json",
+        "description": "If the JSON file already exists merge the data instead of overwriting."
+      },
+      "merge-env": {
+        "param": "--merge-env",
+        "description": "If the env file already exists merge the data instead of overwriting."
+      }
+    }
+  },
+  "errorNames": {
+    "error": "Error",
+    "generalError": "General",
+    "guardError": "Guard",
+    "conflictError": "Conflict",
+    "notFoundError": "Not Found",
+    "notSupportedError": "Not Supported",
+    "alreadyExistsError": "Already Exists",
+    "notImplementedError": "Not Implemented",
+    "validationError": "Validation",
+    "unprocessableError": "Unprocessable"
+  },
+  "validation": {
+    "defaultFieldName": "The field"
+  }
+}

package/dist/types/cli.d.ts

@@ -0,0 +1,13 @@
+import { CLIBase } from "@twin.org/cli-core";
+/**
+ * The main entry point for the CLI.
+ */
+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.
+     * @returns The exit code.
+     */
+    run(argv: string[], localesDirectory?: string): Promise<number>;
+}

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

@@ -0,0 +1,29 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the address command to be consumed by the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandAddress(): Command;
+/**
+ * Action the address command.
+ * @param opts The options for the command.
+ * @param opts.seed The seed for generating the addresses.
+ * @param opts.start The start index for the address generation.
+ * @param opts.count The number of addresses to generate.
+ * @param opts.account The account index for the address generation.
+ * @param opts.hrp The human readable part for the address.
+ * @param opts.coin The coin type for the address.
+ * @param opts.keyType The key type for the address.
+ * @param opts.keyFormat The output format of the key.
+ */
+export declare function actionCommandAddress(opts: {
+    seed: string;
+    start: string;
+    count: string;
+    account: string;
+    hrp: string;
+    coin: string;
+    keyType: "Ed25519" | "Secp256k1";
+    keyFormat: "hex" | "base64";
+} & CliOutputOptions): Promise<void>;

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

@@ -0,0 +1,17 @@
+import { type CliOutputOptions } from "@twin.org/cli-core";
+import { Command } from "commander";
+/**
+ * Build the mnemonic command to be consumed by the CLI.
+ * @returns The command.
+ */
+export declare function buildCommandMnemonic(): Command;
+/**
+ * Action the mnemonic command.
+ * @param opts The options for the command.
+ * @param opts.strength The mnemonic strength.
+ * @param opts.seedFormat The output format of the seed.
+ */
+export declare function actionCommandMnemonic(opts: {
+    strength: string;
+    seedFormat: "hex" | "base64";
+} & CliOutputOptions): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./cli";
+export * from "./commands/address";
+export * from "./commands/mnemonic";

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1,258 @@
+# @twin.org/crypto-cli - Examples
+
+## Command Line Tool
+
+First install the tool with the following script.
+
+```shell
+npm install @twin.org/crypto-cli
+```
+
+## Running
+
+If you run the tool with no command line options:
+
+```shell
+twin-crypto
+```
+
+You should see output similar to the following
+
+```shell
+🌍 TWIN Crypto v1.0.0
+
+Usage: twin-crypto [command]
+
+Options:
+  -V, --version       output the version number
+  --lang <lang>       The language to display the output in. (default: "en")
+  -h, --help          display help for command
+
+Commands:
+  mnemonic [options]  Create a mnemonic.
+  address [options]   Create bech32 addresses and keys from the seed.
+  help [command]      display help for command
+```
+
+## Command
+
+### mnemonic
+
+The mnemonic command can be used to generate a new mnemonic for use in the other crypto functions.
+
+```shell
+twin-crypto mnemonic
+```
+
+Output
+
+```shell
+🌍 TWIN Crypto v1.0.0
+
+Mnemonic: cricket pumpkin clump warrior accident appear trophy exchange width ginger thank common must tiny inform feed orient ritual tackle tortoise few survey client object
+Seed: 0x01fb73209537a33a2f03e419caed0eba48005b093b9a8ce35a93f5e3a1ad66ceaccb1afd4cd23ccaef3f0210e377a5118c90c7a5f1800be49a42d1c3dc0bb3fc
+
+Done.
+```
+
+There are additional options you can specify for this command, to get the detail on these options issue the following command to get help.
+
+```shell
+twin-crypto mnemonic --help
+```
+
+Output
+
+```shell
+🌍 TWIN Crypto v1.0.0
+
+Usage: twin-crypto mnemonic [options]
+
+Create a mnemonic, will also generate the equivalent seed in hex and base64 format.
+
+Options:
+  --strength <number>     The number of words in the mnemonic, defaults to 256 which produces 24 words. (default: "256")
+  --seed-format <format>  The format to output the seed. (choices: "hex", "base64", default: "hex")
+  --no-console            Hides the mnemonic and seed in the console.
+  --json <filename>       Creates a JSON file containing the mnemonic and seed.
+  --env <filename>        Creates an env file containing the mnemonic and seed.
+  -h, --help              display help for command
+```
+
+#### 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.
+
+```shell
+twin-crypto mnemonic --seed-format base64 --no-console --json my.json --env my.env
+```
+
+The env file would look like:
+
+```shell
+MNEMONIC="word maze network cabbage romance empty axis scale vintage ride flash soup jelly cook give luxury rigid cigar noodle avocado current write clog little"
+SEED="c/MkRa4rgvvf08nJy2v4Yadip5BpE56FW2jDXmjt4TMfoXrCoYo9Hunq9SQdabh+Mox0vR9J3INoVLCZPQ/UtA=="
+```
+
+and the JSON file would be:
+
+```json
+{
+  "mnemonic": "word maze network cabbage romance empty axis scale vintage ride flash soup jelly cook give luxury rigid cigar noodle avocado current write clog little",
+  "seed": "c/MkRa4rgvvf08nJy2v4Yadip5BpE56FW2jDXmjt4TMfoXrCoYo9Hunq9SQdabh+Mox0vR9J3INoVLCZPQ/UtA=="
+}
+```
+
+### address
+
+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.
+
+```shell
+twin-crypto address --seed 0x01fb73209537a33a2f03e419caed0eba48005b093b9a8ce35a93f5e3a1ad66ceaccb1afd4cd23ccaef3f0210e377a5118c90c7a5f1800be49a42d1c3dc0bb3fc
+```
+
+Output
+
+```shell
+🌍 TWIN Crypto v1.0.0
+
+Seed: 0x01fb73209537a33a2f03e419caed0eba48005b093b9a8ce35a93f5e3a1ad66ceaccb1afd4cd23ccaef3f0210e377a5118c90c7a5f1800be49a42d1c3dc0bb3fc
+Start: 0
+Count: 10
+Account: 0
+HRP: iota
+Coin: 4218
+Key Type: Ed25519
+Key Format: hex
+
+Generating addresses
+
+Index: 0
+Address: iota1qzl6pvdadahge7yyqdyknrutuwnjafntdjlnfv94vndue9qupkr9224vjv7
+Private Key: 0xa72161f8b9714c8382bcb7f72a5ea178880495fa85b1376a138249aaf1b2e837
+Public Key: 0xe6994b391c937a604315a9936393f0ef1ad2d49bf5f21573316dc024c1dcb3ae
+
+Index: 1
+Address: iota1qq0hu7h6aguva0z0zlayukdjpq3x5dkvyt4gz5gxd7tvuye70sgqv55tgqd
+Private Key: 0xcc57b040833465b530cd87e0c427162a7313f41e15484ef74f641cbb4739d376
+Public Key: 0xcfee67931921b9cf86dbb7f91807b27a275f57364e71d849b86bfc8f671d0f32
+
+Index: 2
+Address: iota1qpqeq9xrnz7w7wenfa2ku02p73a90cpz6h7lprz458ydxjtsy009sutjley
+Private Key: 0x254c4ac4ec71e69bfb244052f8e96435aeefe9da0b0cb432f490fadd51576c49
+Public Key: 0x9fc74352fd77f3c49d714eb67339195a291f6e56bdfca9224962815fac3edc62
+
+Index: 3
+Address: iota1qzj5chjj2r6es9m50ssy22adlkankz2cf4gch7gs76mnq4l2c4dck53p87a
+Private Key: 0x9a58e95dc70b77afa5ac93c5b4af890159c0ca8a69a1971181ba1f4a021edd57
+Public Key: 0x42f8ab19112418266e7b84edaa63e12e4ef08106d8ccceb930f0956203532363
+
+Index: 4
+Address: iota1qzyyqzdcpufrpg2h8n4ljmzgzcsf0vcym6c7rv8l08s7rufjj2pkzefpl6f
+Private Key: 0xff4ed1b01af12a6b87e9b95a7cdecab4be3ba920e8090457189e0f7b9cff2704
+Public Key: 0x19ebdb080b0b8b485249c18ebc841d574429c994830cda139d84b14bf5f92025
+
+Index: 5
+Address: iota1qpuq48kqkk582l4c2l0gx9vrmdnfh69rrr2xdusnl25htwy6j4s4jt5vqe8
+Private Key: 0x3445b21235ec0d35c7b9030262ad361101c08d57cda5d6c8a9a427a8b7c7fa17
+Public Key: 0xb01632576d4f8fbddebc3bc624e2d5beb41f0352a22a7b8aa7895e4e746e4979
+
+Index: 6
+Address: iota1qpvn3wgyfm4t78ad9qpdee3dwmcsp5h5k8c6saundlf8f0e5apyhs5xam7e
+Private Key: 0x35e609b27328f02cbf944e256d26b50259af571614f491b5823ac794ec23dd40
+Public Key: 0x6156dbd30118e3e9b65dfdbfcdd8d33a5397e1e83eb5ca9271088189eae725d6
+
+Index: 7
+Address: iota1qrvx8r3tch4nufjrwrdes5rgl4ak8qx445532z0rmynrz4j2fa05uwlegwf
+Private Key: 0x512f34563657f31f93f6ff675a5cc2bdecb60c04f70c1e6989600bec709bfe81
+Public Key: 0xeaecd2c8c1b0a5e76e740b65189ae69acdcbe2555343b3bfbd5230873d7d367e
+
+Index: 8
+Address: iota1qqeyes0f5nqpe5t86slkph2nufj2e496eexyfxec3q7lu45veyvtcp9tz47
+Private Key: 0xf2249753e80bb53776dccae45195bd36079f17ecd758eb71c0ce3d30d39248e9
+Public Key: 0xd744fe270e65f348fda0761f05df3c597afd85dfa3a2d57ba468a62dae89d658
+
+Index: 9
+Address: iota1qrdxdv0uqpy6pwlgp8j5wdscj88jrwxzuhye6z2tzkrqp5l65kk2spzplej
+Private Key: 0x3bfb352e637ef067866e66974647d3758d80629dd1108f77956487da9ace80d9
+Public Key: 0x9d10790d366deb6a73ea7666318cf46c8f5493346fc32865edbc3beda15872c6
+
+Done.
+```
+
+There are additional options you can specify for this command, to get the detail on these options issue the following command to get help.
+
+```shell
+twin-crypto address --help
+```
+
+Output
+
+```shell
+🌍 TWIN Crypto v1.0.0
+
+sage: twin-crypto address [options]
+
+Create a number of bech32 addresses and their associated key pairs from the seed.
+
+Options:
+  --seed <seed>          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 !
+  --load-env <env>       Load the env file to initialise any environment variables.
+  --start <number>       The index of the first address to create. (default: "0")
+  --count <number>       The number of addresses to create, max 100. (default: "10")
+  --account <number>     The account used to generate the bech32 addresses. (default: "0")
+  --hrp <hrp>            The human readable part of the bech32 addresses. (default: "iota")
+  --coin <coin>          The coin type used to generate the bech32 addresses. (default: "4218")
+  --key-type <type>      The type of key to generate. (choices: "Ed25519", "Secp256k1", default: "Ed25519")
+  --key-format <format>  The format to output the keys. (choices: "hex", "base64", default: "hex")
+  --no-console           Hides the addresses and keys in the console.
+  --json <filename>      Creates a JSON file containing the addresses and keys.
+  --merge-json           If the JSON file already exists merge the data instead of overwriting.
+  --env <filename>       Creates an env file containing the addresses and keys.
+  --merge-env            If the env file already exists merge the data instead of overwriting.
+  -h, --help             display help for command
+```
+
+#### 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.
+
+```shell
+twin-crypto address --load-env my.env --seed !SEED --count 2 --key-format base64
+```
+
+You can use the options to store the results in JSON or env files, and the `merge` options allow you to modify existing files should you wish.
+
+```shell
+twin-crypto address --load-env my.env --seed !SEED --env address.env --merge-env --json address.json --merge-json
+```
+
+The output of this command would produce address.env
+
+```shell
+ADDRESS_0_BECH32="iota1qqcpqyrnqtzteu7k26dgjvjp3x76tts526prtwrjq99v50pyv6l9xysdcg8"
+ADDRESS_0_PRIVATE_KEY="0x3b2863db878ce156a46d2142c72baa7807a40a990684604ff86456821228d978"
+ADDRESS_0_PUBLIC_KEY="0x6b6eb9e54b44bfbc65c4a02c6489609fbc9588e640ca44bfdfdb1af4e5874905"
+ADDRESS_1_BECH32="iota1qrqyyyuhfzgrp7ducjapg8pta3w877nu0u5jpe50cxx39qjs08kczw7uj4v"
+ADDRESS_1_PRIVATE_KEY="0xc5038b4c0b1dc46769687e77555a7be176e22de4262cf5aabf11290ab7c8d856"
+ADDRESS_1_PUBLIC_KEY="0x603d9b2d25341d142524867536e3ee94d3e02a45fe498ec4c3473b0449446d77"
+....
+```
+
+and address.json
+
+```json
+{
+  "0": {
+    "bech32": "iota1qqcpqyrnqtzteu7k26dgjvjp3x76tts526prtwrjq99v50pyv6l9xysdcg8",
+    "privateKey": "0x3b2863db878ce156a46d2142c72baa7807a40a990684604ff86456821228d978",
+    "publicKey": "0x6b6eb9e54b44bfbc65c4a02c6489609fbc9588e640ca44bfdfdb1af4e5874905"
+  },
+  "1": {
+    "bech32": "iota1qrqyyyuhfzgrp7ducjapg8pta3w877nu0u5jpe50cxx39qjs08kczw7uj4v",
+    "privateKey": "0xc5038b4c0b1dc46769687e77555a7be176e22de4262cf5aabf11290ab7c8d856",
+    "publicKey": "0x603d9b2d25341d142524867536e3ee94d3e02a45fe498ec4c3473b0449446d77"
+  },
+  ...
+}
+```