About

Imported from TheSethRose/OpenClaw-Docs-Sync (SKILL.md). Install upstream with npx skills add TheSethRose/OpenClaw-Docs-Sync. Copyright stays with the author.

OpenClaw Docs Sync

Name: openclaw-docs-sync
Author: TheSethRose

Purpose

Keep a local mirror of the OpenClaw framework docs, ClawHub CLI/docs, and the Skills repository. OpenClaw's built-in QMD memory backend indexes these docs for hybrid semantic search.

When to use

Use this skill when the agent needs fresh documentation or precise references from:

OpenClaw framework docs
ClawHub CLI/docs
Skills repo (all SKILL.md files)

Setup

Step 1: Run the sync script

Run the script whenever you need a fresh mirror:

# Recommended (portable)
npx tsx scripts/sync-docs.ts

# Or with Bun (fastest)
bun run scripts/sync-docs.ts

What it does:

Mirrors OpenClaw docs/ into ~/.openclaw/docs/openclaw-docs/
Mirrors ClawHub docs/ into ~/.openclaw/docs/clawhub-docs/
Mirrors Skills skills/ into ~/.openclaw/docs/openclaw-skills/
Runs security scans on downloaded content

Step 2: Add to openclaw.json

After syncing, add the path to your openclaw.json config using memory.qmd.paths:

{
  "memory": {
    "backend": "qmd",
    "citations": "auto",
    "qmd": {
      "includeDefaultMemory": true,
      "update": { "interval": "5m" },
      "paths": [
        {
          "name": "openclaw-docs",
          "path": "~/.openclaw/docs",
          "pattern": "**/*.{md,mdx}"
        }
      ]
    }
  }
}

How the agent uses synced docs

Once configured in openclaw.json, OpenClaw's QMD memory backend automatically:

Indexes the synced docs on startup and at regular intervals (default 5m)
Embeds chunks for hybrid search (BM25 + vectors + reranking)
Searches via memory_search tool when you ask questions
Retrieves exact file content via memory_get tool

The agent will cite sources like:

Source: qmd/openclaw-docs/concepts/memory.md#L45-L52

Repo structure in synced mirror

~/.openclaw/docs/
├── openclaw-docs/   # OpenClaw framework docs
├── clawhub-docs/    # ClawHub CLI docs  
└── openclaw-skills/ # All SKILL.md files from skills repo

Notes

The sync script only ingests .md and .mdx files
Synced docs are read-only; edit upstream repos to update
Security scans run automatically; threats logged to ~/.openclaw/security-scan.log
See QMD Backend docs for full configuration options

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/thesethrose-openclaw-docs-sync-openclaw-docs-sync/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

thesethrose-openclaw-docs-sync-openclaw-docs-sync.ocm.jsonjson

{
  "ocm": "1",
  "id": "thesethrose-openclaw-docs-sync-openclaw-docs-sync",
  "kind": "skill",
  "name": "openclaw-docs-sync",
  "description": "Sync OpenClaw + ClawHub + Skills docs into a local mirror for the QMD memory backend.",
  "publisher": "TheSethRose",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "openclaw",
      "clawhub",
      "skills",
      "docs",
      "memory",
      "qmd",
      "search",
      "github"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Sync OpenClaw + ClawHub + Skills docs into a local mirror for the QMD memory backend."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github",
      "repository": "https://github.com/TheSethRose/OpenClaw-Docs-Sync",
      "path": "SKILL.md",
      "ref": "62092bc320365dd19032a4810e41636b1e8e4c11",
      "url": "https://github.com/TheSethRose/OpenClaw-Docs-Sync/blob/62092bc320365dd19032a4810e41636b1e8e4c11/SKILL.md",
      "key": "TheSethRose/OpenClaw-Docs-Sync/SKILL.md"
    }
  },
  "instructions": "# OpenClaw Docs Sync\n\n## Purpose\nKeep a local mirror of the OpenClaw framework docs, ClawHub CLI/docs, and the Skills repository. OpenClaw's built-in QMD memory backend indexes these docs for hybrid semantic search.\n\n## When to use\nUse this skill when the agent needs **fresh documentation** or **precise references** from:\n- OpenClaw framework docs\n- ClawHub CLI/docs  \n- Skills repo (all `SKILL.md` files)\n\n## Setup\n\n### Step 1: Run the sync script\nRun the script whenever you need a fresh mirror:\n\n```bash\n# Recommended (portable)\nnpx tsx scripts/sync-docs.ts\n\n# Or with Bun (fastest)\nbun run scri",
  "cost": {
    "context_tokens": 588
  }
}

Fetch it by URL: GET /api/v1/registry/thesethrose-openclaw-docs-sync-openclaw-docs-sync/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.