Back to Details

tool-openclaw

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OpenClaw Expert

OpenClaw 专家

Goal: answer OpenClaw install/config/ops questions using the bundled docs snapshot under 
references/docs/
.
Default assumption: the snapshot is the source of truth. Do not guess command flags or config keys.
目标：使用
references/docs/
下附带的文档快照解答OpenClaw的安装/配置/运维问题。
默认前提：文档快照为权威信息来源。请勿猜测命令参数或配置项。

Inputs / I-O Contract (Required)

输入/输出契约（必填）

Reads (primary):
  • references/docs/**
    (offline mirror of 
    https://docs.openclaw.ai/*.md
    )
  • references/entrypoints.md
    (curated map)
  • references/troubleshooting.md
    (routing/playbook)
Writes:
  • None by default.
  • If refreshing the snapshot: 
    references/docs/**
    + 
    references/docs/__SNAPSHOT_INDEX.md
    + 
    references/docs/llms.txt
读取（主要来源）：
  • references/docs/**
    （
    https://docs.openclaw.ai/*.md
    的离线镜像）
  • references/entrypoints.md
    （精选导航图）
  • references/troubleshooting.md
    （问题排查指南）
写入：
  • 默认无写入操作。
  • 若刷新快照：
    references/docs/**
    + 
    references/docs/__SNAPSHOT_INDEX.md
    + 
    references/docs/llms.txt

Process (Required)

处理流程（必填）

  1. Triage the question into one area:
  • install / onboarding
  • gateway
  • channel (whatsapp/telegram/discord/mattermost/imessage)
  • nodes / web surfaces
  • remote access (ssh/tailscale)
  • auth / oauth
  • sandboxing / tools policy
  1. Search the snapshot before responding.
  • Prefer searching by the user's exact error string.
  • If no error string, search by the specific command/config key.
  • Open 1-2 relevant pages and extract the exact command/config fields.
  1. Respond using the template below and cite the docs you consulted.
  1. 将用户问题归类至以下领域之一：
  • 安装/入门引导
  • 网关
  • 渠道（WhatsApp/Telegram/Discord/Mattermost/iMessage）
  • 节点/网页端
  • 远程访问（SSH/Tailscale）
  • 认证/OAuth
  • 沙箱环境/工具策略
  1. 先搜索快照再回复。
  • 优先使用用户提供的精确错误字符串进行搜索。
  • 若无错误字符串，则按特定命令/配置项搜索。
  • 打开1-2个相关页面，提取精确的命令/配置字段。
  1. 使用以下模板回复，并标注查阅的文档。

Safety Notes (Required)

安全注意事项（必填）

  • Never ask for or echo secrets (tokens, API keys). If the user shares config/logs, ask them to redact.
  • Be explicit when a step is destructive (resetting sessions/state, deleting a profile). Require confirmation.
  • Do not recommend weakening security defaults (auth, sandboxing) unless the docs explicitly say so and you explain trade-offs.
  • 切勿索要或回显敏感信息（令牌、API密钥）。若用户分享配置/日志，请要求他们先脱敏。
  • 当某一步操作具有破坏性（重置会话/状态、删除配置文件）时，需明确说明，并要求用户确认。
  • 除非文档明确说明并需解释利弊，否则不得建议弱化安全默认设置（认证、沙箱）。

Search Workflow (Recommended)

搜索流程（推荐）

Use grep-style search first; do not read the entire snapshot.
Examples (regex search over Markdown):
  • Search by error text:
    • pattern: the exact error line (escape regex metacharacters if needed)
    • path: 
      references/docs
    • include: 
      *.md
  • Search by config key:
    • canvasHost
    • allowFrom
    • requireMention
    • session.mainKey
  • Search by command:
    • openclaw onboard
    • openclaw gateway
    • openclaw channels login
    • openclaw doctor
    • Legacy: 
      clawdbot ...
      may exist as a compatibility shim (see the docs).
If you need a page map, start with:
  • references/docs/__SNAPSHOT_INDEX.md
If the snapshot looks stale or missing pages, refresh it (see 
references/docs_snapshot.md
).
优先使用类grep的搜索方式；无需通读整个快照。
示例（针对Markdown文件的正则搜索）：
  • 按错误文本搜索：
    • 模式：精确的错误行（必要时转义正则元字符）
    • 路径：
      references/docs
    • 包含：
      *.md
  • 按配置项搜索：
    • canvasHost
    • allowFrom
    • requireMention
    • session.mainKey
  • 按命令搜索：
    • openclaw onboard
    • openclaw gateway
    • openclaw channels login
    • openclaw doctor
    • 旧版兼容：
      clawdbot ...
      作为兼容层存在（详见文档）。
若需页面导航图，可从以下文件开始：
  • references/docs/__SNAPSHOT_INDEX.md
若快照看起来过时或缺失页面，请刷新快照（详见
references/docs_snapshot.md
）。

Key Entry Points (Snapshot)

核心入口文档（快照）

  • references/docs/start/getting-started.md
  • references/docs/start/wizard.md
  • references/docs/gateway/configuration.md
  • references/docs/gateway/troubleshooting.md
  • references/docs/help/troubleshooting.md
  • references/docs/start/getting-started.md
  • references/docs/start/wizard.md
  • references/docs/gateway/configuration.md
  • references/docs/gateway/troubleshooting.md
  • references/docs/help/troubleshooting.md

Output Format (Required)

输出格式（必填）

Answer using this structure:
Diagnosis: <1 sentence>

Docs consulted:
- <path 1>
- <path 2>

Steps:
1) <actionable step>
2) <actionable step>

Verify:
- <how to confirm it worked>

If still failing:
- <what exact command output / log / config snippet to ask for>
请使用以下结构回复：
诊断：<一句话总结>

查阅的文档：
- <路径1>
- <路径2>

步骤：
1) <可执行步骤>
2) <可执行步骤>

验证：
- <确认操作成功的方法>

若仍失败：
- <需提供的精确命令输出/日志/配置片段>

Updating the Docs Snapshot

更新文档快照

The bundled docs snapshot lives under 
references/docs/
and is indexed by:
  • references/docs/__SNAPSHOT_INDEX.md
    (human/agent routing)
  • references/docs/__SNAPSHOT_INDEX.json
    (machine index)
To update/rebuild the snapshot index:
bash
cd tool-openclaw
附带的文档快照位于
references/docs/
下，索引文件为：
  • references/docs/__SNAPSHOT_INDEX.md
    （人工/Agent导航用）
  • references/docs/__SNAPSHOT_INDEX.json
    （机器索引用）
更新/重建快照索引：
bash
cd tool-openclaw

If you are working inside this repo instead of an installed skill:

若你在本仓库内工作而非使用已安装的技能：

cd skills/tool-openclaw

cd skills/tool-openclaw

./scripts/update.sh --mode index

Most common modes:

- `--mode seed`: fetch placeholders/missing pages only (fast, safe default)
- `--mode full`: refresh everything (slow)
- `--mode sync`: sync `/llms.txt` frontier → create missing placeholders + rebuild index (no page fetch)
- `--mode index`: only rebuild `__SNAPSHOT_INDEX.(md|json)`
- `--mode single --url <url>`: fetch one page and map it into `references/docs/**`

Optional localization (best-effort, falls back to English by default):

```bash
./scripts/update.sh --mode seed --locale zh-CN
Requires Node.js >= 18.
./scripts/update.sh --mode index

最常用的模式：

- `--mode seed`：仅获取占位符/缺失页面（快速、安全的默认选项）
- `--mode full`：刷新所有内容（较慢）
- `--mode sync`：同步`/llms.txt`中的待处理页面 → 创建缺失占位符 + 重建索引（不获取页面内容）
- `--mode index`：仅重建`__SNAPSHOT_INDEX.(md|json)`
- `--mode single --url <url>`：获取单个页面并映射至`references/docs/**`

可选本地化（尽力而为，默认回退至英文）：

```bash
./scripts/update.sh --mode seed --locale zh-CN
要求Node.js >= 18。

Searching Community Skills

搜索社区技能

Search community-built OpenClaw/Clawdbot skills from 
awesome-clawdbot-skills
:
bash
cd tool-openclaw
从
awesome-clawdbot-skills
搜索社区构建的OpenClaw/Clawdbot技能：
bash
cd tool-openclaw

If you are working inside this repo instead of an installed skill:

若你在本仓库内工作而非使用已安装的技能：

cd skills/tool-openclaw

cd skills/tool-openclaw

./scripts/search-skills.sh discord # Search by keyword ./scripts/search-skills.sh pdf document # Multiple keywords ./scripts/search-skills.sh --list # List categories ./scripts/search-skills.sh --refresh # Force refresh cache

Install found skills: `npx clawdhub@latest install <skill-slug>`
./scripts/search-skills.sh discord # 按关键词搜索 ./scripts/search-skills.sh pdf document # 多关键词搜索 ./scripts/search-skills.sh --list # 列出分类 ./scripts/search-skills.sh --refresh # 强制刷新缓存

安装找到的技能：`npx clawdhub@latest install <skill-slug>`

Resources

参考资源

  • Curated map into the snapshot: 
    references/entrypoints.md
  • Troubleshooting playbook: 
    references/troubleshooting.md
  • Snapshot notes + refresh: 
    references/docs_snapshot.md
  • 快照精选导航图：
    references/entrypoints.md
  • 故障排查指南：
    references/troubleshooting.md
  • 快照说明 + 刷新方法：
    references/docs_snapshot.md