Skip to content

liyupi/openclaw-guide

Repository files navigation

OpenClaw

OpenClaw 中文文档

OpenClaw 开源 AI 智能体的中文文档站,帮助中文用户快速上手并深入使用 OpenClaw。

在线阅读 · OpenClaw 主仓库 · 快速开始


📖 简介

OpenClaw 是一个开源、可自托管的个人 AI 智能体(AI Agent),可以通过 WhatsApp、Telegram、Discord、飞书、钉钉、企业微信等 20 多个聊天平台与你交互,帮你清理收件箱、发送邮件、管理日历、自动值机等日常任务。运行在你自己的设备上,数据完全私有。

本仓库是 OpenClaw 的 中文文档站,基于 Astro + Starlight 构建,部署在 docs.openclaw.ai

📚 文档内容

板块 说明
快速开始 5 分钟从零到第一条消息,引导式安装向导
安装 Docker、Podman、Nix、Ansible 等安装方式;Fly.io、Hetzner、GCP 等云端部署
消息渠道 WhatsApp、Telegram、Discord、Slack、iMessage、飞书、钉钉、企业微信、Line、Signal 等 20+ 平台接入
代理 Agent 架构、Agent Loop、系统提示词、上下文管理、会话与记忆、多代理协作
工具与技能 内置工具、浏览器自动化、Skills 配置、Slash 命令、ClawHub、自动化(Cron/Webhook/Hook)
模型 OpenAI、Anthropic、Ollama、通义千问、Moonshot、GLM、MiniMax 等 30+ LLM 提供商配置
平台 macOS、Windows、Linux、iOS、Android、Raspberry Pi 等平台适配与配套应用
网关与运维 Gateway 网关配置、安全与沙箱、OpenAI 兼容 API、Bridge 协议、Tailscale 远程访问
安全 形式化验证、威胁模型、沙箱机制
CLI 参考 40+ CLI 命令详细文档
速查表 CLI 命令速查、Slash 命令速查

🚀 本地开发

前置要求

安装与启动

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

# 安装依赖
npm install

# 启动开发服务器
npm run dev

打开浏览器访问 http://localhost:4321 即可预览文档。

构建

# 生产构建
npm run build

# 预览构建产物
npm run preview

🏗 技术栈

  • 框架Astro 5.x
  • 文档主题Starlight 0.34.x
  • 语言:TypeScript / MDX
  • 部署:Cloudflare Pages
  • 翻译工具链:自研 i18n 工具 + 术语表 + 翻译记忆库

📂 项目结构

openclaw-guide/
├── src/content/docs/     # 文档内容(Markdown/MDX)
│   ├── start/            # 快速开始
│   ├── install/          # 安装指南
│   ├── channels/         # 消息渠道
│   ├── concepts/         # 核心概念
│   ├── tools/            # 工具与技能
│   ├── providers/        # 模型提供商
│   ├── platforms/        # 平台适配
│   ├── gateway/          # 网关配置
│   ├── cli/              # CLI 命令参考
│   ├── security/         # 安全文档
│   └── ...               # 更多板块
├── .i18n/                # 翻译术语表与记忆库
├── astro.config.mjs      # Astro + Starlight 配置
├── index.mdx             # 首页
└── package.json          # 项目依赖

🤝 参与贡献

欢迎提交 Issue 和 Pull Request 帮助改进中文文档!

  • 发现翻译问题或错别字?请提交 Issue
  • 想补充或修正文档内容?欢迎提交 PR
  • 翻译风格请参考 .i18n/glossary.zh-CN.json 中的术语表

翻译规范

  • CJK-Latin 间距遵循 W3C CLREQ(如 Gateway 网关Skills 配置
  • 正文使用中文引号 "";代码/CLI/键名保持 ASCII 引号
  • 专有名词保留英文:SkillsTailscaleGateway
  • 代码块和内联代码保持原样,不做翻译

🔗 相关链接

📄 许可证

本文档内容版权归 OpenClaw 项目所有。

About

开源OpenClaw中文文档站,OpenClaw中文指南,支持小龙虾 AI 智能体安装部署、消息渠道接入、Agent 架构、Skills 技能配置、模型提供商、CLI 命令参考、网关运维、安全沙箱等全方位文档。覆盖 WhatsApp、Telegram、Discord、飞书、钉钉、企业微信等 20+ 聊天平台,OpenAI、Anthropic、Ollama、通义千问等 30+ LLM 提供商,Docker / 云端部署,macOS / Windows / Linux / iOS / Android 多平台适配。中文社区维护,术语规范,持续更新,助力中文用户零门槛上手开源自托管 AI 助手。

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors