@yaakapp/cli 0.3.4 → 0.4.0-beta.2

package/README.md

@@ -1,39 +1,72 @@
+<p align="center">
+  <a href="https://github.com/JamesIves/github-sponsors-readme-action">
+    <img width="200px" src="https://github.com/mountain-loop/yaak/raw/main/crates-tauri/yaak-app/icons/icon.png">
+  </a>
+</p>
 
-# Yaak CLI (`yaakcli`)
+<h1 align="center">
+  💫 Yaak ➟ Desktop API Client 💫
+</h1>
 
-This is the CLI for developing [Yaak](https://yaak.app) plugins.
+<p align="center">
+    A fast, privacy-first API client for REST, GraphQL, SSE, WebSocket, and gRPC – built with Tauri, Rust, and React.
+</p>
+<p align="center">
+ Development is funded by community-purchased <a href="https://yaak.app/pricing">licenses</a>. You can also <a href="https://github.com/sponsors/gschier">become a sponsor</a> to have your logo appear below. 💖
+</p>
+<br>
 
-## Installation
 
-```shell
-npm install -g @yaakapp/cli
-```
 
-## Commands
+<p align="center">
+  <!-- sponsors-premium --><a href="https://github.com/MVST-Solutions"><img src="https:&#x2F;&#x2F;github.com&#x2F;MVST-Solutions.png" width="80px" alt="User avatar: MVST-Solutions" /></a>&nbsp;&nbsp;<a href="https://github.com/dharsanb"><img src="https:&#x2F;&#x2F;github.com&#x2F;dharsanb.png" width="80px" alt="User avatar: dharsanb" /></a>&nbsp;&nbsp;<a href="https://github.com/railwayapp"><img src="https:&#x2F;&#x2F;github.com&#x2F;railwayapp.png" width="80px" alt="User avatar: railwayapp" /></a>&nbsp;&nbsp;<a href="https://github.com/caseyamcl"><img src="https:&#x2F;&#x2F;github.com&#x2F;caseyamcl.png" width="80px" alt="User avatar: caseyamcl" /></a>&nbsp;&nbsp;<a href="https://github.com/bytebase"><img src="https:&#x2F;&#x2F;github.com&#x2F;bytebase.png" width="80px" alt="User avatar: bytebase" /></a>&nbsp;&nbsp;<a href="https://github.com/"><img src="https:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;JamesIves&#x2F;github-sponsors-readme-action&#x2F;dev&#x2F;.github&#x2F;assets&#x2F;placeholder.png" width="80px" alt="User avatar: " /></a>&nbsp;&nbsp;<!-- sponsors-premium -->
+</p>
+<p align="center">
+  <!-- sponsors-base --><a href="https://github.com/seanwash"><img src="https:&#x2F;&#x2F;github.com&#x2F;seanwash.png" width="50px" alt="User avatar: seanwash" /></a>&nbsp;&nbsp;<a href="https://github.com/jerath"><img src="https:&#x2F;&#x2F;github.com&#x2F;jerath.png" width="50px" alt="User avatar: jerath" /></a>&nbsp;&nbsp;<a href="https://github.com/itsa-sh"><img src="https:&#x2F;&#x2F;github.com&#x2F;itsa-sh.png" width="50px" alt="User avatar: itsa-sh" /></a>&nbsp;&nbsp;<a href="https://github.com/dmmulroy"><img src="https:&#x2F;&#x2F;github.com&#x2F;dmmulroy.png" width="50px" alt="User avatar: dmmulroy" /></a>&nbsp;&nbsp;<a href="https://github.com/timcole"><img src="https:&#x2F;&#x2F;github.com&#x2F;timcole.png" width="50px" alt="User avatar: timcole" /></a>&nbsp;&nbsp;<a href="https://github.com/VLZH"><img src="https:&#x2F;&#x2F;github.com&#x2F;VLZH.png" width="50px" alt="User avatar: VLZH" /></a>&nbsp;&nbsp;<a href="https://github.com/terasaka2k"><img src="https:&#x2F;&#x2F;github.com&#x2F;terasaka2k.png" width="50px" alt="User avatar: terasaka2k" /></a>&nbsp;&nbsp;<a href="https://github.com/andriyor"><img src="https:&#x2F;&#x2F;github.com&#x2F;andriyor.png" width="50px" alt="User avatar: andriyor" /></a>&nbsp;&nbsp;<a href="https://github.com/majudhu"><img src="https:&#x2F;&#x2F;github.com&#x2F;majudhu.png" width="50px" alt="User avatar: majudhu" /></a>&nbsp;&nbsp;<a href="https://github.com/axelrindle"><img src="https:&#x2F;&#x2F;github.com&#x2F;axelrindle.png" width="50px" alt="User avatar: axelrindle" /></a>&nbsp;&nbsp;<a href="https://github.com/jirizverina"><img src="https:&#x2F;&#x2F;github.com&#x2F;jirizverina.png" width="50px" alt="User avatar: jirizverina" /></a>&nbsp;&nbsp;<a href="https://github.com/chip-well"><img src="https:&#x2F;&#x2F;github.com&#x2F;chip-well.png" width="50px" alt="User avatar: chip-well" /></a>&nbsp;&nbsp;<a href="https://github.com/GRAYAH"><img src="https:&#x2F;&#x2F;github.com&#x2F;GRAYAH.png" width="50px" alt="User avatar: GRAYAH" /></a>&nbsp;&nbsp;<a href="https://github.com/flashblaze"><img src="https:&#x2F;&#x2F;github.com&#x2F;flashblaze.png" width="50px" alt="User avatar: flashblaze" /></a>&nbsp;&nbsp;<!-- sponsors-base -->
+</p>
 
-```
-$ yaakcli --help
+![Yaak API Client](https://yaak.app/static/screenshot.png)
 
-Generate, build, and debug plugins for Yaak, the most intuitive desktop API client
 
-Usage:
-  yaakcli [flags]
-  yaakcli [command]
+## Features
 
-Available Commands:
-  build       Transpile code into a runnable plugin bundle
-  completion  Generate the autocompletion script for the specified shell
-  dev         Build plugin bundle continuously when the filesystem changes
-  generate    Generate a "Hello World" Yaak plugin
-  help        Help about any command
-  login       Login to Yaak via web browser
-  logout      Sign out of the Yaak CLI
-  publish     Publish a Yaak plugin version to the plugin registry
-  whoami      Print the current logged-in user's info
+Yaak is an offline-first API client designed to stay out of your way while giving you everything you need when you need it. 
+Built with [Tauri](https://tauri.app), Rust, and React, it’s fast, lightweight, and private. No telemetry, no VC funding, and no cloud lock-in.  
 
-Flags:
-  -h, --help      help for yaakcli
-      --version   Source directory to read from
 
-Use "yaakcli [command] --help" for more information about a command.
-```
+### 🌐 Work with any API
+
+- Import collections from Postman, Insomnia, OpenAPI, Swagger, or Curl.
+- Send requests via REST, GraphQL, gRPC, WebSocket, or Server-Sent Events.
+- Filter and inspect responses with JSONPath or XPath.
+
+### 🔐 Stay secure
+- Use OAuth 2.0, JWT, Basic Auth, or custom plugins for authentication.
+- Secure sensitive values with encrypted secrets. 
+- Store secrets in your OS keychain.
+
+### ☁️ Organize & collaborate
+- Group requests into workspaces and nested folders.
+- Use environment variables to switch between dev, staging, and prod.
+- Mirror workspaces to your filesystem for versioning in Git or syncing with Dropbox.
+
+### 🧩 Extend & customize
+- Insert dynamic values like UUIDs or timestamps with template tags.
+- Pick from built-in themes or build your own.
+- Create plugins to extend authentication, template tags, or the UI.
+
+
+## Contribution Policy
+
+> [!IMPORTANT]
+> Community PRs are currently limited to bug fixes and small-scope improvements.
+> If your PR is out of scope, link an approved feedback item from [yaak.app/feedback](https://yaak.app/feedback).
+> See [`CONTRIBUTING.md`](CONTRIBUTING.md) for policy details and [`DEVELOPMENT.md`](DEVELOPMENT.md) for local setup.
+
+## Useful Resources
+
+- [Feedback and Bug Reports](https://feedback.yaak.app)
+- [Documentation](https://yaak.app/docs)
+- [Yaak vs Postman](https://yaak.app/alternatives/postman)
+- [Yaak vs Bruno](https://yaak.app/alternatives/bruno)
+- [Yaak vs Insomnia](https://yaak.app/alternatives/insomnia)

package/bin/cli.js

@@ -2,17 +2,29 @@
 
 const path = require("path");
 const childProcess = require("child_process");
-const {BINARY_NAME, PLATFORM_SPECIFIC_PACKAGE_NAME} = require("../common");
+const { BINARY_NAME, PLATFORM_SPECIFIC_PACKAGE_NAME } = require("../common");
 
 function getBinaryPath() {
   try {
-    // Resolving will fail if the optionalDependency was not installed
+    if (!PLATFORM_SPECIFIC_PACKAGE_NAME) {
+      throw new Error("unsupported platform");
+    }
     return require.resolve(`${PLATFORM_SPECIFIC_PACKAGE_NAME}/bin/${BINARY_NAME}`);
-  } catch (e) {
+  } catch (_) {
     return path.join(__dirname, "..", BINARY_NAME);
   }
 }
 
-childProcess.execFileSync(getBinaryPath(), process.argv.slice(2), {
-  stdio: "inherit",
+const result = childProcess.spawnSync(getBinaryPath(), process.argv.slice(2), {
+  stdio: "inherit"
 });
+
+if (result.error) {
+  throw result.error;
+}
+
+if (result.signal) {
+  process.kill(process.pid, result.signal);
+}
+
+process.exit(result.status ?? 1);

package/common.js

@@ -1,22 +1,16 @@
-// Lookup table for all platforms and binary distribution packages
 const BINARY_DISTRIBUTION_PACKAGES = {
   darwin_arm64: "@yaakapp/cli-darwin-arm64",
   darwin_x64: "@yaakapp/cli-darwin-x64",
   linux_arm64: "@yaakapp/cli-linux-arm64",
   linux_x64: "@yaakapp/cli-linux-x64",
   win32_x64: "@yaakapp/cli-win32-x64",
-  win32_arm64: "@yaakapp/cli-win32-arm64",
+  win32_arm64: "@yaakapp/cli-win32-arm64"
 };
 
-// Adjust the version you want to install. You can also make this dynamic.
-const BINARY_DISTRIBUTION_VERSION = require('./package.json').version;
-
-// Windows binaries end with .exe so we need to special case them.
-const BINARY_NAME = process.platform === "win32" ? "yaakcli.exe" : "yaakcli";
-
-// Determine package name for this platform
+const BINARY_DISTRIBUTION_VERSION = require("./package.json").version;
+const BINARY_NAME = process.platform === "win32" ? "yaak.exe" : "yaak";
 const PLATFORM_SPECIFIC_PACKAGE_NAME =
-  BINARY_DISTRIBUTION_PACKAGES[process.platform + '_' + process.arch];
+  BINARY_DISTRIBUTION_PACKAGES[`${process.platform}_${process.arch}`];
 
 module.exports = {
   BINARY_DISTRIBUTION_PACKAGES,

package/index.js

@@ -1,18 +1,20 @@
 const path = require("path");
 const childProcess = require("child_process");
-const {PLATFORM_SPECIFIC_PACKAGE_NAME, BINARY_NAME} = require("./common");
+const { PLATFORM_SPECIFIC_PACKAGE_NAME, BINARY_NAME } = require("./common");
 
 function getBinaryPath() {
   try {
-    // Resolving will fail if the optionalDependency was not installed
+    if (!PLATFORM_SPECIFIC_PACKAGE_NAME) {
+      throw new Error("unsupported platform");
+    }
     return require.resolve(`${PLATFORM_SPECIFIC_PACKAGE_NAME}/bin/${BINARY_NAME}`);
-  } catch (e) {
-    return path.join(__dirname, "..", BINARY_NAME);
+  } catch (_) {
+    return path.join(__dirname, BINARY_NAME);
   }
 }
 
-module.exports.runBinary = function (...args) {
+module.exports.runBinary = function runBinary(...args) {
   childProcess.execFileSync(getBinaryPath(), args, {
-    stdio: "inherit",
+    stdio: "inherit"
   });
 };

package/install.js

@@ -1,10 +1,13 @@
-const fs = require("fs");
-const path = require("path");
-const zlib = require("zlib");
-const https = require("https");
-const {BINARY_DISTRIBUTION_VERSION, BINARY_NAME, PLATFORM_SPECIFIC_PACKAGE_NAME} = require("./common");
+const fs = require("node:fs");
+const path = require("node:path");
+const zlib = require("node:zlib");
+const https = require("node:https");
+const {
+  BINARY_DISTRIBUTION_VERSION,
+  BINARY_NAME,
+  PLATFORM_SPECIFIC_PACKAGE_NAME
+} = require("./common");
 
-// Compute the path we want to emit the fallback binary to
 const fallbackBinaryPath = path.join(__dirname, BINARY_NAME);
 
 function makeRequest(url) {
@@ -14,95 +17,81 @@ function makeRequest(url) {
         if (response.statusCode >= 200 && response.statusCode < 300) {
           const chunks = [];
           response.on("data", (chunk) => chunks.push(chunk));
-          response.on("end", () => {
-            resolve(Buffer.concat(chunks));
-          });
+          response.on("end", () => resolve(Buffer.concat(chunks)));
         } else if (
           response.statusCode >= 300 &&
           response.statusCode < 400 &&
           response.headers.location
         ) {
-          // Follow redirects
           makeRequest(response.headers.location).then(resolve, reject);
         } else {
           reject(
             new Error(
-              `npm responded with status code ${response.statusCode} when downloading the package! ${url}`
+              `npm responded with status code ${response.statusCode} when downloading package ${url}`
             )
           );
         }
       })
-      .on("error", (error) => {
-        reject(error);
-      });
+      .on("error", (error) => reject(error));
   });
 }
 
 function extractFileFromTarball(tarballBuffer, filepath) {
-  // Tar archives are organized in 512 byte blocks.
-  // Blocks can either be header blocks or data blocks.
-  // Header blocks contain file names of the archive in the first 100 bytes, terminated by a null byte.
-  // The size of a file is contained in bytes 124-135 of a header block.
-  // The following blocks will be data blocks containing the file.
   let offset = 0;
   while (offset < tarballBuffer.length) {
     const header = tarballBuffer.subarray(offset, offset + 512);
     offset += 512;
 
     const fileName = header.toString("utf-8", 0, 100).replace(/\0.*/g, "");
-    const fileSize = parseInt(
-      header.toString("utf-8", 124, 136).replace(/\0.*/g, ""),
-      8
-    );
+    const fileSize = parseInt(header.toString("utf-8", 124, 136).replace(/\0.*/g, ""), 8);
 
     if (fileName === filepath) {
       return tarballBuffer.subarray(offset, offset + fileSize);
     }
 
-    // Clamp offset to the uppoer multiple of 512
     offset = (offset + fileSize + 511) & ~511;
   }
+
+  return null;
 }
 
 async function downloadBinaryFromNpm() {
-  // Download the tarball of the right binary distribution package
-  const platformSpecificPackageNameWithoutOrg = PLATFORM_SPECIFIC_PACKAGE_NAME.split('/')[1];
-  const tarballDownloadBuffer = await makeRequest(
-    `https://registry.npmjs.org/${platformSpecificPackageName}/-/${platformSpecificPackageNameWithoutOrg}-${BINARY_DISTRIBUTION_VERSION}.tgz`,
-  );
+  if (!PLATFORM_SPECIFIC_PACKAGE_NAME) {
+    throw new Error(`Unsupported platform: ${process.platform}/${process.arch}`);
+  }
 
+  const packageNameWithoutScope = PLATFORM_SPECIFIC_PACKAGE_NAME.split("/")[1];
+  const tarballUrl = `https://registry.npmjs.org/${PLATFORM_SPECIFIC_PACKAGE_NAME}/-/${packageNameWithoutScope}-${BINARY_DISTRIBUTION_VERSION}.tgz`;
+  const tarballDownloadBuffer = await makeRequest(tarballUrl);
   const tarballBuffer = zlib.unzipSync(tarballDownloadBuffer);
 
-  // Extract binary from package and write to disk
-  fs.writeFileSync(
-    fallbackBinaryPath,
-    extractFileFromTarball(tarballBuffer, `package/bin/${BINARY_NAME}`)
-  );
+  const binary = extractFileFromTarball(tarballBuffer, `package/bin/${BINARY_NAME}`);
+  if (!binary) {
+    throw new Error(`Could not find package/bin/${BINARY_NAME} in tarball`);
+  }
 
-  // Make binary executable
+  fs.writeFileSync(fallbackBinaryPath, binary);
   fs.chmodSync(fallbackBinaryPath, "755");
 }
 
 function isPlatformSpecificPackageInstalled() {
   try {
-    // Resolving will fail if the optionalDependency was not installed
-    const binPath = `${PLATFORM_SPECIFIC_PACKAGE_NAME}/bin/${BINARY_NAME}`;
-    console.log('Checking if binary is installed', binPath);
-    require.resolve(binPath);
+    if (!PLATFORM_SPECIFIC_PACKAGE_NAME) {
+      return false;
+    }
+    require.resolve(`${PLATFORM_SPECIFIC_PACKAGE_NAME}/bin/${BINARY_NAME}`);
     return true;
-  } catch (e) {
+  } catch (_) {
     return false;
   }
 }
 
-// Skip downloading the binary if it was already installed via optionalDependencies
 if (!isPlatformSpecificPackageInstalled()) {
-  console.log(
-    "Platform specific package not found. Will manually download binary."
-  );
-  downloadBinaryFromNpm().catch(console.error);
+  console.log("Platform package missing. Downloading Yaak CLI binary from npm...");
+  downloadBinaryFromNpm().catch((err) => {
+    console.error("Failed to install Yaak CLI binary:", err);
+    process.exitCode = 1;
+  });
 } else {
-  console.log(
-    "Platform specific package already installed. Will fall back to manually downloading binary."
-  );
+  console.log("Platform package present. Using bundled Yaak CLI binary.");
 }

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "@yaakapp/cli",
-  "version": "0.3.4",
+  "version": "0.4.0-beta.2",
   "main": "./index.js",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mountain-loop/yaak-cli.git"
+    "url": "git+https://github.com/mountain-loop/yaak.git"
   },
   "scripts": {
     "postinstall": "node ./install.js",
     "prepublishOnly": "node ./prepublish.js"
   },
   "bin": {
+    "yaak": "bin/cli.js",
     "yaakcli": "bin/cli.js"
   },
   "optionalDependencies": {
-    "@yaakapp/cli-darwin-x64": "0.3.4",
-    "@yaakapp/cli-darwin-arm64": "0.3.4",
-    "@yaakapp/cli-linux-arm64": "0.3.4",
-    "@yaakapp/cli-linux-x64": "0.3.4",
-    "@yaakapp/cli-win32-x64": "0.3.4",
-    "@yaakapp/cli-win32-arm64": "0.3.4"
+    "@yaakapp/cli-darwin-x64": "0.4.0-beta.2",
+    "@yaakapp/cli-darwin-arm64": "0.4.0-beta.2",
+    "@yaakapp/cli-linux-arm64": "0.4.0-beta.2",
+    "@yaakapp/cli-linux-x64": "0.4.0-beta.2",
+    "@yaakapp/cli-win32-x64": "0.4.0-beta.2",
+    "@yaakapp/cli-win32-arm64": "0.4.0-beta.2"
   }
-}
+}

package/prepublish.js

@@ -1,6 +1,5 @@
-const fs = require("fs");
-const path = require("path");
+const fs = require("node:fs");
+const path = require("node:path");
 
-const readme = path.join(__dirname, '..', '..', 'README.md');
-
-fs.copyFileSync(readme, path.join(__dirname, "README.md"))
+const readme = path.join(__dirname, "..", "..", "README.md");
+fs.copyFileSync(readme, path.join(__dirname, "README.md"));