@aptos-labs/aptos-cli 0.1.9 → 1.0.0

package/bin/aptos.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+// On MacOS we install the CLI with brew. There are two main reasons for this:
+// 1. Brew builds the CLI for the native CPU architecture for the user, which
+//    eliminates any issues arising from using x86 binaries on ARM machines.
+// 2. Brew handles dependency management for us. This isn't relevant right now but
+//    might become necessary later if we reintroduce OpenSSL as a dep for the CLI.
+//
+// On Linux and Windows we just query the GH API for the latest CLI release and
+// download and extract that.
+
+import { program } from "commander";
+
+import { parseCommandOptions } from "./utils/parseCommandOptions.js";
+import { runCLI } from "./tasks/run.js";
+
+program
+  .name("aptos")
+  .helpOption(false)
+  .option("-i, --install", "install the latest version of the CLI")
+  .option("-u, --update", "update the CLI to the latest version")
+  .allowUnknownOption();
+
+program.parse(process.argv);
+
+const main = async () => {
+  const options = {
+    install: program.opts().install,
+    update: program.opts().update,
+  };
+  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);
+  }
+
+  await parseCommandOptions(options, unknownOptions);
+};
+
+main().catch(console.error);

package/bin/tasks/install.ts

@@ -0,0 +1,55 @@
+import { execSync } from "child_process";
+import { existsSync } from "fs";
+
+import { GH_CLI_DOWNLOAD_URL, PNAME } from "../utils/consts.js";
+import { execSyncShell } from "../utils/execSyncShell.js";
+import { getCurrentOpenSSLVersion } from "../utils/versions.js";
+import { getOS } from "../utils/getUserOs.js";
+import { getLatestVersion } from "../utils/getAptosCliLatestVersion.js";
+import { getLocalBinPath } from "../utils/getLocalBinPath.js";
+
+// Install the CLI.
+export const installCli = async () => {
+  const path = getLocalBinPath();
+  if (existsSync(path)) {
+    console.log("Aptos CLI is already installed");
+    return;
+  }
+  // Look up the latest version.
+  const latestCLIVersion = await getLatestVersion();
+  console.log(`Downloading aptos CLI version ${latestCLIVersion}`);
+  const os = getOS();
+
+  if (os === "Windows") {
+    const url = `${GH_CLI_DOWNLOAD_URL}/${PNAME}-v${latestCLIVersion}/${PNAME}-${latestCLIVersion}-${os}-x86_64.zip`;
+    // Download the zip file, extract it, and move the binary to the correct location.
+    execSync(
+      `powershell -Command "if (!(Test-Path -Path 'C:\\tmp')) { New-Item -ItemType Directory -Path 'C:\\tmp' } ; Invoke-RestMethod -Uri ${url} -OutFile C:\\tmp\\aptos.zip; Expand-Archive -Path C:\\tmp\\aptos.zip -DestinationPath C:\\tmp -Force; Move-Item -Path C:\\tmp\\aptos.exe -Destination \"${path}\""`
+    );
+  } else if (os === "MacOS") {
+    // Install the CLI with brew.
+    execSyncShell("brew install aptos", { encoding: "utf8" });
+  } else {
+    // On Linux, we check what version of OpenSSL we're working with to figure out
+    // which binary to download.
+    let osVersion = "x86_64";
+    let opensSslVersion = "1.0.0";
+    try {
+      opensSslVersion = getCurrentOpenSSLVersion();
+    } catch (error) {
+      console.log(
+        "Could not determine OpenSSL version, assuming older version (1.x.x)"
+      );
+    }
+
+    if (opensSslVersion.startsWith("3.")) {
+      osVersion = "22.04-x86_64";
+    }
+    console.log(`Downloading CLI binary ${os}-${osVersion}`);
+    const url = `${GH_CLI_DOWNLOAD_URL}/${PNAME}-v${latestCLIVersion}/${PNAME}-${latestCLIVersion}-${os}-${osVersion}.zip`;
+    // Download the zip file, extract it, and move the binary to the correct location.
+    execSync(
+      `curl -L -o /tmp/aptos.zip ${url}; unzip -o -q /tmp/aptos.zip -d /tmp; mv /tmp/aptos ${path};`
+    );
+  }
+};

