@dhruv2mars/offdex 0.0.4 → 0.0.6

package/README.md

@@ -25,7 +25,9 @@ Supported targets:
 Common usage:
 
 ```bash
-offdex bridge --host 0.0.0.0 --port 42420
-offdex bridge --control-plane-url https://control.offdex.app
+offdex start --host 0.0.0.0 --port 42420
+offdex start --control-plane-url https://control.offdex.app
+offdex status
+offdex stop
 offdex --help
 ```

package/bin/install-lib.js

@@ -5,6 +5,7 @@ import http from "node:http";
 import https from "node:https";
 import { homedir } from "node:os";
 import { join } from "node:path";
+import { gunzipSync } from "node:zlib";
 
 const REPO = "Dhruv2mars/offdex";
 const SUPPORTED_TARGETS = new Map([
@@ -58,6 +59,10 @@ export function checksumsAssetNameFor(platform = process.platform, arch = proces
   return `checksums-${platform}-${arch}.txt`;
 }
 
+export function compressedAssetNameFor(platform = process.platform, arch = process.arch) {
+  return `${assetNameFor(platform, arch)}.gz`;
+}
+
 export function resolveInstallRoot(env = process.env, home = homedir()) {
   return env.OFFDEX_INSTALL_ROOT || join(home, ".offdex");
 }
@@ -281,6 +286,7 @@ export async function installRuntime({
   const installBin = resolveInstalledBin(env, platform, home);
   const installMeta = resolveInstallMetaPath(env, home);
   const asset = assetNameFor(platform, arch);
+  const compressedAsset = compressedAssetNameFor(platform, arch);
   const checksumsAsset = checksumsAssetNameFor(platform, arch);
   const baseUrl = env.OFFDEX_RELEASE_BASE_URL
     || `https://github.com/${REPO}/releases/download/v${version}`;
@@ -293,21 +299,42 @@ export async function installRuntime({
   } catch {
     throw new Error(`failed_download:${checksumsAsset}`);
   }
-  const expectedChecksum = parseChecksumForAsset(checksumsText, asset);
+  const expectedCompressedChecksum = parseChecksumForAsset(checksumsText, compressedAsset);
+  const expectedChecksum = expectedCompressedChecksum || parseChecksumForAsset(checksumsText, asset);
   if (!expectedChecksum) {
     throw new Error(`missing_checksum:${asset}`);
   }
 
   const tempPath = `${installBin}.download`;
   try {
-    try {
-      await downloadFn(`${baseUrl}/${asset}`, tempPath, 0, { onProgress });
-    } catch {
-      throw new Error(`failed_download:${asset}`);
-    }
-    const actualChecksum = createHash("sha256").update(readFileSync(tempPath)).digest("hex");
-    if (actualChecksum !== expectedChecksum) {
-      throw new Error(`checksum_mismatch:${asset}`);
+    if (expectedCompressedChecksum) {
+      const compressedPath = `${tempPath}.gz`;
+      try {
+        await downloadFn(`${baseUrl}/${compressedAsset}`, compressedPath, 0, { onProgress });
+      } catch {
+        throw new Error(`failed_download:${compressedAsset}`);
+      }
+      try {
+        const actualCompressedChecksum = createHash("sha256")
+          .update(readFileSync(compressedPath))
+          .digest("hex");
+        if (actualCompressedChecksum !== expectedCompressedChecksum) {
+          throw new Error(`checksum_mismatch:${compressedAsset}`);
+        }
+        await writeFile(tempPath, gunzipSync(readFileSync(compressedPath)));
+      } finally {
+        await rm(compressedPath, { force: true });
+      }
+    } else {
+      try {
+        await downloadFn(`${baseUrl}/${asset}`, tempPath, 0, { onProgress });
+      } catch {
+        throw new Error(`failed_download:${asset}`);
+      }
+      const actualChecksum = createHash("sha256").update(readFileSync(tempPath)).digest("hex");
+      if (actualChecksum !== expectedChecksum) {
+        throw new Error(`checksum_mismatch:${asset}`);
+      }
     }
     if (platform !== "win32") {
       await chmod(tempPath, 0o755);

package/bin/offdex.js

@@ -13,11 +13,33 @@ import {
 } from "./offdex-lib.js";
 
 const args = process.argv.slice(2);
+const ONBOARDING_TEXT = `Offdex
+Codex from your phone.
+
+Get started:
+  1. Run offdex start
+  2. Open Offdex on your phone
+  3. Scan the QR from this terminal
+
+Useful commands:
+  offdex start      Start the Mac bridge
+  offdex status     Check if Offdex is running
+  offdex stop       Stop the local bridge
+  offdex --help     Show all options
+`;
 const HELP_TEXT = `Offdex CLI
 
 Usage:
-  offdex bridge [options]
-  offdex help
+  offdex
+  offdex start [options]
+  offdex status [options]
+  offdex stop [options]
+  offdex --help
+
+Commands:
+  start                         Start the Mac bridge and show the pairing QR
+  status                        Check the local bridge
+  stop                          Stop the local bridge started by Offdex
 
 Options:
   --host <host>                 Bridge host. Default: 0.0.0.0
@@ -37,9 +59,14 @@ const packageVersion = readPackageVersion();
 const currentInstalledVersion = installedVersion(process.env);
 const workspaceBridgeCli = resolveWorkspaceBridgeCli();
 
+if (!existsSync(installedBin) && args.length === 0) {
+  console.log(ONBOARDING_TEXT);
+  process.exit(0);
+}
+
 if (
   !existsSync(installedBin) &&
-  (args.length === 0 || args[0] === "help" || args[0] === "--help" || args[0] === "-h")
+  (args[0] === "help" || args[0] === "--help" || args[0] === "-h")
 ) {
   console.log(HELP_TEXT);
   process.exit(0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhruv2mars/offdex",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Codex mobile bridge CLI for Offdex",
   "type": "module",
   "bin": {