@aptos-labs/aptos-cli 1.0.2 → 1.1.1

package/README.md

@@ -1,3 +1,75 @@
-# aptos-cli
+# Aptos CLI
 
-This package allows you to use the Aptos CLI from inside a JS / TS project.
+The `@aptos-labs/aptos-cli` package allows you to use the Aptos CLI from inside a `Nodejs` project.
+
+## Download
+
+To install the Aptos CLI, you need to have Node.js and npm installed on your system. Then, you can install it using:
+
+```bash
+npm install @aptos-labs/aptos-cli
+```
+
+That command will download the Aptos CLI and create a Node bin file, making it available to use in a Node environment.
+
+## Install
+
+Once you have the package installed and the Node bin file, you can run the following command, in your project environment, to install the Aptos CLI in your project:
+
+```bash
+npx aptos --install
+```
+
+Alternatively, you can simply run the cli using the `npx aptos` command. That will install the Aptos CLI in your project if it's not already installed.
+
+```bash
+npx aptos
+```
+
+## Usage
+
+To use the Aptos CLI, in your project environment, run the `npx aptos` command, to see the available commands.
+
+```bash
+npx aptos
+```
+
+### Using a Custom Binary
+
+If you already have the Aptos CLI binary installed on your system, you can specify its path to use it directly:
+
+```bash
+npx aptos --binary-path /path/to/aptos <command>
+```
+
+## Updating the Aptos CLI
+
+To update the Aptos CLI, you can run the following command within your project environment:
+
+```bash
+npx aptos --update
+```
+
+## Development
+
+To set up the project for development:
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Run the development server:
+   ```bash
+   npm run dev
+   ```
+
+This will build the project and run the CLI.
+
+## Building
+
+To build the project:
+
+```bash
+npm run build
+```

package/bin/aptos.ts

@@ -19,6 +19,7 @@ program
   .helpOption(false)
   .option("-i, --install", "install the latest version of the CLI")
   .option("-u, --update", "update the CLI to the latest version")
+  .option("-b, --binary-path <path>", "path to an existing Aptos CLI binary")
   .allowUnknownOption();
 
 program.parse(process.argv);