package/bin/tasks/run.ts

@@ -0,0 +1,23 @@
+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: string[] = []) => {
+  const path = getLocalBinPath();
+  if (!existsSync(path)) {
+    console.log(
+      "Aptos CLI not installed, run `npx aptos --install` to install"
+    );
+    return;
+  }
+  const os = getOS();
+
+  // Spawn a child process to execute the binary with the provided arguments.
+  // Spawn the child process to run the real CLI executable with the forwarded arguments
+  spawn(path, args, {
+    stdio: "inherit", // Forward the stdio so output is visible
+    shell: os === "Windows", // Use shell on Windows
+  });
+};

package/bin/tasks/update.ts

@@ -0,0 +1,33 @@
+import { existsSync } from "fs";
+
+import { execSyncShell } from "../utils/execSyncShell.js";
+import { getLatestVersion } from "../utils/getAptosCliLatestVersion.js";
+import { installCli } from "./install.js";
+import { getLocalBinPath } from "../utils/getLocalBinPath.js";
+
+export const updateCli = async () => {
+  const path = getLocalBinPath();
+  if (!existsSync(path)) {
+    console.log(
+      "Aptos CLI not installed, run `npx aptos --install` to install"
+    );
+    return;
+  }
+  // Look up the latest version.
+  const latestVersion = await getLatestVersion();
+  // Get the current version of the CLI.
+  const currentVersion = execSyncShell(`${path} --version`, {
+    encoding: "utf8",
+  })
+    .trim()
+    .split(" ")[1];
+  // Check if the installed version is the latest version.
+  if (currentVersion !== latestVersion) {
+    console.log(
+      `A newer version of the CLI is available: ${latestVersion}, installing...`
+    );
+    installCli();
+  } else {
+    console.log(`CLI is up to date`);
+  }
+};

package/bin/utils/aptosExecutableIsAvailable.ts

@@ -0,0 +1,14 @@
+import { execSyncShell } from "./execSyncShell.js";
+
+/**
+ * Only works on Unix systems. This is fine because we only need to check for brew on
+ * MacOS.
+ */
+export const executableIsAvailable = (name) => {
+  try {
+    execSyncShell(`which ${name}`, { encoding: "utf8" });
+    return true;
+  } catch (error) {
+    return false;
+  }
+};

package/bin/utils/brewOperations.ts

@@ -0,0 +1,23 @@
+import { execSyncShell } from "./execSyncShell.js";
+
+/**
+ * Based on the installation path of the aptos formula, determine the path where the
+ * CLI should be installed.
+ */
+export const getCliPathBrew = () => {
+  const directory = execSyncShell("brew --prefix aptos", { encoding: "utf8" })
+    .toString()
+    .trim();
+  return `${directory}/bin/aptos`;
+};
+
+/**
+ * Use brew to find the latest version of the CLI. Make sure to confirm that brew
+ * is installed before calling this function.
+ */
+export const getLatestVersionBrew = () => {
+  const out = JSON.parse(
+    execSyncShell("brew info --json aptos", { encoding: "utf8" })
+  );
+  return out[0].versions.stable;
+};

package/bin/utils/consts.ts

@@ -0,0 +1,3 @@
+export const PNAME = "aptos-cli";
+export const GH_CLI_DOWNLOAD_URL =
+  "https://github.com/aptos-labs/aptos-core/releases/download";

package/bin/utils/execSyncShell.ts

@@ -0,0 +1,8 @@
+import { execSync } from "child_process";
+
+/**
+ * Wrapper around execSync that uses the shell.
+ */
+export const execSyncShell = (command, options) => {
+  return execSync(command, { shell: true, ...options });
+};

package/bin/utils/getAptosCliLatestVersion.ts

@@ -0,0 +1,14 @@
+import { getLatestVersionBrew } from "./brewOperations.js";
+import { getOS } from "./getUserOs.js";
+import { getLatestVersionGh } from "./ghOperations.js";
+
+/**
+ * Determine the latest version of the CLI.
+ */
+export const getLatestVersion = async () => {
+  if (getOS() === "MacOS") {
+    return getLatestVersionBrew();
+  } else {
+    return getLatestVersionGh();
+  }
+};

