OpenClaw Encyclopedia
Overview
Use a docs-first workflow for OpenClaw work. Prefer the official OpenClaw documentation at https://docs.openclaw.ai/, consult cached local copies under .OpenClaw-Encyclopedia/ before re-fetching, and record useful official-doc excerpts plus environment-specific operational learnings so future work gets faster and safer.
This skill is for OpenClaw product/runtime/config semantics. It should trigger for real OpenClaw behavior, configuration, and operational questions — not for generic agent-writing, generic prompt design, or generic host-admin work that just happens to be happening on an OpenClaw machine.
Workflow
- 1. Classify the task
- Decide whether the task is an OpenClaw question, troubleshooting task, command-planning task, config review, automation/design task, or live operational task.
- Use this skill when the request is specifically about OpenClaw product behavior, configuration, commands, session/channel/node behavior, automation, pairings, or skill loading/configuration.
- Do not use this skill for generic skill-writing, generic prompt/instruction design, generic markdown/config editing, or generic Linux/systemd admin unless the question is specifically about OpenClaw behavior.
- 2. Check local cache first
- Use
.OpenClaw-Encyclopedia/ as the local knowledge/cache root.
- Check these locations first when relevant:
-
.OpenClaw-Encyclopedia/docs/docs.openclaw.ai/...
-
.OpenClaw-Encyclopedia/notes/components/...
-
.OpenClaw-Encyclopedia/notes/patterns/...
-
.OpenClaw-Encyclopedia/inventory/...
- If a cached page or note already answers the question well enough, use it.
- 3. Consult official OpenClaw docs before answering or touching the system
- Before answering direct or indirect OpenClaw questions that depend on product behavior, command syntax, feature boundaries, configuration semantics, or version-sensitive details, consult the official docs unless the answer is already well-supported by the local cache.
- Before performing direct OpenClaw CLI/configuration/operational work, consult the relevant docs first when:
- the exact command path matters
- configuration keys or feature semantics are easy to misremember
- the action could affect gateway behavior, sessions, channels, automation, pairing, security posture, tool exposure, or messaging behavior
- Do not improvise high-impact OpenClaw commands or config changes from memory when the docs are easy to check.
- 4. Cache consulted docs locally
- When you consult an OpenClaw doc page, save a normalized markdown/text cache copy under
.OpenClaw-Encyclopedia/docs/docs.openclaw.ai/....
- Mirror the official docs path structure as much as practical.
- Cache only pages actually consulted; do not try to mirror the whole docs site eagerly.
- Use
scripts/cache_doc.py when appropriate.
- 5. Separate official documentation from local observations
- Store official-doc-derived material under
.OpenClaw-Encyclopedia/docs/....
- Store environment-specific operational knowledge under:
-
.OpenClaw-Encyclopedia/notes/components/
-
.OpenClaw-Encyclopedia/notes/patterns/
-
.OpenClaw-Encyclopedia/inventory/
- Distinguish clearly between:
- official documented behavior
- observed local configuration/state
- inferred best-practice guidance
- 6. Record useful local learnings
- After useful live work, save durable notes such as:
- deployment layout and component roles
- gateway/runtime access methods
- discovered workflow relationships
- automation boundaries and operating patterns
- repeated gotchas or command/config patterns
- safe/unsafe operational boundaries for the environment
- Prefer concise durable notes over re-learning the same topology later.
Live Work Rules
- - Treat official docs lookup as the default preflight for non-trivial OpenClaw work.
- Prefer read/inspect first when entering an OpenClaw area you have not recently reviewed.
- Treat gateway config, auth/security, pairing, messaging/channel behavior, automation, and skill/plugin behavior as high-sensitivity areas.
- When uncertainty remains after checking cache + docs, say so and avoid bluffing.
- When answering a question, mention when useful whether the answer comes from cached official docs, a fresh official docs lookup, or live observed environment state.
Data Root
Use this workspace-local root for cache and notes:
Expected structure:
- - INLINECODE14
- INLINECODE15
- INLINECODE16
- INLINECODE17
Use scripts/init_workspace.py to create or repair the expected directory structure.
Note Destinations
- - Component-specific observations → INLINECODE19
- Reusable OpenClaw patterns/gotchas → INLINECODE20
- Environment-wide deployment/access info → INLINECODE21
- Cached official docs → INLINECODE22
Secrets / Sensitive Data
- - Do not store plaintext credentials, API keys, session tokens, private URLs, recovery codes, or other secrets in the encyclopedia notes/inventory tree.
- If a note needs to mention access details, keep it high-level and redact or omit secret material.
- Treat these workspace notes as operational memory, not as a secrets vault.
Resources
- -
scripts/init_workspace.py — create or repair the .OpenClaw-Encyclopedia/ directory tree. - INLINECODE25 — fetch and cache a consulted official OpenClaw docs page under
.OpenClaw-Encyclopedia/docs/.... - INLINECODE27 — detailed operating workflow and evidence-handling rules.
- INLINECODE28 — canonical
.OpenClaw-Encyclopedia/ directory structure. - INLINECODE30 — useful OpenClaw topic groupings for faster doc lookup.
Good Outcomes
- - Answer an OpenClaw question using cached or freshly checked official docs instead of guesswork.
- Inspect a live OpenClaw deployment after checking the relevant docs and record any new local operational knowledge.
- Build a growing local OpenClaw knowledge cache that makes later work faster, safer, and more grounded.
- Turn one-off OpenClaw discoveries into durable notes so future work does not rediscover them from scratch.
Avoid
- - Answering OpenClaw-specific questions purely from memory when docs are easy to consult.
- Treating local observed behavior as if it were guaranteed official documented behavior.
- Dumping large amounts of low-value docs into the workspace without a reason.
- Writing component-specific observations into the official-doc cache tree.
- Making high-impact live changes before checking the relevant docs when exact behavior matters.
OpenClaw 百科
概述
采用文档优先的工作流程处理 OpenClaw 相关工作。优先使用 https://docs.openclaw.ai/ 上的官方 OpenClaw 文档,在重新获取前先查阅 .OpenClaw-Encyclopedia/ 下的本地缓存副本,并记录有用的官方文档摘录以及特定环境的操作经验,以便未来的工作更快速、更安全。
此技能适用于 OpenClaw 产品/运行时/配置语义。它应针对真实的 OpenClaw 行为、配置和操作问题触发——而非针对恰好运行在 OpenClaw 机器上的通用智能体编写、通用提示设计或通用主机管理工作。
工作流程
- 1. 对任务进行分类
- 判断任务是 OpenClaw 问题、故障排除任务、命令规划任务、配置审查、自动化/设计任务还是实时操作任务。
- 当请求专门涉及 OpenClaw 产品行为、配置、命令、会话/通道/节点行为、自动化、配对或技能加载/配置时,使用此技能。
- 除非问题专门涉及 OpenClaw 行为,否则不要将此技能用于通用技能编写、通用提示/指令设计、通用 Markdown/配置编辑或通用 Linux/systemd 管理。
- 2. 首先检查本地缓存
- 使用 .OpenClaw-Encyclopedia/ 作为本地知识/缓存根目录。
- 在相关时首先检查以下位置:
- .OpenClaw-Encyclopedia/docs/docs.openclaw.ai/...
- .OpenClaw-Encyclopedia/notes/components/...
- .OpenClaw-Encyclopedia/notes/patterns/...
- .OpenClaw-Encyclopedia/inventory/...
- 如果缓存的页面或笔记已能充分回答问题,则直接使用。
- 3. 在回答或操作系统前查阅官方 OpenClaw 文档
- 在回答依赖产品行为、命令语法、功能边界、配置语义或版本敏感细节的直接或间接 OpenClaw 问题之前,除非答案已由本地缓存充分支持,否则应查阅官方文档。
- 在执行直接的 OpenClaw CLI/配置/操作工作之前,在以下情况下首先查阅相关文档:
- 确切的命令路径很重要
- 配置键或功能语义容易记错
- 该操作可能影响网关行为、会话、通道、自动化、配对、安全态势、工具暴露或消息行为
- 当文档易于查阅时,不要仅凭记忆即兴编写高影响力的 OpenClaw 命令或配置更改。
- 4. 在本地缓存已查阅的文档
- 当查阅 OpenClaw 文档页面时,在 .OpenClaw-Encyclopedia/docs/docs.openclaw.ai/... 下保存一份规范化的 Markdown/文本缓存副本。
- 尽可能镜像官方文档的路径结构。
- 仅缓存实际查阅的页面;不要急于镜像整个文档站点。
- 在适当时使用 scripts/cache_doc.py。
- 5. 将官方文档与本地观察结果分开
- 将源自官方文档的材料存储在 .OpenClaw-Encyclopedia/docs/... 下。
- 将特定环境的操作知识存储在:
- .OpenClaw-Encyclopedia/notes/components/
- .OpenClaw-Encyclopedia/notes/patterns/
- .OpenClaw-Encyclopedia/inventory/
- 清晰区分:
- 官方记录的行为
- 观察到的本地配置/状态
- 推断的最佳实践指南
- 6. 记录有用的本地经验
- 在完成有用的实时工作后,保存持久的笔记,例如:
- 部署布局和组件角色
- 网关/运行时访问方法
- 发现的工作流关系
- 自动化边界和操作模式
- 反复出现的陷阱或命令/配置模式
- 环境的安全/不安全操作边界
- 优先使用简洁持久的笔记,而不是之后重新学习相同的拓扑结构。
实时工作规则
- - 将查阅官方文档视为执行重要 OpenClaw 工作的默认前置检查。
- 当进入一个近期未审查过的 OpenClaw 领域时,优先进行读取/检查。
- 将网关配置、认证/安全、配对、消息/通道行为、自动化以及技能/插件行为视为高敏感领域。
- 在检查缓存和文档后仍存在不确定性时,应明确说明并避免猜测。
- 在回答问题时,如有必要,应说明答案来自缓存的官方文档、最新的官方文档查阅还是实时观察到的环境状态。
数据根目录
使用以下工作区本地根目录进行缓存和笔记:
- - .OpenClaw-Encyclopedia/
预期结构:
- - .OpenClaw-Encyclopedia/docs/docs.openclaw.ai/...
- .OpenClaw-Encyclopedia/notes/components/...
- .OpenClaw-Encyclopedia/notes/patterns/...
- .OpenClaw-Encyclopedia/inventory/...
使用 scripts/init_workspace.py 创建或修复预期的目录结构。
笔记存放位置
- - 特定组件的观察结果 → .OpenClaw-Encyclopedia/notes/components/<组件名称>.md
- 可复用的 OpenClaw 模式/陷阱 → .OpenClaw-Encyclopedia/notes/patterns/<主题>.md
- 环境范围的部署/访问信息 → .OpenClaw-Encyclopedia/inventory/*.md
- 缓存的官方文档 → .OpenClaw-Encyclopedia/docs/docs.openclaw.ai/...
机密/敏感数据
- - 不要在百科笔记/库存树中存储明文凭据、API 密钥、会话令牌、私有 URL、恢复代码或其他机密信息。
- 如果笔记需要提及访问细节,请保持高层次描述,并编辑或省略机密材料。
- 将这些工作区笔记视为操作记忆,而非机密保险库。
资源
- - scripts/initworkspace.py — 创建或修复 .OpenClaw-Encyclopedia/ 目录树。
- scripts/cachedoc.py — 获取并缓存已查阅的官方 OpenClaw 文档页面到 .OpenClaw-Encyclopedia/docs/... 下。
- references/workflow.md — 详细的操作工作流程和证据处理规则。
- references/cache-layout.md — 规范的 .OpenClaw-Encyclopedia/ 目录结构。
- references/topic-map.md — 有用的 OpenClaw 主题分组,便于更快地查找文档。
良好成果
- - 使用缓存或最新查阅的官方文档而非猜测来回答 OpenClaw 问题。
- 在查阅相关文档后检查实时 OpenClaw 部署,并记录任何新的本地操作知识。
- 构建一个不断增长的本地 OpenClaw 知识缓存,使未来的工作更快速、更安全、更有依据。
- 将一次性的 OpenClaw 发现转化为持久的笔记,以便未来的工作不必从头重新发现它们。
避免事项
- - 在文档易于查阅时,仅凭记忆回答 OpenClaw 特定问题。
- 将本地观察到的行为视为有保证的官方记录行为。
- 无理由地将大量低价值文档转储到工作区。
- 将特定组件的观察结果写入官方文档缓存树。
- 在确切行为很重要时,未查阅相关文档就进行高影响力的实时更改。