← 返回 Skills 市场
jszesze

OpenClaw Docs

作者 Jason Szesze · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ 安全检测通过
65
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install jszesze-openclaw-docs
功能描述
OpenClaw documentation helper that caches the live docs index, searches page titles and URLs, fetches raw markdown docs, builds a local docs cache for full-t...
使用说明 (SKILL.md)

OpenClaw docs

Use this skill for OpenClaw product docs, not for general repo spelunking.

What this skill is good at

  • finding the right OpenClaw doc page quickly
  • fetching raw markdown from docs.openclaw.ai
  • caching the live docs index from https://docs.openclaw.ai/llms.txt
  • downloading docs locally for full-text search
  • tracking page additions/removals across snapshots of the docs index

What it does not do

  • it does not inject the whole docs site into context automatically
  • it does not guarantee config snippets are current unless you verify them against fetched docs
  • it does not replace local repo inspection when the answer depends on the user’s actual workspace state

Workflow

  1. Start with the live docs index.
  2. Search by keyword to find the most likely page.
  3. Fetch the raw markdown page.
  4. Quote or summarize the relevant section.
  5. Link the exact docs URL in the answer.
  6. For broad questions, build a local docs cache and run a full-text search.

Commands

Run scripts with bash.

Index and cache

bash ./scripts/cache.sh status
bash ./scripts/cache.sh refresh

Search and discovery

bash ./scripts/search.sh telegram
bash ./scripts/search.sh "group.*policy"
bash ./scripts/sitemap.sh
bash ./scripts/fetch-doc.sh gateway/configuration
bash ./scripts/fetch-doc.sh https://docs.openclaw.ai/channels/telegram

Local full-text cache

bash ./scripts/build-index.sh fetch
bash ./scripts/build-index.sh build
bash ./scripts/build-index.sh search "requireMention"
# optional smoke-test limit:
OPENCLAW_DOCS_FETCH_LIMIT=25 bash ./scripts/build-index.sh fetch

Change tracking

bash ./scripts/track-changes.sh snapshot
bash ./scripts/track-changes.sh list
bash ./scripts/track-changes.sh since 2026-05-01
bash ./scripts/recent.sh 7

Heuristics

  • setup or install: check start/, install/, channels/, gateway/
  • config fields or JSON5 shape: check gateway/configuration, gateway/configuration-reference, gateway/configuration-examples
  • CLI questions: check cli/
  • channel behavior: check channels/\x3Cprovider> and channels/troubleshooting
  • architecture or concepts: check concepts/
  • automation: check automation/
  • control UI, dashboard, web surfaces: check web/
  • node/device questions: check nodes/

Good defaults

  • Prefer fetched raw markdown over guessing from memory.
  • Prefer the smallest relevant page instead of dumping a broad overview page.
  • If a snippet matters operationally, verify it against the fetched page before giving it to the user.
  • For ambiguous terms, search first, then fetch.

Verified snippet notes

See ./snippets/common-configs.md for a few small, verified patterns copied from current docs pages. Treat them as helpers, not as a schema reference.

安全使用建议
This skill looks safe for its stated purpose of fetching and searching OpenClaw documentation. Before installing, note that provenance metadata is limited and keep fetches limited to OpenClaw documentation URLs.
功能分析
Type: OpenClaw Skill Name: jszesze-openclaw-docs Version: 1.0.0 The skill is a documentation helper designed to fetch, cache, and search markdown files from 'docs.openclaw.ai'. It uses standard shell utilities (curl, grep, awk, perl) to manage a local documentation index and track changes over time. The code logic is transparent, lacks obfuscation, and contains no evidence of data exfiltration or malicious execution; all network activity is directed toward the legitimate documentation domain specified in scripts/lib.sh.
能力评估
Purpose & Capability
The stated purpose is to search, fetch, cache, and compare OpenClaw documentation, and the included scripts implement those same functions.
Instruction Scope
The instructions focus on OpenClaw docs, but one fetch path accepts any http(s) URL if passed directly, so users should keep use limited to docs.openclaw.ai URLs.
Install Mechanism
There is no install spec and the source/homepage are not provided; the included shell scripts are visible and simple, but provenance is limited.
Credentials
Network access to fetch documentation and local cache writes are proportionate to the documented docs-helper purpose.
Persistence & Privilege
The only persistent state shown is a local docs cache and snapshots; there is no credential use, background process, or privilege escalation in the provided artifacts.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install jszesze-openclaw-docs
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /jszesze-openclaw-docs 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Fork and modernize clawddocs for current OpenClaw docs: working llms.txt cache, search, fetch, local full-text cache, snapshot tracking, and cleaned-up verified snippets.
元数据
Slug jszesze-openclaw-docs
版本 1.0.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

OpenClaw Docs 是什么?

OpenClaw documentation helper that caches the live docs index, searches page titles and URLs, fetches raw markdown docs, builds a local docs cache for full-t... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 65 次。

如何安装 OpenClaw Docs?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install jszesze-openclaw-docs」即可一键安装,无需额外配置。

OpenClaw Docs 是免费的吗?

是的,OpenClaw Docs 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

OpenClaw Docs 支持哪些平台?

OpenClaw Docs 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 OpenClaw Docs?

由 Jason Szesze(@jszesze)开发并维护,当前版本 v1.0.0。

💬 留言讨论