package/bin/utils/getLocalBinPath.ts

@@ -0,0 +1,28 @@
+import { dirname } from "path";
+import { executableIsAvailable } from "./aptosExecutableIsAvailable.js";
+import { getCliPathBrew } from "./brewOperations.js";
+import { PNAME } from "./consts.js";
+import { getOS } from "./getUserOs.js";
+import { fileURLToPath } from "url";
+
+export const getLocalBinPath = () => {
+  let path;
+  const os = getOS();
+  if (os === "MacOS") {
+    // Confirm brew is installed.
+    const brewInstalled = executableIsAvailable("brew");
+    if (!brewInstalled) {
+      throw "Please install brew to continue: https://brew.sh/";
+    }
+    try {
+      path = getCliPathBrew();
+    } catch (e) {
+      path = "";
+    }
+  } else if (os === "Windows") {
+    path = `${dirname(fileURLToPath(import.meta.url))}\\${PNAME}.exe`;
+  } else {
+    path = `${dirname(fileURLToPath(import.meta.url))}/${PNAME}`;
+  }
+  return path;
+};

package/bin/utils/getUserOs.ts

@@ -0,0 +1,18 @@
+import { platform } from "os";
+
+/**
+ * Determine what OS we're running on.
+ */
+export const getOS = () => {
+  const osPlatform = platform();
+  switch (osPlatform) {
+    case "darwin":
+      return "MacOS";
+    case "linux":
+      return "Ubuntu";
+    case "win32":
+      return "Windows";
+    default:
+      throw new Error(`Unsupported OS ${osPlatform}`);
+  }
+};

package/bin/utils/ghOperations.ts

@@ -0,0 +1,20 @@
+import { PNAME } from "./consts.js";
+
+/**
+ * Query the GitHub API to find the latest CLI release. We assume that the CLI is in
+ * the last 100 releases so we don't paginate through the releases.
+ */
+export const getLatestVersionGh = async () => {
+  const prefix = `${PNAME}-v`;
+  const response = await (
+    await fetch(
+      "https://api.github.com/repos/aptos-labs/aptos-core/releases?per_page=100"
+    )
+  ).json();
+  for (const release of response) {
+    if (release["tag_name"].startsWith(`${prefix}`)) {
+      return release.tag_name.replace(`${prefix}`, "");
+    }
+  }
+  throw "Could not determine latest version of Aptos CLI";
+};

package/bin/utils/handleHelpOptions.ts

@@ -0,0 +1,38 @@
+import { spawnSync } from "child_process";
+import { Command } from "commander";
+
+/**
+ * Handle the `--help` option for the Aptos CLI. This function is used to combine
+ * the Aptos CLI help output with the Commander help output.
+ * @param program - The Commander program instance.
+ * @param unknownOptions - The unknown options passed to the CLI.
+ * @returns void
+ */
+export const handleHelpOptions = (
+  program: Command,
+  unknownOptions: string[]
+) => {
+  // Capture the Aptos CLI help output
+  const cliHelp = spawnSync(`aptos`, unknownOptions, {
+    stdio: "pipe",
+    encoding: "utf-8",
+  });
+  // Generate Commander help text
+  const commanderHelp = program.helpInformation();
+
+  // Remove the "Usage" and "Options" lines from the Commander output
+  const commanderOptionsOnly = commanderHelp
+    .split("\n")
+    .filter((line) => !line.startsWith("Usage") && !line.startsWith("Options"))
+    .join("\n");
+
+  // Find where the CLI options start and append the Commander options to the existing CLI options
+  const combinedHelp = cliHelp.stdout.replace(
+    "Options:",
+    `Options:\n${commanderOptionsOnly.trim()}`
+  );
+
+  // Output the combined help
+  console.log(combinedHelp);
+  return;
+};

package/bin/utils/parseCommandOptions.ts

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

package/bin/utils/versions.ts

@@ -0,0 +1,9 @@
+import { execSyncShell } from "./execSyncShell.js";
+
+/**
+ * Determine the current SSL version
+ */
+export const getCurrentOpenSSLVersion = () => {
+  const out = execSyncShell("openssl version", { encoding: "utf8" });
+  return out.split(" ")[1].trim();
+};

package/dist/aptos.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import { parseCommandOptions } from "./utils/parseCommandOptions.js";
+import { runCLI } from "./tasks/run.js";
+program
+    .name("aptos")
+    .helpOption(false)
+    .option("-i, --install", "install the latest version of the CLI")
+    .option("-u, --update", "update the CLI to the latest version")
+    .allowUnknownOption();
+program.parse(process.argv);
+const main = async () => {
+    const options = {
+        install: program.opts().install,
+        update: program.opts().update,
+    };
+    const unknownOptions = program.args;
+    if (process.argv.includes("--help")) {
+        return runCLI(unknownOptions);
+    }
+    await parseCommandOptions(options, unknownOptions);
+};
+main().catch(console.error);
+//# sourceMappingURL=aptos.js.map

package/package.json

@@ -1,10 +1,37 @@
 {
   "name": "@aptos-labs/aptos-cli",
-  "version": "0.1.9",
+  "version": "1.0.0",
   "description": "Aptos CLI available from npmjs",
   "bin": {
-    "aptos": "bin/aptos"
+    "aptos": "./dist/aptos.js"
   },
-  "author": "",
-  "license": "ISC"
+  "type": "module",
+  "author": "aptoslabs.com",
+  "keywords": [
+    "aptos node cli",
+    "aptos"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aptos-labs/aptos-cli"
+  },
+  "bugs": {
+    "url": "https://github.com/aptos-labs/aptos-cli/issues"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc",
+    "dev": "npm run build && node ./dist/aptos.js"
+  },
+  "files": [
+    "bin"
+  ],
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.5.0",
+    "typescript": "^5.6.2"
+  }
 }

package/CONTRIBUTING.md

@@ -1,8 +0,0 @@
-# Contributing
-
-## Testing
-To test changes to the script, do this:
-```
-pnpm install
-./bin/aptos
-```

package/bin/aptos

@@ -1,177 +0,0 @@
-#!/usr/bin/env node
-
-// On MacOS we install the CLI with brew. There are two main reasons for this:
-// 1. Brew builds the CLI for the native CPU architecture for the user, which
-//    eliminates any issues arising from using x86 binaries on ARM machines.
-// 2. Brew handles dependency management for us. This isn't relevant right now but
-//    might become necessary later if we reintroduce OpenSSL as a dep for the CLI.
-//
-// On Linux and Windows we just query the GH API for the latest CLI release and
-// download and extract that.
-
-const { execSync, spawn } = require("child_process");
-const fs = require("fs");
-const os = require("os");
-
-const PNAME = "aptos-cli";
-
-// Wrapper around execSync that uses the shell.
-const execSyncShell = (command, options) => {
-  return execSync(command, { shell: true, ...options });
-};
-
-// Determine what OS we're running on.
-const getOS = () => {
-  const platform = os.platform();
-  switch (platform) {
-    case "darwin":
-      return "MacOS";
-    case "linux":
-      return "Ubuntu";
-    case "win32":
-      return "Windows";
-    default:
-      throw new Error(`Unsupported OS ${platform}`);
-  }
-};
-
-// Only works on Unix systems. This is fine because we only need to check for brew on
-// MacOS.
-const executableIsAvailable = (name) => {
-  try {
-    execSyncShell(`which ${name}`, { encoding: "utf8" });
-    return true;
-  } catch (error) {
-    return false;
-  }
-};
-
-// Query the GitHub API to find the latest CLI release. We assume that the CLI is in
-// the last 100 releases so we don't paginate through the releases.
-const getLatestVersionGh = async () => {
-  const prefix = `${PNAME}-v`;
-  const response = await (
-    await fetch(
-      "https://api.github.com/repos/aptos-labs/aptos-core/releases?per_page=100"
-    )
-  ).json();
-  for (release of response) {
-    if (release["tag_name"].startsWith(`${prefix}`)) {
-      return release.tag_name.replace(`${prefix}`, "");
-    }
-  }
-  throw "Could not determine latest version of Aptos CLI";
-};
-
-// Use brew to find the latest version of the CLI. Make sure to confirm that brew
-// is installed before calling this function.
-const getLatestVersionBrew = () => {
-  const out = JSON.parse(
-    execSyncShell("brew info --json aptos", { encoding: "utf8" })
-  );
-  return out[0].versions.stable;
-};
-
-// Determine the latest version of the CLI.
-const getLatestVersion = async () => {
-  if (os === "MacOS") {
-    return getLatestVersionBrew();
-  } else {
-    return getLatestVersionGh();
-  }
-};
-
-// Based on the installation path of the aptos formula, determine the path where the
-// CLI should be installed.
-const getCliPathBrew = () => {
-  const directory = execSyncShell("brew --prefix aptos", { encoding: "utf8" })
-    .toString()
-    .trim();
-  return `${directory}/bin/aptos`;
-};
-
-// Install or update the CLI.
-const installCli = (os, path, latestVersion) => {
-  const url = `https://github.com/aptos-labs/aptos-core/releases/download/${PNAME}-v${latestVersion}/${PNAME}-${latestVersion}-${os}-x86_64.zip`;
-
-  console.log(`Downloading aptos CLI version ${latestVersion}`);
-  if (os === "Windows") {
-    // Download the zip file, extract it, and move the binary to the correct location.
-    execSync(
-      `powershell -Command "if (!(Test-Path -Path 'C:\\tmp')) { New-Item -ItemType Directory -Path 'C:\\tmp' } ; Invoke-RestMethod -Uri ${url} -OutFile C:\\tmp\\aptos.zip; Expand-Archive -Path C:\\tmp\\aptos.zip -DestinationPath C:\\tmp -Force; Move-Item -Path C:\\tmp\\aptos.exe -Destination ${path}"`
-    );
-  } else if (os === "MacOS") {
-    // Install the CLI with brew.
-    execSyncShell("brew install aptos");
-    // Get the path of the CLI.
-    path = getCliPathBrew();
-  } else {
-    // Download the zip file, extract it, and move the binary to the correct location.
-    execSync(
-      `curl -L -o /tmp/aptos.zip ${url}; unzip -o -q /tmp/aptos.zip -d /tmp; mv /tmp/aptos ${path};`
-    );
-  }
-};
-
-const main = async () => {
-  const os = getOS();
-
-  let path;
-  if (os === "MacOS") {
-    // Confirm brew is installed.
-    const brewInstalled = executableIsAvailable("brew");
-    if (!brewInstalled) {
-      throw "Please install brew to continue: https://brew.sh/";
-    }
-    try {
-      path = getCliPathBrew();
-    } catch (e) {
-      path = "";
-    }
-  } else if (os === "Windows") {
-    path = `${__dirname}\\${PNAME}.exe`;
-  } else {
-    path = `${__dirname}/${PNAME}`;
-  }
-
-  // Look up the latest version.
-  const latestVersion = await getLatestVersion();
-
-  // If binary does not exist, download it.
-  if (!fs.existsSync(path)) {
-    console.log("CLI not installed");
-    // Install the latest version.
-    installCli(os, path, latestVersion);
-  } else {
-    // Get the current version of the CLI.
-    const currentVersion = execSyncShell(`${path} --version`, {
-      encoding: "utf8",
-    })
-      .trim()
-      .split(" ")[1];
-    console.log(
-      `Previously installed CLI version ${currentVersion}, checking for updates`
-    );
-    // Check if the installed version is the latest version.
-    if (currentVersion !== latestVersion) {
-      console.log(`A newer version of the CLI is available: ${latestVersion}`);
-      installCli(os, path, latestVersion);
-    } else {
-      console.log(`CLI is up to date`);
-    }
-  }
-
-  // Spawn a child process to execute the binary with the provided arguments.
-  if (os === "Windows") {
-    spawn(path, process.argv.slice(2), {
-      stdio: "inherit",
-      shell: true,
-    });
-  } else {
-    spawn(path, process.argv.slice(2), {
-      stdio: "inherit",
-    });
-  }
-};
-
-main().catch(console.error);