@twin.org/nft-cli 0.0.1-next.3 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -349,16 +349,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 for the CLI.
+     * @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 NFT",
             appName: "twin-nft",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.5",
             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

@@ -346,15 +346,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 for the CLI.
+     * @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 NFT",
             appName: "twin-nft",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.5",
             icon: "🌍",
-            supportsEnvFiles: true
+            supportsEnvFiles: true,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
     }
     /**

package/dist/locales/en.json

@@ -148,6 +148,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": {
@@ -156,7 +160,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 for the CLI.
+     * @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/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/nft-cli - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.5
 
 - Initial Release

package/docs/examples.md

@@ -1,20 +1,21 @@
 # @twin.org/nft-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/nft-cli
+npm install @twin.org/nft-cli -g
+twin-nft
 ```
 
-Running the tool with no commands will provide help for all the commands. By issuing the following command you should see the result.
+or run directly using NPX:
 
 ```shell
-twin-nft
+npx "@twin.org/nft-cli"
 ```
 
-Output
+You should see output similar to the following:
 
 ```shell
 🌍 TWIN NFT v1.0.0

package/docs/reference/classes/CLI.md

@@ -24,7 +24,7 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
 
 Run the app.
 
@@ -38,6 +38,14 @@ The process arguments.
 
 The directory for the locales, default to relative to the script.
 
+• **options?**
+
+Additional options for the CLI.
+
+• **options.overrideOutputWidth?**: `number`
+
+Override the output width.
+
 #### Returns
 
 `Promise`\<`number`\>

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/nft-cli",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.5",
 	"description": "A command line interface for interacting with the nft connectors",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/nft.git",
-		"directory": "packages/nft-cli"
+		"directory": "apps/nft-cli"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -13,49 +13,20 @@
 	"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": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
-		"@twin.org/cli-core": "next",
 		"@twin.org/crypto-cli": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-memory": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/nft-connector-iota": "0.0.1-next.3",
+		"@twin.org/nft-connector-iota": "0.0.1-next.5",
 		"@twin.org/vault-connector-entity-storage": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-cli": "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.22.0",
-		"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",