Skip to content

Repository files navigation

@zi.yi/openclaw-easy

npm version License: MIT Install Size

One-command setup for OpenClaw with built-in API key.

OpenClaw 是一个自托管 AI 助手网关,可以连接 WhatsApp、Telegram、Discord 等聊天应用到 AI 编码助手。这个工具让你一键完成配置,内置免费 OpenRouter 模型。

特点

  • 零配置 - 内置免费 API key,开箱即用
  • 灵活 - 可以选择使用自己的 API key
  • 一键安装 - 一条命令完成所有配置
  • 安全 - API key 加密存储

平台支持

平台 支持程度 说明
macOS ✅ 完全支持 守护进程、开机自启
Linux ✅ 完全支持 systemd、开机自启
Windows + WSL2 ✅ 完全支持 推荐方式
Windows 原生 ⚠️ 有限支持 需手动启动,无守护进程

💡 Windows 用户建议:使用 WSL2 获得完整的后台运行体验。查看 Windows 使用手册

快速开始

安装

npm install -g "@zi.yi/openclaw-easy@latest"

使用

方式一:使用内置福利 API key(推荐)

openclaw-easy

默认配置:

  • 模型:arcee-ai/trinity-large-preview:free

方式二:使用自己的 API key

# 命令行参数
openclaw-easy --openai-key sk-your-api-key-here

# 或环境变量
export OPENAI_API_KEY=sk-your-api-key-here
openclaw-easy

安装完成后,你可以通过以下方式与 OpenClaw 交互:

# 打开 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: 重新安装即可:

npm install -g "@zi.yi/openclaw-easy@latest"

Q: 内置的是什么模型?

A: 内置的是 OpenRouter Trinity 模型,适合日常使用。

Q: 如何更换模型?

A: 编辑 ~/.openclaw/.env,修改 OPENCLAW_MODEL 环境变量。

Q: Windows 安装时出现 node-llama-cpp 错误?

A: 这是 Windows 上的已知问题,不影响使用。解决方案:

# 使用 --ignore-scripts 跳过本地模型组件安装
npm install -g "@zi.yi/openclaw-easy@latest" --ignore-scripts

说明node-llama-cpp 仅用于本地模型推理,使用云端 API(如内置的 Trinity 模型)不需要它。

Q: 卸载怎么办?

npm uninstall -g "@zi.yi/openclaw-easy"
npx openclaw uninstall  # 完全卸载 OpenClaw

文档

详细使用指南请查看 USER_GUIDE.md

开发

# 克隆仓库
git clone https://github.com/ZiyiSpace/openclaw-easy.git
cd openclaw-easy

# 安装依赖
npm install

# 本地测试
npm install -g .
openclaw-easy

# 发布到 npm(需要设置环境变量)
BUILTIN_API_KEY="your-api-key" BUILTIN_MODEL="arcee-ai/trinity-large-preview:free" npm publish --access public

致谢

GitHub 仓库

https://github.com/ZiyiSpace/openclaw-easy

License

MIT © 2026 王子怡 (Ziyi Wang)

About

一键配置 OpenClaw AI 助手,内置免费 API key,开箱即用!

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages