Skip to content

Claws-ZH/openclaw-installer-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenClaw Robust Source Installer (源码构建工具)

Skill 名称: openclaw-source-builder

这是一个专为 AI IDE (Cursor, Windsurf, Trae) 设计的自动化 Skill,用于从源码构建和部署 OpenClaw。

它集成了网络检测、环境预检、依赖安装 (pnpm) 和构建流程 (build),旨在解决国内开发环境中常见的网络和依赖问题。


🚀 一句话开始 (Quick Start)

如果你正在使用 Cursor、Trae 或 Windsurf,直接复制下面这句话发给 AI:

"Use the openclaw-source-builder skill from https://github.com/MackDing/openclaw-installer-skill to install OpenClaw. My network proxy is ready."

AI 会自动找到本仓库,读取 SKILL.md,并执行安装脚本。


🛑 必须准备 (Prerequisites)

在使用此 Skill 之前,请务必确认以下三点,否则安装或运行必定失败:

1. 网络环境 (Network Proxy / VPN) 🪜

构建过程需要访问 GitHub (源码)、NPM (依赖) 和 Python (构建工具) 仓库。

  • 必须开启 全局代理 (VPN/梯子)。
  • 确保你的终端 (Terminal) 可以连接到外网。
  • 检测方法: 在终端运行 curl -I https://www.google.com,如果超时则说明终端未走代理。
  • 解决建议: 如果安装超时,请在终端手动设置代理(请根据你的实际端口修改),例如:
    export https_proxy=http://127.0.0.1:7890
    export http_proxy=http://127.0.0.1:7890

2. API Keys (LLM) 🔑

OpenClaw 启动后需要连接大模型才能工作。请提前准备好以下至少一种 API Key:

  • OpenAI (GPT-4o/Turbo)
  • Anthropic (Claude 3.5 Sonnet)
  • Ollama (本地模型,需提前运行)
  • Moonshot (月之暗面 Kimi)
  • DeepSeek (深度求索)

3. Telegram 配置 (Bot & ID) 🤖

OpenClaw 通过 Telegram 机器人与你进行交互,你需要提前获取以下两项信息:

  • Bot Token: 在 Telegram 中搜索 @BotFather,发送 /newbot 创建一个新机器人,你将获得一串 Token (例如 123456:ABC-DEF...)。
  • Chat ID: 在 Telegram 中搜索 @userinfobot,点击 Start,它会返回你的数字 ID (例如 12345678)。

🚀 使用方法 (Usage)

方式 A:通过 AI IDE 自动安装 (推荐)

如果你正在使用 Cursor、Trae 或 Windsurf,直接复制下面这句话发给 AI:

"Use the openclaw-source-builder skill to install OpenClaw. My network proxy is ready."

AI 会自动:

  1. 读取本仓库的 SKILL.md
  2. 执行安装脚本 scripts/setup.sh
  3. 引导你完成配置

注意:如果 AI IDE 找不到本仓库,请提供 URL:

https://github.com/MackDing/openclaw-installer-skill

方式 B:手动执行 (Manual)

如果你想自己控制安装流程,请按以下步骤操作:

  1. 克隆本仓库:

    git clone https://github.com/MackDing/openclaw-installer-skill.git
    cd openclaw-installer-skill
  2. 赋予脚本执行权限:

    chmod +x scripts/setup.sh
  3. 运行安装脚本: 默认安装到当前目录下的 ./openclaw 文件夹

    ./scripts/setup.sh

    或者指定安装路径:

    ./scripts/setup.sh ~/my-projects/openclaw

⚙️ 安装后配置 (Configuration)

脚本执行成功后 (✅ Build Success!),你需要配置环境变量才能启动应用:

  1. 进入安装目录:

    cd openclaw
  2. 复制环境变量文件(如果脚本没自动执行此步):

    cp .env.example .env
  3. 关键步骤:编辑 .env 文件,填入你的 Key 和 ID:

    nano .env

    修改如下内容:

    # LLM 设置 (选填其一)
    OPENAI_API_KEY=sk-xxxx...
    #
    ANTHROPIC_API_KEY=sk-ant-xxxx...
    #
    MOONSHOT_API_KEY=sk-xxx...
    
    # Telegram 设置 (必填)
    TELEGRAM_BOT_TOKEN=123456:ABC-DEF...
    TELEGRAM_CHAT_ID=12345678
  4. 启动 OpenClaw:

    npm start

🔧 常见问题排查 (Troubleshooting)

如果安装失败,请检查以下情况:

1. Error: Checking Network... Failed

  • 原因:终端无法连接到 Google/GitHub。
  • 解决:检查你的梯子是否开启了"TUN模式"或"全局模式"。或者在终端手动执行 export https_proxy=...

2. Error: node-gyp / make / g++ not found

  • 原因:系统缺少编译 C++ 模块的基础工具。
  • 解决
    • Mac: 运行 xcode-select --install
    • Linux (Ubuntu): 运行 sudo apt-get install build-essential
    • Windows: 建议使用 WSL2 或以管理员身份运行 npm install --global --production windows-build-tools

3. Error: pnpm install 报 404 或 Timeout

  • 原因:NPM 镜像源问题或缓存冲突。
  • 解决
    npm config set registry https://registry.npmmirror.com
    rm -rf node_modules pnpm-lock.yaml
    ./scripts/setup.sh  # 重新运行脚本

4. Error: 构建时 JavaScript heap out of memory

  • 原因:Node.js 内存不足(常见于大型项目)。
  • 解决:脚本已内置 --max-old-space-size=4096,如仍失败,请增加系统内存或关闭其他应用。

5. Error: EACCES: permission denied

  • 原因:npm/pnpm 全局安装权限问题。
  • 解决
    # 使用 npx 避免全局安装
    npx pnpm install
    
    # 或修复 npm 权限
    sudo chown -R $(whoami) ~/.npm

📚 相关资源

WeChat QR Code

🤝 贡献

欢迎提交 Issue 或 PR 来改进这个安装工具,特别是针对中国网络环境的优化建议。

📄 License

MIT License - 详见 LICENSE 文件。

About

Robust OpenClaw installer skill for Chinese users - handles network proxies, dependencies, and builds

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors

Languages