@zi.yi/openclaw-easy 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 王子怡 (Ziyi Wang)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# @zi.yi/openclaw-easy
+
+[![npm version](https://badge.fury.io/js/@hzzzzzz%2Fopenclaw-easy.svg)](https://www.npmjs.com/package/@zi.yi/openclaw-easy)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Install Size](https://packagephobia.com/badge?p=@zi.yi/openclaw-easy)](https://packagephobia.com/result?p=@zi.yi/openclaw-easy)
+
+> **One-command setup for [OpenClaw](https://github.com/anthropics/openclaw) with built-in API key.**
+
+OpenClaw 是一个自托管 AI 助手网关，可以连接 WhatsApp、Telegram、Discord 等聊天应用到 AI 编码助手。这个工具让你一键完成配置，内置 GLM-4-Flash 模型。
+
+## 特点
+
+- **零配置** - 内置免费 API key，开箱即用
+- **灵活** - 可以选择使用自己的 API key
+- **一键安装** - 一条命令完成所有配置
+- **安全** - API key 加密存储
+
+## 快速开始
+
+### 安装
+
+```bash
+npm install -g @zi.yi/openclaw-easy
+```
+
+### 使用
+
+**方式一：使用内置福利 API key（推荐）**
+
+```bash
+openclaw-easy
+```
+
+默认配置：
+- 模型：`glm-4-flash`（通过 zai provider）
+
+**方式二：使用自己的 API key**
+
+```bash
+# 命令行参数
+openclaw-easy --openai-key sk-your-api-key-here
+
+# 或环境变量
+export OPENAI_API_KEY=sk-your-api-key-here
+openclaw-easy
+```
+
+安装完成后，你可以通过以下方式与 OpenClaw 交互：
+
+```bash
+# 打开 Web 控制面板
+npx openclaw dashboard
+
+# 或使用终端界面
+npx openclaw tui
+
+# 或直接发送消息
+npx openclaw agent --message "你好"
+```
+
+## 工作原理
+
+1. 从内置配置或用户输入获取 API key
+2. 将配置写入 `~/.openclaw/.env`（API key、模型）
+3. 运行 OpenClaw 的 onboarding 流程
+4. 安装并启动 OpenClaw 守护进程
+
+## 常见问题
+
+### Q: 内置的是什么模型？
+
+A: 内置的是 GLM-4-Flash 模型（通过 zai provider），适合日常使用。
+
+### Q: 如何更换模型？
+
+A: 编辑 `~/.openclaw/.env`，修改 `OPENCLAW_MODEL` 环境变量。
+
+### Q: 卸载怎么办？
+
+```bash
+npm uninstall -g @zi.yi/openclaw-easy
+npx openclaw uninstall  # 完全卸载 OpenClaw
+```
+
+## 文档
+
+详细使用指南请查看 [USER_GUIDE.md](USER_GUIDE.md)
+
+## 开发
+
+```bash
+# 克隆仓库
+git clone https://github.com/hzzzzz-1/openclaw-easy.git
+cd openclaw-easy
+
+# 安装依赖
+npm install
+
+# 本地测试
+npm install -g .
+openclaw-easy
+
+# 发布到 npm（需要设置环境变量）
+BUILTIN_API_KEY="your-api-key" BUILTIN_MODEL="glm-4.7-flash" npm publish --access public
+```
+
+## 致谢
+
+- [OpenClaw](https://github.com/anthropics/openclaw) - 核心项目
+- [GLM](https://open.bigmodel.cn/) - 提供内置 API 支持
+
+## GitHub 仓库
+
+https://github.com/hzzzzz-1/openclaw-easy
+
+## License
+
+[MIT](LICENSE) © 2026 王子怡 (Ziyi Wang)

package/bin/openclaw-easy.mjs

@@ -0,0 +1,254 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import { createInterface } from "node:readline";
+
+const require = createRequire(import.meta.url);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// 内部密钥（混淆）
+const _k = "openclaw-easy-secret-2026";
+const _0 = "d";  // API key
+const _1 = "m";  // model
+const _2 = "v";  // version
+
+// 解密函数（与加密工具对应）
+const _d = (s) => {
+  try {
+    const b = Buffer.from(s, "base64").toString("utf8");
+    let r = "";
+    for (let i = 0; i < b.length; i++) {
+      r += String.fromCharCode(b.charCodeAt(i) ^ _k.charCodeAt(i % _k.length));
+    }
+    return r;
+  } catch (_) {
+    return "";
+  }
+};
+
+// 获取内置配置
+function getBuiltinConfig() {
+  try {
+    const configPath = path.join(__dirname, "../lib/config.json");
+    const raw = fs.readFileSync(configPath, "utf8");
+    const _c = JSON.parse(raw);
+
+    return {
+      apiKey: _d(_c[_0]),
+      model: _d(_c[_1]),
+      version: _c[_2]
+    };
+  } catch (err) {
+    console.error("Configuration error. Please reinstall:\n  npm install -g @hzzzzzz/openclaw-easy");
+    process.exit(1);
+  }
+}
+
+// 交互式询问
+function askQuestion(query) {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  return new Promise((resolve) => {
+    rl.question(query, (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase());
+    });
+  });
+}
+
+const arg = (name) => {
+  const i = process.argv.indexOf(name);
+  return i >= 0 ? process.argv[i + 1] : undefined;
+};
+
+// 更新 OpenClaw 配置文件，设置模型
+function updateOpenClawConfig(model) {
+  const configPath = path.join(os.homedir(), ".openclaw", "openclaw.json");
+
+  try {
+    if (!fs.existsSync(configPath)) {
+      return;
+    }
+
+    const config = JSON.parse(fs.readFileSync(configPath, "utf8"));
+
+    // 模型 provider 映射
+    let modelKey;
+    if (model.includes("trinity")) {
+      modelKey = `openrouter/${model}`;
+    } else if (model.startsWith("glm")) {
+      modelKey = `zai/glm-4-flash`;
+    } else if (model.startsWith("gpt")) {
+      modelKey = `openai/${model}`;
+    } else {
+      modelKey = model;
+    }
+
+    config.agents = config.agents || {};
+    config.agents.defaults = config.agents.defaults || {};
+    config.agents.defaults.models = {
+      [modelKey]: {
+        "alias": modelKey.includes("trinity") ? "Trinity" : modelKey.startsWith("zai") ? "GLM" : "GPT"
+      }
+    };
+    config.agents.defaults.model = {
+      "primary": modelKey
+    };
+
+    fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
+    console.log("\n✓ 已使用内置免费模型");
+  } catch (err) {
+    console.error("警告: 无法更新 OpenClaw 配置:", err.message);
+  }
+}
+
+// 主流程
+async function main() {
+  const builtinConfig = getBuiltinConfig();
+  const userApiKey = arg("--openai-key") || process.env.OPENAI_API_KEY;
+
+  let finalApiKey;
+  let finalModel = builtinConfig.model;
+
+  if (userApiKey) {
+    console.log("\n检测到你提供了自己的 API key。");
+    console.log("  [1] 使用你自己的 API key");
+    console.log("  [2] 使用内置的免费 API key");
+
+    const choice = await askQuestion("\n请选择 [1/2]（默认 1）：");
+
+    if (choice === "2" || choice === "内置" || choice === "福利") {
+      finalApiKey = builtinConfig.apiKey;
+      console.log("\n✓ 使用内置福利 API key");
+    } else {
+      finalApiKey = userApiKey;
+      console.log("\n✓ 使用你提供的 API key");
+      // 用户用自己的 key，不强制使用 GLM 配置
+      finalModel = null;
+    }
+  } else {
+    finalApiKey = builtinConfig.apiKey;
+    console.log("\n✓ 使用内置免费 API key");
+  }
+
+  // 写入 .env 文件
+  const envFile = path.join(os.homedir(), ".openclaw", ".env");
+  fs.mkdirSync(path.dirname(envFile), { recursive: true });
+
+  const lines = fs.existsSync(envFile) ? fs.readFileSync(envFile, "utf8").split(/\r?\n/) : [];
+
+  // 过滤掉旧的配置行（包括看起来像是 API key 延续的行）
+  const next = [];
+  let skipNext = false;
+  for (const line of lines) {
+    if (skipNext) {
+      skipNext = false;
+      continue;
+    }
+    if (line.startsWith("OPENAI_API_KEY=") ||
+        line.startsWith("OPENROUTER_API_KEY=") ||
+        line.startsWith("ZAI_API_KEY=") ||
+        line.startsWith("OPENCLAW_MODEL=")) {
+      // 如果这行以 = 结尾但没有内容，可能是换行的 key，跳过下一行
+      if (line.endsWith("=") || line.match(/KEY=$/)) {
+        skipNext = true;
+      }
+      continue;
+    }
+    // 跳过看起来像是 API key 延续的行（不以 = 开头且像 base64/key 格式）
+    if (line.match(/^[a-zA-Z0-9_-]{20,}$/) && !line.includes("=")) {
+      continue;
+    }
+    next.push(line);
+  }
+
+  // 根据模型选择对应的环境变量
+  if (finalModel && finalModel.includes("trinity")) {
+    next.push(`OPENROUTER_API_KEY=${finalApiKey}`);
+    next.push(`OPENCLAW_MODEL=openrouter/${finalModel}`);
+  } else if (finalModel && finalModel.startsWith("glm")) {
+    next.push(`ZAI_API_KEY=${finalApiKey}`);
+    next.push(`OPENCLAW_MODEL=zai/glm-4-flash`);
+  } else {
+    next.push(`OPENAI_API_KEY=${finalApiKey}`);
+    if (finalModel) {
+      next.push(`OPENCLAW_MODEL=${finalModel}`);
+    }
+  }
+  fs.writeFileSync(envFile, `${next.filter(Boolean).join("\n")}\n`, "utf8");
+
+  // 调用 OpenClaw onboard
+  const openclawCli = require.resolve("openclaw/cli-entry");
+
+  // 根据模型选择认证方式和 API key 参数
+  let authChoice = "openai-api-key";
+  let apiKeyParam = "--openai-api-key";
+
+  if (finalModel && finalModel.includes("trinity")) {
+    authChoice = "openrouter-api-key";
+    apiKeyParam = "--openrouter-api-key";
+  } else if (finalModel && finalModel.startsWith("glm")) {
+    authChoice = "zai-api-key";
+    apiKeyParam = "--zai-api-key";
+  }
+
+  const run = spawnSync(
+    process.execPath,
+    [
+      openclawCli,
+      "onboard",
+      "--non-interactive",
+      "--accept-risk",
+      "--flow",
+      "quickstart",
+      "--auth-choice",
+      authChoice,
+      apiKeyParam,
+      finalApiKey,
+      "--install-daemon"
+    ],
+    {
+      stdio: "inherit",
+      env: {
+        ...process.env,
+        ...(finalModel && {
+          OPENCLAW_MODEL: finalModel.includes("trinity")
+            ? `openrouter/${finalModel}`
+            : finalModel.startsWith("glm")
+            ? "zai/glm-4-flash"
+            : finalModel
+        })
+      }
+    }
+  );
+
+  // 如果使用内置配置，更新 openclaw.json
+  if (finalModel && run.status === 0) {
+    updateOpenClawConfig(finalModel);
+
+    // 停止 gateway（LaunchAgent 会自动重启）
+    console.log("\n正在重启 OpenClaw Gateway...");
+    spawnSync(
+      process.execPath,
+      [openclawCli, "gateway", "--stop"],
+      { stdio: "inherit" }
+    );
+    console.log("\n✓ 配置完成！Gateway 正在自动启动...");
+    console.log("\n运行以下命令打开控制面板：");
+    console.log("  npx openclaw dashboard");
+  }
+
+  process.exit(run.status ?? 1);
+}
+
+main().catch((err) => {
+  console.error("Error:", err);
+  process.exit(1);
+});

package/lib/config.example.json

@@ -0,0 +1,7 @@
+{
+  "_comment": "这是配置示例，实际使用时请复制为 config.json 并填入真实值",
+  "_note": "使用 node scripts/encrypt-config.mjs <api-key> <model> 生成加密配置",
+  "apiKey": "加密后的API密钥(base64)",
+  "model": "加密后的模型名(base64)",
+  "provider": "moonshot"
+}

package/lib/config.json

@@ -0,0 +1,5 @@
+{
+  "d": "HBtIARFBF0YAAVZKHx5DAwEWAE0dBlQFVVhHUApaVAdEG1dTEEgeRFVXQ1FDGwJWBAcOFgBeVF9ZFRxWAkYbHRZRWkUGF0xTUg==",
+  "m": "DgIGCwZBAB4CERMaF0QHHE4eBAZKVx1CRAoGDAsUVgcFSAA=",
+  "v": "1"
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@zi.yi/openclaw-easy",
+  "version": "1.0.0",
+  "description": "One-command setup for OpenClaw with built-in API key",
+  "type": "module",
+  "bin": {
+    "openclaw-easy": "bin/openclaw-easy.mjs"
+  },
+  "scripts": {
+    "prepack": "node scripts/prepack.mjs",
+    "postpack": "rm -f lib/config.json",
+    "test": "node bin/openclaw-easy.mjs --help"
+  },
+  "dependencies": {
+    "openclaw": "^2026.2.9"
+  },
+  "keywords": [
+    "openclaw",
+    "cli",
+    "setup",
+    "openai"
+  ],
+  "author": "王子怡 (Ziyi Wang) <3597792204@qq.com> (https://github.com/hzzzzz-1)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "bin/",
+    "lib/"
+  ]
+}