# openclaw-quickstart **Repository Path**: ah-xingzi/openclaw-quickstart ## Basic Information - **Project Name**: openclaw-quickstart - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2026-03-12 - **Last Updated**: 2026-03-13 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
# 🦞 OpenClaw Quickstart **让 AI 帮你部署 AI —— 一条命令,搞定一切。** [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Node.js](https://img.shields.io/badge/Node.js-22%2B-339933?logo=node.js&logoColor=white)](https://nodejs.org/) [![OpenClaw](https://img.shields.io/badge/OpenClaw-2026.3.8-blue)](https://docs.openclaw.ai) [![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey)](.) [![Docker](https://img.shields.io/badge/Docker-Supported-2496ED?logo=docker&logoColor=white)](docker-compose.yml)
--- ## 🎯 这个项目解决什么问题? [OpenClaw](https://docs.openclaw.ai) 是一个强大的开源 AI 网关,但它的**安装配置门槛较高**——手动安装需要 9 个步骤,配置文件涉及多个 JSON 字段,模型协议选择容易出错,卸载也没有官方工具。 **本项目就是为了解决这些痛点。** 我们提供了 4 个 Claude Code Skills,让 AI 代替你完成这些繁琐的操作: | 痛点 | 本项目的解决方案 | |------|---------------| | 😫 安装要手动执行 9 个步骤 | ✅ `/install-openclaw` — AI 自动完成全部步骤 | | 😫 配置文件复杂,JSON 字段容易写错 | ✅ `/configure-models` — 交互式引导,自动生成正确配置 | | 😫 不知道用哪个 API 协议 | ✅ 安装时自动判断,配置时提供选项说明 | | 😫 修改配置后忘记重启 | ✅ `/restart-openclaw` — 一键重启并打开浏览器 | | 😫 卸载不干净,不知道该删哪些文件 | ✅ `/uninstall-openclaw` — 安全卸载,每步确认 | > 💡 **一句话总结**:你只需要准备好 API Key,剩下的交给 AI。 --- ## ✨ 功能特性 | | 特性 | 说明 | |---|------|------| | 🚀 | **一键安装** | 输入 `/install-openclaw`,AI 自动完成环境检查、npm 安装、配置生成、网关启动 | | ⚙️ | **零门槛配置** | 添加模型、换 Key、切协议,全程交互式引导,无需手动编辑 JSON | | 🗑️ | **安全卸载** | 每步都需确认,区分"仅删配置"和"删除全部数据",绝不误删 | | 🔄 | **一键重启** | 自动停旧进程、启新进程、打开浏览器,一步到位 | | 🔀 | **多模型切换** | 同时接入 Claude、GPT、Codex 等多家模型,一个界面自由切换 | | 💬 | **IM 机器人** | 支持对接钉钉、企业微信、飞书、QQ | | 🖥️ | **跨平台** | Windows、macOS、Linux 均可运行 | --- ## 🚀 快速开始 ### 方式一:Claude Code 自动安装(推荐) ``` 1. 用 Claude Code 打开本项目目录 2. 输入: /install-openclaw 3. 按提示提供 API Key 和网关密码 4. 等待自动安装完成,浏览器自动打开聊天页面 ``` > 💡 整个过程由 AI 自动执行,你只需要提供 API 密钥。 ### 方式二:手动安装 参考 [📖 INSTALL-NATIVE.md](INSTALL-NATIVE.md) 按 9 步操作。 ### 方式三:Docker 部署 ```bash cp .env.example .env # 编辑 .env,填入你的 API Key 和网关密码 docker compose up -d ``` --- ## 📋 前置条件 | 条件 | 说明 | |------|------| | 💻 操作系统 | Windows / macOS / Linux 任意 | | 📦 Node.js | v22+(推荐用 [nvm-windows](https://github.com/coreybutler/nvm-windows) / [nvm](https://github.com/nvm-sh/nvm) 管理) | | 🔑 API 密钥 | 至少一个模型的 Key(OpenAI、Anthropic 或兼容中转服务) | | 🤖 Claude Code | 可选但推荐,用于自动化安装和配置 | --- ## 🛠️ Claude Code Skills 本项目的核心能力——4 个内置的 Claude Code Skills,覆盖 OpenClaw 的完整生命周期: ``` 安装 ──→ 配置 ──→ 使用 ──→ 重启 ──→ 卸载 │ │ │ │ ▼ ▼ ▼ ▼ /install /configure /restart /uninstall ``` | 命令 | 说明 | 适用场景 | |------|------|---------| | `/install-openclaw` | 🆕 全新安装,AI 自动完成 9 步配置 | 首次使用 OpenClaw | | `/configure-models` | ⚙️ 交互式添加、修改、切换模型 | 需要换模型或加新 provider | | `/restart-openclaw` | 🔄 重启网关并打开 Web UI | 修改配置后 | | `/uninstall-openclaw` | 🗑️ 安全卸载,每步需确认 | 不再使用 OpenClaw | > 💡 **什么是 Claude Code Skills?** 它们是预定义的 AI 自动化指令,放在 `.claude/commands/` 目录下。用 [Claude Code](https://claude.com/claude-code) 打开项目后,输入 `/命令名` 即可触发。 --- ## 🔧 已安装?配置模型看这里 如果你已经装好了 OpenClaw,想添加模型、换 Key 或切换 provider: - **🤖 自动配置**:用 Claude Code 打开本项目,输入 `/configure-models` - **📝 手动配置**:参考 [MODEL-CONFIG.md](MODEL-CONFIG.md)(含完整字段说明和操作示例) --- ## 🧠 支持的模型 通过配置不同的 provider,可以同时接入多个模型: | Provider | 协议 | 示例模型 | |----------|------|---------| | Anthropic | `anthropic-messages` | Claude Sonnet 4.6、Claude Opus 4.6 | | OpenAI | `openai-responses` | GPT-5.2、GPT-5.4 | | Codex | `openai-responses` | GPT-5-Codex ~ GPT-5.3-Codex | | 其他兼容服务 | `openai-completions` | 通义千问、DeepSeek 等 | > 📖 不确定该用哪个协议?查看 [模型配置指南 - API 协议](MODEL-CONFIG.md#api-协议)。 --- ## 💬 IM 插件(可选) 安装后可对接即时通讯平台,让 AI 在群聊中回复: | 平台 | 安装方式 | |------|---------| | 🔵 钉钉 | 需本地安装,详见 [安装指南](INSTALL-NATIVE.md) | | 🟢 企业微信 | `openclaw plugins install @sunnoy/wecom` | | 🔷 飞书 | `openclaw plugins install @xzq-xu/feishu` | | 🐧 QQ(NapCat) | 需本地安装,详见 [安装指南](INSTALL-NATIVE.md) | > 企业微信详细配置请参考 [WECOM-SETUP.md](WECOM-SETUP.md)。 --- ## 📁 项目结构 ``` openclaw-quickstart/ ├── README.md # 本文件 - 新手指南 ├── CLAUDE.md # Claude Code 项目上下文(自动读取) ├── INSTALL-NATIVE.md # 完整安装指南(9 步) ├── MODEL-CONFIG.md # 模型配置指南(已安装用户) ├── WECOM-SETUP.md # 企业微信配置教程 ├── openclaw.example.json # 配置模板(需填入 API 密钥) ├── .env.example # Docker 环境变量模板 ├── docker-compose.yml # Docker 部署配置 ├── start-openclaw.sh # Linux/macOS 启动脚本 ├── start-openclaw.bat # Windows 启动脚本 ├── LICENSE # MIT 开源协议 ├── CONTRIBUTING.md # 贡献指南 └── .claude/ └── commands/ # Claude Code Skills ├── install-openclaw.md ├── configure-models.md ├── restart-openclaw.md └── uninstall-openclaw.md ``` --- ## ❓ 常见问题
安装 openclaw 时 segfault 怎么办? Windows 上必须加 `--ignore-scripts`: ```bash npm install -g openclaw@2026.3.8 --ignore-scripts ```
端口被占用怎么办? 先终止占用端口的旧进程,再重新启动: ```bash # Windows (Git Bash) netstat -ano | grep ":18789.*LISTENING" # 找到 PID 后终止 taskkill //PID //F # macOS/Linux kill -9 $(lsof -ti:18789) # 然后重新启动 openclaw gateway --port 18789 --verbose ``` > 不建议使用 `--force` 参数,在 Windows 上可能因 `netstat ENOBUFS` 导致启动失败。
修改配置后不生效? 配置文件路径:`~/.openclaw/openclaw.json` 修改后需要重启网关。使用 Claude Code 输入 `/restart-openclaw`,或手动重启进程。
Web UI 地址是什么? ``` http://localhost:18789/admin/chat?session=main&token=你的网关密码 ```
--- ## 🤝 参与贡献 欢迎提交 Issue 和 PR!详见 [CONTRIBUTING.md](CONTRIBUTING.md)。 ## 📄 License [MIT](LICENSE) © 2026 OpenClaw Quickstart Contributors