keyapi-cli 1.0.1 → 1.0.2

package/README.md

@@ -33,84 +33,17 @@ The CLI reads the latest KeyAPI OpenAPI documentation when endpoint details are
 
 ## Installation
 
-### Install with npm
-
-Requires Node.js 18 or later. The npm package installs the matching KeyAPI
-binary for your operating system from GitHub Releases:
+Requires Node.js 18 or later:
 
 ```bash
-npm install -g @echosell/keyapi-cli
-keyapi --help
-```
-
-If you already have a KeyAPI binary, set `KEYAPI_CLI_BINARY` to its path before
-running `keyapi`.
-
-### Install from Release
-
-1. Open the [GitHub Releases](https://github.com/EchoSell/keyapi-cli/releases) page.
-2. Download the binary for your operating system.
-```powershell
-cd ~/keyapi-cli
+npm install -g keyapi-cli
 keyapi --help
+keyapi --version
 ```
 
-Copy this prompt into an AI assistant such as Claude Code, Codex, Cursor, or Trae if you want it to install the release binary for you:
-
-```text
-Install the latest KeyAPI CLI from https://github.com/EchoSell/keyapi-cli/releases by downloading the binary for the current platform, configuring it so the `keyapi` command is available from the terminal, and verifying the installation with `keyapi --version`.
-```
-
-### Build from Source
-
-Requires Go `v1.22` or later.
-
-Clone the repository and build the executable:
-
-```powershell
-git clone https://github.com/EchoSell/keyapi-cli.git
-cd keyapi-cli
-go build -buildvcs=false -o keyapi.exe .
-```
-
-On Linux or macOS, build with:
-
-```bash
-git clone https://github.com/EchoSell/keyapi-cli.git
-cd keyapi-cli
-go build -buildvcs=false -o keyapi .
-```
-
-
-Copy this prompt into an AI assistant such as Claude Code, Codex, Cursor, or Trae if you want it to build the project from source:
-
-```text
-Install KeyAPI CLI from source: https://github.com/EchoSell/keyapi-cli.git. Build an executable for the current system, configure it so the `keyapi` command is available from the terminal, and verify the installation by running `keyapi --version`.
-```
-
-After building, continue with the PATH setup section below.
-
-### Make keyapi available on PATH
-
-After installing or building the binary, place it in a directory that is available on `PATH`.
-
-Windows example:
-
-```powershell
-# Example: keyapi.exe is stored in C:\Tools\keyapi
-$env:Path += ";C:\Tools\keyapi"
-keyapi --help
-```
-
-The command above only updates the current PowerShell session. For permanent use, add the directory to the system or user `PATH` environment variable.
-
-Linux or macOS example:
-
-```bash
-chmod +x keyapi
-sudo mv keyapi /usr/local/bin/keyapi
-keyapi --help
-```
+The npm package installs a small JavaScript launcher plus the matching native
+KeyAPI binary package for your operating system. If you already have a custom
+KeyAPI binary, set `KEYAPI_CLI_BINARY` to its path before running `keyapi`.
 
 ## Quick Start
 

package/README.zh.md

@@ -1,116 +1,30 @@
-# KeyAPI CLI
+# KeyAPI CLI
 
----
+[中文](https://github.com/EchoSell/keyapi-cli/blob/main/README.zh.md) | [English](https://github.com/EchoSell/keyapi-cli/blob/main/README.md)
 
-[中文版](https://github.com/EchoSell/keyapi-cli/blob/main/README.zh.md) | [English](https://github.com/EchoSell/keyapi-cli/blob/main/README.md)
-
-KeyAPI CLI 是 [KeyAPI](https://keyapi.ai) 平台的轻量级命令行客户端。它可以帮助你配置认证信息、发现支持的 API 平台、查看接口 schema，并在不编写请求代码的情况下调用 API。
-
-## 为什么选择 KeyAPI CLI？
-
-KeyAPI 提供了 Google、TikTok、Instagram 等多个平台的接口。当项目中需要使用大量接口时，手写和维护请求代码会变得重复且容易出错。
-
-KeyAPI CLI 提供一个统一的命令行入口：
-
-- 配置一次 API token
-- 查看支持的平台
-- 查看每个平台下的接口
-- 查看接口方法、路径、描述、参数和请求体字段
-- 从终端直接执行 API 请求
-- 将大响应保存到文件
-
-CLI 会在请求接口详情时读取最新的 KeyAPI OpenAPI 文档，使接口描述和 schema 与当前 KeyAPI API 文档保持一致。
+KeyAPI CLI 是用于 [KeyAPI](https://keyapi.ai) 的轻量级命令行工具。它可以配置认证信息、发现支持的平台、查看接口 schema，并直接从终端调用 API。
 
 ## 功能
 
-- 简单的配置命令：`keyapi set`、`keyapi get`、`keyapi show`、`keyapi clear`
-- API 查看命令：`keyapi spec list-platforms`、`keyapi spec list-endpoints`、`keyapi schema`
-- 一个请求命令：`keyapi call`
-- `spec` 和 `call` 默认返回 JSON
-- 内置 `--help` 输出，适合人类用户、脚本和 Agent 阅读
-- 支持 `--dry-run`，发送请求前先查看请求内容
-- 支持 `--output "path"`，保存大响应
+- 配置命令：`keyapi set`、`keyapi get`、`keyapi show`、`keyapi clear`
+- 接口发现：`keyapi spec list-platforms`、`keyapi spec list-endpoints`
+- schema 查看：`keyapi schema`
+- 请求执行：`keyapi call`
+- 默认 JSON 输出，适合脚本和 Agent 使用
+- 支持 `--dry-run` 预览请求
+- 支持 `--output "path"` 保存大响应
 
 ## 安装
 
-### 使用 npm 安装
-
-需要 Node.js 18 或更高版本。npm 包会从 GitHub Releases 下载适合当前
-操作系统的 KeyAPI 二进制文件：
-
-```bash
-npm install -g @echosell/keyapi-cli
-keyapi --help
-```
-
-如果你已经有可用的 KeyAPI 二进制文件，可以在运行 `keyapi` 前设置
-`KEYAPI_CLI_BINARY` 指向该文件路径。
-
-### 从 Release 安装
-
-1. 打开 [GitHub Releases](https://github.com/EchoSell/keyapi-cli/releases) 页面。
-2. 下载适合当前系统的二进制文件。
-```powershell
-cd ~/keyapi-cli
-keyapi --help
-```
-
-如果你希望 AI 助手帮你安装 release 二进制文件，可以将下面的提示词复制给 Claude Code、Codex、Cursor、Trae 等工具：
-
-```text
-请从 https://github.com/EchoSell/keyapi-cli/releases 下载并安装适用于当前系统的最新 KeyAPI CLI，完成可执行文件配置，使其可通过 `keyapi` 命令直接调用，并执行 `keyapi --version` 验证安装是否成功。
-```
-
-### 从源码构建
-
-需要 Go `v1.22` 或更高版本。
-
-克隆仓库并构建可执行文件：
-
-```powershell
-git clone https://github.com/EchoSell/keyapi-cli.git
-cd keyapi-cli
-go build -buildvcs=false -o keyapi.exe .
-```
-
-Linux 或 macOS 使用：
+需要 Node.js 18 或更高版本：
 
 ```bash
-git clone https://github.com/EchoSell/keyapi-cli.git
-cd keyapi-cli
-go build -buildvcs=false -o keyapi .
-```
-
-
-如果你希望 AI 助手帮你从源码构建，可以将下面的提示词复制给 Claude Code、Codex、Cursor、Trae 等工具：
-
-```text
-请从源码安装 KeyAPI CLI：https://github.com/EchoSell/keyapi-cli.git，编译生成适用于当前系统的可执行文件，并配置为可通过 `keyapi` 命令直接调用，最后执行 `keyapi --version` 验证安装结果。
-```
-
-构建完成后，继续查看下面的 PATH 配置说明。
-
-### 将 keyapi 加入 PATH
-
-安装或构建完成后，可以将二进制文件放到已加入 `PATH` 的目录中。
-
-Windows 示例：
-
-```powershell
-# 示例：keyapi.exe 存放在 C:\Tools\keyapi
-$env:Path += ";C:\Tools\keyapi"
+npm install -g keyapi-cli
 keyapi --help
+keyapi --version
 ```
 
-上面的命令只会影响当前 PowerShell 会话。长期使用时，请将该目录添加到系统或用户的 `PATH` 环境变量中。
-
-Linux 或 macOS 示例：
-
-```bash
-chmod +x keyapi
-sudo mv keyapi /usr/local/bin/keyapi
-keyapi --help
-```
+npm 包会安装一个 JavaScript 启动器，并自动安装当前系统对应的 KeyAPI 原生二进制包。如果你已经有自定义 KeyAPI 二进制文件，可以在运行 `keyapi` 前设置 `KEYAPI_CLI_BINARY` 指向该文件路径。
 
 ## 快速开始
 
@@ -138,13 +52,13 @@ keyapi spec list-platforms
 keyapi spec list-endpoints google
 ```
 
-调用前查看接口详情：
+调用前查看接口 schema：
 
 ```powershell
 keyapi schema google/search
 ```
 
-先 dry-run 查看请求：
+预览请求：
 
 ```powershell
 keyapi call "/v1/google/search?q=openai&gl=us&hl=en" --dry-run
@@ -162,116 +76,43 @@ keyapi call "/v1/google/search?q=openai&gl=us&hl=en"
 keyapi call "/v1/google/search?q=openai&gl=us&hl=en" --output "google-search.json"
 ```
 
-需要时清除已保存的 token：
+清除 token：
 
 ```powershell
 keyapi clear token
 ```
 
-## 命令
+## 常用命令
 
 | 命令 | 作用 |
 | --- | --- |
-| `keyapi --help` | 查看主帮助、推荐顺序和子命令帮助入口。 |
-| `keyapi set token <value>` | 保存 API token 到本地。 |
-| `keyapi set language <en\|zh>` | 设置接口描述使用的 OpenAPI 文档语言。 |
-| `keyapi get <key>` | 读取一个本地配置值。 |
-| `keyapi show` | 查看当前本地配置。 |
-| `keyapi clear <key>` | 清除一个本地配置值。 |
-| `keyapi spec list-platforms` | 返回支持的平台 JSON 数组。 |
-| `keyapi spec list-endpoints <platform...\|all>` | 返回一个或多个平台的接口摘要。 |
-| `keyapi spec get-endpoint <endpoint-or-path>` | 返回单个接口的方法、路径、描述、参数和 body 字段。 |
-| `keyapi schema <endpoint-or-path>` | `keyapi spec get-endpoint` 的简短别名。 |
-| `keyapi call <endpoint-or-path>` | 执行 KeyAPI 请求。 |
+| `keyapi --help` | 查看帮助 |
+| `keyapi set token <value>` | 保存 API token |
+| `keyapi set language <en|zh>` | 设置 OpenAPI 文档语言 |
+| `keyapi show` | 查看当前配置 |
+| `keyapi spec list-platforms` | 列出支持的平台 |
+| `keyapi spec list-endpoints <platform...|all>` | 列出平台接口 |
+| `keyapi schema <endpoint-or-path>` | 查看接口 schema |
+| `keyapi call <endpoint-or-path>` | 调用接口 |
 
 每个命令都支持 `--help`：
 
 ```powershell
 keyapi --help
-keyapi set --help
 keyapi spec --help
-keyapi spec list-platforms --help
-keyapi spec list-endpoints --help
-keyapi spec get-endpoint --help
 keyapi schema --help
 keyapi call --help
 ```
 
-## 进阶用法
-
-### JSON 输出
-
-`spec` 和 `call` 命令默认返回 JSON。
-
-`keyapi spec list-platforms`：
-
-```json
-["google", "tiktok"]
-```
-
-`keyapi spec list-endpoints tiktok`：
-
-```json
-{
-  "tiktok": [
-    {
-      "method": "GET",
-      "path": "/v1/tiktok/influencer/detail",
-      "summary": "User detail",
-      "description": "Get TikTok user detail."
-    }
-  ]
-}
-```
-
-### 保存大响应
-
-部分接口会返回较大的 JSON，例如商品详情、图片列表、SKU 列表或描述字段。建议使用 `--output "path"` 将完整响应体写入文件，避免直接在终端中输出大量内容：
-
-```powershell
-keyapi call "/v1/google/search?q=openai&gl=us" --output "outputs/google-search.json"
-```
-
-相对路径会基于当前工作目录解析。
-
-### Dry Run
-
-使用 `--dry-run` 打印请求但不发送：
-
-```powershell
-keyapi call "/v1/google/search?q=openai&gl=us" --dry-run
-```
-
-### 请求体
+## 使用建议
 
-JSON 请求体使用 `--body-json`：
+推荐流程：
 
-```powershell
-keyapi call "/v1/example/post-endpoint" --method POST --body-json '{"page":1,"verified":true}'
-```
-
-原始文本请求体使用 `--body-raw`：
+1. `keyapi set token sk_xxx`
+2. `keyapi spec list-platforms`
+3. `keyapi spec list-endpoints <platform>`
+4. `keyapi schema <endpoint-or-path>`
+5. `keyapi call <endpoint-or-path> --dry-run`
+6. `keyapi call <endpoint-or-path>`
 
-```powershell
-keyapi call "/v1/example/text-endpoint" --method POST --body-raw "plain text"
-```
-
-对于 GET 接口，推荐直接把 query 参数写在接口路径中：
-
-```powershell
-keyapi call "/v1/google/search?q=openai&gl=us"
-```
-
-需要用程序追加 query 参数时，可以使用 `--params "k=v"` 或 `--query "k=v"`。
-
-## 文档
-
-`docs/` 包含 CLI 的安装、配置和使用文档。CLI 的 help 输出是内置的命令使用参考。
-
-| 文件 | 作用 |
-| --- | --- |
-| [docs/index.md](docs/index.md) | 文档入口。 |
-| [docs/commands.md](docs/commands.md) | 完整命令和参数参考。 |
-| [docs/config.md](docs/config.md) | 配置文件和环境变量说明。 |
-| [README.md](README.md) | 英文 README。 |
-| [docs/zh/index.md](docs/zh/index.md) | 中文文档入口。 |
+对于较大的 JSON 响应，使用 `--output "path"` 保存到文件。

package/npm/keyapi.js

@@ -2,17 +2,23 @@
 const { spawnSync } = require('node:child_process');
 const path = require('node:path');
 
-const { binaryNameForPlatform } = require('../scripts/platform');
+const {
+  binaryNameForPlatform,
+  packageNameForPlatform,
+} = require('../scripts/platform');
 
 function resolveBinaryPath(options = {}) {
   const env = options.env || process.env;
   const platform = options.platform || process.platform;
+  const arch = options.arch || process.arch;
+  const resolve = options.resolve || require.resolve;
 
   if (env.KEYAPI_CLI_BINARY) {
     return env.KEYAPI_CLI_BINARY;
   }
 
-  return path.join(__dirname, 'native', binaryNameForPlatform({ platform }));
+  const packageName = packageNameForPlatform({ platform, arch });
+  return resolve(path.join(packageName, 'bin', binaryNameForPlatform({ platform })));
 }
 
 function main() {
@@ -23,7 +29,7 @@ function main() {
 
   if (result.error) {
     console.error(`Failed to start KeyAPI CLI: ${result.error.message}`);
-    console.error('Try reinstalling the npm package, or set KEYAPI_CLI_BINARY.');
+    console.error('Try reinstalling keyapi-cli, or set KEYAPI_CLI_BINARY.');
     process.exit(1);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyapi-cli",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "KeyAPI CLI for discovering endpoint schemas and calling KeyAPI APIs.",
   "license": "MIT",
   "repository": {
@@ -17,9 +17,16 @@
     "README.zh.md"
   ],
   "scripts": {
-    "postinstall": "node scripts/install.js",
+    "prepare-platform-packages": "node scripts/prepare-platform-packages.js",
     "test": "node --test test/*.test.js"
   },
+  "optionalDependencies": {
+    "keyapi-cli-darwin-arm64": "1.0.2",
+    "keyapi-cli-darwin-x64": "1.0.2",
+    "keyapi-cli-linux-arm64": "1.0.2",
+    "keyapi-cli-linux-x64": "1.0.2",
+    "keyapi-cli-win32-x64": "1.0.2"
+  },
   "keywords": [
     "keyapi",
     "cli",

package/scripts/platform.js

@@ -9,6 +9,11 @@ const archByArch = {
   arm64: 'arm64',
 };
 
+const npmArchByArch = {
+  x64: 'x64',
+  arm64: 'arm64',
+};
+
 function targetForPlatform(options = {}) {
   const platform = options.platform || process.platform;
   const arch = options.arch || process.arch;
@@ -37,8 +42,21 @@ function binaryNameForPlatform(options = {}) {
   return platform === 'win32' ? 'keyapi.exe' : 'keyapi';
 }
 
+function packageNameForPlatform(options = {}) {
+  const platform = options.platform || process.platform;
+  const arch = options.arch || process.arch;
+  const npmArch = npmArchByArch[arch];
+
+  if (!npmArch || !osByPlatform[platform]) {
+    throw new Error(`Unsupported platform: ${platform}/${arch}`);
+  }
+
+  return `keyapi-cli-${platform}-${npmArch}`;
+}
+
 module.exports = {
   assetNameForPlatform,
   binaryNameForPlatform,
+  packageNameForPlatform,
   targetForPlatform,
 };

package/scripts/prepare-platform-packages.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+const fs = require('node:fs');
+const path = require('node:path');
+
+const targets = [
+  { goos: 'windows', goarch: 'amd64', packageName: 'keyapi-cli-win32-x64', binaryName: 'keyapi.exe' },
+  { goos: 'linux', goarch: 'amd64', packageName: 'keyapi-cli-linux-x64', binaryName: 'keyapi' },
+  { goos: 'linux', goarch: 'arm64', packageName: 'keyapi-cli-linux-arm64', binaryName: 'keyapi' },
+  { goos: 'darwin', goarch: 'amd64', packageName: 'keyapi-cli-darwin-x64', binaryName: 'keyapi' },
+  { goos: 'darwin', goarch: 'arm64', packageName: 'keyapi-cli-darwin-arm64', binaryName: 'keyapi' },
+];
+
+function preparePlatformPackages(options = {}) {
+  const rootDir = options.rootDir || path.resolve(__dirname, '..');
+  const version = options.version || require(path.join(rootDir, 'package.json')).version;
+  const distDir = options.distDir || path.join(rootDir, 'dist');
+  const packagesDir = options.packagesDir || path.join(rootDir, 'npm-packages');
+
+  for (const target of targets) {
+    const source = path.join(
+      distDir,
+      `keyapi_${version}_${target.goos}_${target.goarch}${target.binaryName.endsWith('.exe') ? '.exe' : ''}`,
+    );
+    const binDir = path.join(packagesDir, target.packageName, 'bin');
+    const destination = path.join(binDir, target.binaryName);
+
+    if (!fs.existsSync(source)) {
+      throw new Error(`missing built binary: ${source}`);
+    }
+
+    fs.mkdirSync(binDir, { recursive: true });
+    fs.copyFileSync(source, destination);
+    fs.chmodSync(destination, 0o755);
+  }
+}
+
+if (require.main === module) {
+  preparePlatformPackages();
+}
+
+module.exports = {
+  preparePlatformPackages,
+  targets,
+};

package/scripts/install.js

@@ -1,122 +0,0 @@
-#!/usr/bin/env node
-const fs = require('node:fs');
-const https = require('node:https');
-const path = require('node:path');
-
-const { assetNameForPlatform, binaryNameForPlatform } = require('./platform');
-
-const rootDir = path.resolve(__dirname, '..');
-const packageJson = require(path.join(rootDir, 'package.json'));
-
-function download(url, destination, redirects = 0) {
-  return new Promise((resolve, reject) => {
-    const request = https.get(
-      url,
-      {
-        headers: {
-          'User-Agent': '@echosell/keyapi-cli installer',
-        },
-      },
-      (response) => {
-        const location = response.headers.location;
-        if (
-          response.statusCode >= 300 &&
-          response.statusCode < 400 &&
-          location
-        ) {
-          response.resume();
-          if (redirects >= 5) {
-            reject(new Error('too many redirects while downloading KeyAPI CLI'));
-            return;
-          }
-          download(new URL(location, url).toString(), destination, redirects + 1)
-            .then(resolve, reject);
-          return;
-        }
-
-        if (response.statusCode !== 200) {
-          response.resume();
-          reject(new Error(`download failed with HTTP ${response.statusCode}`));
-          return;
-        }
-
-        const file = fs.createWriteStream(destination, { mode: 0o755 });
-        response.pipe(file);
-        file.on('finish', () => {
-          file.close(resolve);
-        });
-        file.on('error', reject);
-      },
-    );
-
-    request.on('error', reject);
-  });
-}
-
-function getInstallPlan(options = {}) {
-  const env = options.env || process.env;
-  const baseDir = options.rootDir || rootDir;
-  const version = options.version || packageJson.version;
-
-  if (env.KEYAPI_CLI_BINARY) {
-    return { skip: true };
-  }
-
-  const assetName = assetNameForPlatform({
-    version,
-    platform: options.platform,
-    arch: options.arch,
-  });
-  const repo = env.KEYAPI_CLI_REPOSITORY || 'EchoSell/keyapi-cli';
-  const tag = env.KEYAPI_CLI_RELEASE_TAG || `v${version}`;
-  const url =
-    env.KEYAPI_CLI_DOWNLOAD_URL ||
-    `https://github.com/${repo}/releases/download/${tag}/${assetName}`;
-
-  const nativeDir = path.join(baseDir, 'npm', 'native');
-  const binaryPath = path.join(
-    nativeDir,
-    binaryNameForPlatform({ platform: options.platform }),
-  );
-  const tempPath = `${binaryPath}.download`;
-
-  return {
-    binaryPath,
-    nativeDir,
-    skip: false,
-    tempPath,
-    url,
-  };
-}
-
-async function install(options = {}) {
-  const plan = getInstallPlan(options);
-  if (plan.skip) {
-    return;
-  }
-
-  fs.mkdirSync(plan.nativeDir, { recursive: true });
-  if (fs.existsSync(plan.tempPath)) {
-    fs.rmSync(plan.tempPath, { force: true });
-  }
-  if (fs.existsSync(plan.binaryPath)) {
-    fs.rmSync(plan.binaryPath, { force: true });
-  }
-
-  await download(plan.url, plan.tempPath);
-  fs.renameSync(plan.tempPath, plan.binaryPath);
-  fs.chmodSync(plan.binaryPath, 0o755);
-}
-
-if (require.main === module) {
-  install().catch((error) => {
-    console.error(`Failed to install KeyAPI CLI binary: ${error.message}`);
-    console.error('Set KEYAPI_CLI_BINARY to an existing keyapi binary to skip download.');
-    process.exit(1);
-  });
-}
-
-module.exports = {
-  getInstallPlan,
-  install,
-};