@@ -27,13 +28,14 @@ const main = async () => {
   const options = {
     install: program.opts().install,
     update: program.opts().update,
+    binaryPath: program.opts().binaryPath,
   };
   const unknownOptions = program.args;
 
   // Manually check for `--help` and handle the CLI `--help`
   if (process.argv.includes("--help")) {
     // Forward to the CLI
-    return runCLI(unknownOptions);
+    return runCLI(unknownOptions, options.binaryPath);
   }
 
   await parseCommandOptions(options, unknownOptions);

package/bin/tasks/run.ts

@@ -4,9 +4,13 @@ import { existsSync } from "fs";
 import { getOS } from "../utils/getUserOs.js";
 import { getLocalBinPath } from "../utils/getLocalBinPath.js";
 
-export const runCLI = async (args: string[] = []) => {
-  const path = getLocalBinPath();
+export const runCLI = async (args: string[] = [], binaryPath?: string) => {
+  const path = binaryPath || getLocalBinPath();
   if (!existsSync(path)) {
+    if (binaryPath) {
+      console.error(`Error: Binary not found at specified path: ${binaryPath}`);
+      process.exit(1);
+    }
     console.log(
       "Aptos CLI not installed, run `npx aptos --install` to install"
     );

package/bin/tasks/update.ts

@@ -33,7 +33,7 @@ export const updateCli = async () => {
       console.log(
         `A newer version of the CLI is available: ${latestVersion}, installing...`
       );
-      installCli();
+      await installCli();
     } else {
       console.log(`CLI is up to date`);
     }

package/bin/utils/parseCommandOptions.ts

@@ -5,7 +5,7 @@ import { updateCli } from "../tasks/update.js";
 import { getLocalBinPath } from "./getLocalBinPath.js";
 
 export const parseCommandOptions = async (
-  options: { install: boolean; update: boolean },
+  options: { install: boolean; update: boolean; binaryPath?: string },
   unknownOptions: string[]
 ) => {
   // if `--install` flag is set, only install the cli and dont run it
@@ -20,9 +20,9 @@ export const parseCommandOptions = async (
   }
 
   // if no flags are set, install and run the cli
-  const path = getLocalBinPath();
-  if (!existsSync(path)) {
+  const path = options.binaryPath || getLocalBinPath();
+  if (!options.binaryPath && !existsSync(path)) {
     await installCli();
   }
-  await runCLI(unknownOptions);
+  await runCLI(unknownOptions, options.binaryPath);
 };

package/dist/aptos.js

@@ -7,16 +7,18 @@ program
     .helpOption(false)
     .option("-i, --install", "install the latest version of the CLI")
     .option("-u, --update", "update the CLI to the latest version")
+    .option("-b, --binary-path <path>", "path to an existing Aptos CLI binary")
     .allowUnknownOption();
 program.parse(process.argv);
 const main = async () => {
     const options = {
         install: program.opts().install,
         update: program.opts().update,
+        binaryPath: program.opts().binaryPath,
     };
     const unknownOptions = program.args;
     if (process.argv.includes("--help")) {
-        return runCLI(unknownOptions);
+        return runCLI(unknownOptions, options.binaryPath);
     }
     await parseCommandOptions(options, unknownOptions);
 };

package/dist/aptos.js.map

@@ -1 +1 @@
-{"version":3,"file":"aptos.js","sourceRoot":"","sources":["../bin/aptos.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,UAAU,CAAC,KAAK,CAAC;KACjB,MAAM,CAAC,eAAe,EAAE,uCAAuC,CAAC;KAChE,MAAM,CAAC,cAAc,EAAE,sCAAsC,CAAC;KAC9D,kBAAkB,EAAE,CAAC;AAExB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO;QAC/B,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM;KAC9B,CAAC;IACF,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAGpC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAEpC,OAAO,MAAM,CAAC,cAAc,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}
+{"version":3,"file":"aptos.js","sourceRoot":"","sources":["../bin/aptos.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,UAAU,CAAC,KAAK,CAAC;KACjB,MAAM,CAAC,eAAe,EAAE,uCAAuC,CAAC;KAChE,MAAM,CAAC,cAAc,EAAE,sCAAsC,CAAC;KAC9D,MAAM,CAAC,0BAA0B,EAAE,sCAAsC,CAAC;KAC1E,kBAAkB,EAAE,CAAC;AAExB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO;QAC/B,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM;QAC7B,UAAU,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,UAAU;KACtC,CAAC;IACF,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAGpC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAEpC,OAAO,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}

package/dist/tasks/run.d.ts

@@ -1 +1 @@
-export declare const runCLI: (args?: string[]) => Promise<void>;
+export declare const runCLI: (args?: string[], binaryPath?: string) => Promise<void>;

package/dist/tasks/run.js

@@ -2,9 +2,13 @@ import { spawn } from "child_process";
 import { existsSync } from "fs";
 import { getOS } from "../utils/getUserOs.js";
 import { getLocalBinPath } from "../utils/getLocalBinPath.js";
-export const runCLI = async (args = []) => {
-    const path = getLocalBinPath();
+export const runCLI = async (args = [], binaryPath) => {
+    const path = binaryPath || getLocalBinPath();
     if (!existsSync(path)) {
+        if (binaryPath) {
+            console.error(`Error: Binary not found at specified path: ${binaryPath}`);
+            process.exit(1);
+        }
         console.log("Aptos CLI not installed, run `npx aptos --install` to install");
         return;
     }

package/dist/tasks/run.js.map

@@ -1 +1 @@
-{"version":3,"file":"run.js","sourceRoot":"","sources":["../../bin/tasks/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,OAAiB,EAAE,EAAE,EAAE;IAClD,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CACT,+DAA+D,CAChE,CAAC;QACF,OAAO;IACT,CAAC;IACD,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IAInB,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE;QAChB,KAAK,EAAE,SAAS;QAChB,KAAK,EAAE,EAAE,KAAK,SAAS;KACxB,CAAC,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../bin/tasks/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,OAAiB,EAAE,EAAE,UAAmB,EAAE,EAAE;IACvE,MAAM,IAAI,GAAG,UAAU,IAAI,eAAe,EAAE,CAAC;IAC7C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,8CAA8C,UAAU,EAAE,CAAC,CAAC;YAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,GAAG,CACT,+DAA+D,CAChE,CAAC;QACF,OAAO;IACT,CAAC;IACD,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IAInB,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE;QAChB,KAAK,EAAE,SAAS;QAChB,KAAK,EAAE,EAAE,KAAK,SAAS;KACxB,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/tasks/update.d.ts

@@ -1 +1 @@
-export declare const updateCli: () => Promise<Buffer | undefined>;
+export declare const updateCli: () => Promise<NonSharedBuffer | undefined>;

package/dist/tasks/update.js

@@ -23,7 +23,7 @@ export const updateCli = async () => {
             .split(" ")[1];
         if (currentVersion !== latestVersion) {
             console.log(`A newer version of the CLI is available: ${latestVersion}, installing...`);
-            installCli();
+            await installCli();
         }
         else {
             console.log(`CLI is up to date`);

package/dist/tasks/update.js.map

@@ -1 +1 @@
-{"version":3,"file":"update.js","sourceRoot":"","sources":["../../bin/tasks/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;IAClC,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAE/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CACT,+DAA+D,CAChE,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,KAAK,EAAE,KAAK,OAAO,EAAE,CAAC;QAExB,OAAO,QAAQ,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;SAAM,CAAC;QACN,MAAM,aAAa,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAEjD,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,IAAI,YAAY,EAAE;YACxD,QAAQ,EAAE,MAAM;SACjB,CAAC;aACC,IAAI,EAAE;aACN,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjB,IAAI,cAAc,KAAK,aAAa,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CACT,4CAA4C,aAAa,iBAAiB,CAC3E,CAAC;YACF,UAAU,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../bin/tasks/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;IAClC,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAE/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CACT,+DAA+D,CAChE,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,KAAK,EAAE,KAAK,OAAO,EAAE,CAAC;QAExB,OAAO,QAAQ,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;SAAM,CAAC;QACN,MAAM,aAAa,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAEjD,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,IAAI,YAAY,EAAE;YACxD,QAAQ,EAAE,MAAM;SACjB,CAAC;aACC,IAAI,EAAE;aACN,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjB,IAAI,cAAc,KAAK,aAAa,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CACT,4CAA4C,aAAa,iBAAiB,CAC3E,CAAC;YACF,MAAM,UAAU,EAAE,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/dist/utils/parseCommandOptions.d.ts

@@ -1,4 +1,5 @@
 export declare const parseCommandOptions: (options: {
     install: boolean;
     update: boolean;
+    binaryPath?: string;
 }, unknownOptions: string[]) => Promise<void>;

package/dist/utils/parseCommandOptions.js

@@ -12,10 +12,10 @@ export const parseCommandOptions = async (options, unknownOptions) => {
         await updateCli();
         return;
     }
-    const path = getLocalBinPath();
-    if (!existsSync(path)) {
+    const path = options.binaryPath || getLocalBinPath();
+    if (!options.binaryPath && !existsSync(path)) {
         await installCli();
     }
-    await runCLI(unknownOptions);
+    await runCLI(unknownOptions, options.binaryPath);
 };
 //# sourceMappingURL=parseCommandOptions.js.map

package/dist/utils/parseCommandOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseCommandOptions.js","sourceRoot":"","sources":["../../bin/utils/parseCommandOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,OAA8C,EAC9C,cAAwB,EACxB,EAAE;IAEF,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,UAAU,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,SAAS,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAGD,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,UAAU,EAAE,CAAC;IACrB,CAAC;IACD,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC;AAC/B,CAAC,CAAC"}
+{"version":3,"file":"parseCommandOptions.js","sourceRoot":"","sources":["../../bin/utils/parseCommandOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,OAAmE,EACnE,cAAwB,EACxB,EAAE;IAEF,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,UAAU,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,SAAS,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAGD,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,IAAI,eAAe,EAAE,CAAC;IACrD,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,MAAM,UAAU,EAAE,CAAC;IACrB,CAAC;IACD,MAAM,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/aptos-cli",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Aptos CLI available from npmjs",
   "bin": {
     "aptos": "./dist/aptos.js"