{"skill":{"slug":"use-openclaw-manual","displayName":"Use OpenClaw Manual","summary":"配置 OpenClaw 前必须查阅官方文档的技能。当用户提到任何配置相关的话题（agent、session、channel、cron、通知、工具、workspace、gateway 等）时，立即使用此技能搜索本地文档。不要凭经验猜测——先查文档再设计方案。","description":"---\nname: use-openclaw-manual\ndescription: 配置 OpenClaw 前必须查阅官方文档的技能。当用户提到任何配置相关的话题（agent、session、channel、cron、通知、工具、workspace、gateway 等）时，立即使用此技能搜索本地文档。不要凭经验猜测——先查文档再设计方案。\ncompatibility:\n  required_tools: git, curl, python3\n  optional_tools: jq (测试框架), openclaw CLI (通知)\n  optional_env: GITHUB_TOKEN (GitHub API 认证), OPENCLAW_MANUAL_PATH, DOC_NOTIFY_CHANNEL\n  permissions: 本地文件读写 (~/.openclaw/workspace/docs/), GitHub API 访问\n---\n\n# use-openclaw-manual - 基于文档的 OpenClaw 配置技能\n\n## 核心原则\n\n**配置前必须查文档** —— 这是使用此技能的根本原因。OpenClaw 的配置字段、命令参数、渠道设置经常变化，凭经验操作容易出错。此技能确保你的配置方案基于最新官方文档，而非过时的记忆。\n\n## 何时使用此技能\n\n**触发场景**（看到以下任何关键词就应触发）：\n\n| 关键词 | 查阅目录 | 优先级 |\n|--------|---------|--------|\n| agent, workspace, session | `concepts/`, `cli/agents.md` | P0 |\n| cron, schedule, reminder, 定时 | `automation/cron.md`, `cli/cron.md` | P1 |\n| discord, telegram, whatsapp, qqbot, 通知 | `channels/`, `automation/notifications.md` | P2 |\n| tool, profile, browser, exec | `tools/`, `concepts/tools.md` | P1 |\n| gateway, config, restart | `gateway/`, `cli/gateway.md` | P0 |\n| memory, skill, 技能 | `concepts/memory.md`, `skills/` | P1 |\n\n**不触发的场景**：\n- 简单的文件操作（读/写/编辑工作区文件）\n- 网络搜索（web_search, web_fetch）\n- 与 OpenClaw 配置无关的任务\n\n## 标准工作流程\n\n收到配置需求后，按此流程操作：\n\n```\n1. 进入技能目录\n   $ cd path/to/use-openclaw-manual/\n\n2. 搜索文档\n   $ ./run.sh --search \"<关键词>\"\n\n3. 阅读相关文档\n   $ ./run.sh --read \"<文档路径>\"\n\n4. 设计方案（引用文档来源）\n   \"根据 <文档路径>，配置步骤如下：...\"\n\n5. 用户批准\n\n6. 执行配置\n```\n\n**为什么必须引用文档来源**：让用户知道你的方案有官方依据，而非猜测。如果配置出错，也便于回溯是文档问题还是操作问题。\n\n## 使用方法\n\n### 首次配置\n\n运行配置脚本完成权限设置和文档初始化：\n\n```bash\n# 进入技能目录\ncd path/to/use-openclaw-manual/\n\n# 运行配置脚本\n./setup.sh\n```\n\n配置脚本会：\n1. 检查必需依赖（git, curl, python3）\n2. 添加执行权限到所有脚本\n3. （可选）初始化官方文档\n\n### 快速搜索\n\n```bash\n# 搜索关键词（默认搜索内容）\n./run.sh --search \"cron schedule\"\n\n# 指定搜索类型\n./run.sh --search \"agent\" --type filename\n./run.sh --search \"notification\" --type title\n\n# 限制结果数量\n./run.sh --search \"discord\" --limit 5\n```\n\n### 查阅文档\n\n```bash\n# 列出目录内容\n./run.sh --list \"automation\"\n\n# 阅读特定文档\n./run.sh --read \"automation/cron.md\"\n```\n\n### 文档同步\n\n```bash\n# 增量同步（仅更新变更）\n./run.sh --sync\n\n# 仅检查更新（不同步）\n./run.sh --check\n```\n\n### 查看统计\n\n```bash\n./run.sh --stats\n```\n\n### 帮助\n\n```bash\n./run.sh --help\n```\n\n### 查找技能安装位置\n\n如果你不记得技能安装在哪里：\n\n```bash\n# 搜索技能目录\nfind ~ -name \"use-openclaw-manual\" -type d 2>/dev/null\n\n# 或搜索 run.sh 文件\nfind ~ -path \"*/use-openclaw-manual/run.sh\" 2>/dev/null\n```\n\n找到后 `cd` 进入该目录即可使用。\n\n## 详细文档\n\n本技能提供以下详细文档：\n\n| 文档 | 用途 | 何时读取 |\n|------|------|---------|\n| [references/scripts.md](references/scripts.md) | 脚本详细说明 | 首次使用或忘记参数时 |\n| [references/troubleshooting.md](references/troubleshooting.md) | 故障排除指南 | 遇到错误或异常时 |\n\n> **Agent 提示**：搜索时优先使用英文关键词（如 `notification`, `cron`, `gateway`），可获得更准确的搜索结果。\n\n### 快速导航\n\n- **了解脚本功能** → 读取 `references/scripts.md`\n- **搜索无结果** → 读取 `references/troubleshooting.md` 的\"搜索无结果\"章节\n- **同步失败** → 读取 `references/troubleshooting.md` 的\"同步失败\"章节\n- **查看日志** → 读取 `references/troubleshooting.md` 的\"日志分析\"章节\n\n## 环境变量\n\n| 变量 | 默认值 | 必需 | 说明 |\n|------|--------|------|------|\n| `OPENCLAW_MANUAL_PATH` | `~/.openclaw/workspace/docs/openclaw_manual` | 否 | 文档存储路径 |\n| `LAST_COMMIT_FILE` | `$OPENCLAW_MANUAL_PATH/.last-docs-commit` | 否 | 同步基线文件 |\n| `DOC_UPDATE_LOG` | 技能目录内 `docs-update.log` | 否 | 同步日志 |\n| `DOC_NOTIFY_CHANNEL` | `webchat` | 否 | 通知渠道（设为 `none` 禁用） |\n| `GITHUB_TOKEN` | 无 | 否 | GitHub API Token（提高速率限制） |\n\n### 运行时依赖\n\n脚本执行前会自动检查以下工具：\n\n- ✅ `git` - 文档同步（必需）\n- ✅ `curl` - GitHub API 调用（必需）\n- ✅ `python3` - JSON 解析（必需）\n- ⚠️ `jq` - JSON 输出（可选，用于 `--json` 模式）\n- ⚠️ `openclaw` CLI - 发送通知（可选，缺失时跳过通知）\n\n如缺少必需依赖，脚本会报错并退出。\n\n## 配置规范\n\n### ✅ 必须做\n\n- **配置前搜索文档** —— 即使你\"记得\"怎么配\n- **引用文档来源** —— 在方案中说明依据\n- **以文档为准** —— 文档与经验冲突时，相信文档\n- **定期同步** —— 确保文档最新\n\n### ❌ 禁止做\n\n- 未查文档直接配置\n- 凭猜测填写配置字段\n- 忽略文档中的警告或注意事项\n- 跳过用户批准步骤\n\n## 示例场景\n\n### 配置 Discord 通知\n\n```\n用户：帮我配置 Discord 通知\n\n助手：\n1. 进入技能目录\n   $ cd path/to/use-openclaw-manual/\n\n2. 搜索文档\n   $ ./run.sh --search \"discord notification\"\n\n3. 找到相关文档\n   - channels/discord.md\n   - automation/notifications.md\n\n4. 设计方案（引用文档）\n   \"根据 channels/discord.md 第 3 节，配置步骤如下：...\"\n\n5. 用户批准后执行\n```\n\n### 配置定时任务\n\n```\n用户：设置一个每天早上 9 点运行的任务\n\n助手：\n1. 搜索文档\n   $ ./run.sh --search \"cron schedule every\"\n\n2. 查阅 automation/cron.md\n\n3. 设计方案\n   \"根据 cron.md，使用 schedule.kind='every'，everyMs=86400000...\"\n```\n\n## 故障排除\n\n| 问题 | 原因 | 解决 |\n|------|------|------|\n| 文档目录为空 | 未初始化 | `--init` |\n| 搜索无结果 | 关键词不匹配 | 换关键词或检查是否已同步 |\n| 同步失败 | 网络问题 | 检查网络，查看日志 |\n\n详细故障排除见 [references/troubleshooting.md](references/troubleshooting.md)\n\n## 脚本说明\n\n详细脚本文档见 [references/scripts.md](references/scripts.md)\n\n- `scripts/sync-docs.sh` - 文档同步\n- `scripts/search-docs.sh` - 文档搜索\n- `run.sh` - 入口脚本\n\n## 文件结构\n\n```\nuse-openclaw-manual/\n├── SKILL.md                          # 技能说明（本文件）\n├── run.sh                            # 入口脚本\n├── scripts/\n│   ├── sync-docs.sh                  # 文档同步\n│   └── search-docs.sh                # 文档搜索\n├── references/\n│   ├── scripts.md                    # 脚本详细文档\n│   └── troubleshooting.md            # 故障排除\n└── .initialized                      # 初始化标记（自动创建）\n```\n\n## 相关资源\n\n- 本地文档：`~/.openclaw/workspace/docs/openclaw_manual/`\n- 官方文档：https://docs.openclaw.ai\n- 社区：https://discord.com/invite/clawd\n\n---\n\n*版本：v2.0.0 | 最后更新：2026-03-11*\n","topics":["Cron","文档"],"tags":{"latest":"2.0.3"},"stats":{"comments":0,"downloads":976,"installsAllTime":37,"installsCurrent":3,"stars":0,"versions":8},"createdAt":1772670688111,"updatedAt":1778491726627},"latestVersion":{"version":"2.0.3","createdAt":1774237967866,"changelog":"修复 sync-docs.sh 脚本的 5 个 bug：wc -l 空格、目录切换、git clone 错误处理、管道退出状态、通知渠道","license":"MIT-0"},"metadata":null,"owner":{"handle":"echoflying","userId":"s1779g2p34ny1twfck85pamqn983ngm8","displayName":"echoflying","image":"https://avatars.githubusercontent.com/u/5063007?v=4"},"moderation":{"isSuspicious":false,"isMalwareBlocked":false,"verdict":"clean","reasonCodes":["review.llm_review"],"summary":"Review: review.llm_review","engineVersion":"v2.4.24","updatedAt":1780090044048}}