# Send DocSync to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "docsync",
    "name": "DocSync",
    "source": "tencent",
    "type": "skill",
    "category": "效率提升",
    "sourceUrl": "https://clawhub.ai/suhteevah/docsync",
    "canonicalUrl": "https://clawhub.ai/suhteevah/docsync",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/docsync",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "config/lefthook.yml",
      "README.md",
      "scripts/analyze.sh",
      "scripts/docsync.sh",
      "scripts/drift.sh",
      "scripts/generate.sh"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "docsync",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-29T17:08:11.231Z",
      "expiresAt": "2026-05-06T17:08:11.231Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=docsync",
        "contentDisposition": "attachment; filename=\"docsync-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "docsync"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/docsync"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/docsync",
    "downloadUrl": "https://openagent3.xyz/downloads/docsync",
    "agentUrl": "https://openagent3.xyz/skills/docsync/agent",
    "manifestUrl": "https://openagent3.xyz/skills/docsync/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/docsync/agent.md"
  }
}
```
## Documentation

### DocSync — Living Documentation for Your Codebase

DocSync generates documentation from your code and keeps it in sync automatically. It uses tree-sitter for multi-language AST parsing, lefthook for git hook integration, and difftastic for semantic change detection.

### Free Tier (No license required)

docsync generate <file-or-directory>

Generate a one-shot README or API doc for a single file or directory.

How to execute:

bash "<SKILL_DIR>/scripts/docsync.sh" generate <target>

What it does:

Parses the target file(s) with tree-sitter to extract symbols (functions, classes, exports, types, interfaces)
Applies the appropriate template from <SKILL_DIR>/templates/
Generates a markdown documentation file alongside the source

Example usage scenarios:

"Generate docs for src/utils/auth.ts" → runs docsync generate src/utils/auth.ts
"Document this whole directory" → runs docsync generate src/api/
"Create a README for this project" → runs docsync generate .

### Pro Tier ($29/user/month — requires DOCSYNC_LICENSE_KEY)

docsync drift [directory]

Scan for documentation drift — find where code has changed but docs haven't been updated.

How to execute:

bash "<SKILL_DIR>/scripts/docsync.sh" drift [directory]

What it does:

Validates license key from config
Parses all source files with tree-sitter
Compares extracted symbols against existing documentation
Reports: new undocumented symbols, changed signatures with stale docs, deleted symbols still in docs
Outputs a drift report with severity levels (critical/warning/info)

docsync hooks install

Install git hooks that automatically check for doc drift on every commit.

How to execute:

bash "<SKILL_DIR>/scripts/docsync.sh" hooks install

What it does:

Validates Pro+ license
Copies lefthook config to project root
Installs lefthook pre-commit hook
On every commit: analyzes staged files, blocks commit if critical drift detected, offers auto-regen

docsync hooks uninstall

Remove DocSync git hooks.

bash "<SKILL_DIR>/scripts/docsync.sh" hooks uninstall

docsync auto-fix [directory]

Auto-regenerate stale documentation for files with detected drift.

bash "<SKILL_DIR>/scripts/docsync.sh" auto-fix [directory]

### Team Tier ($49/user/month — requires DOCSYNC_LICENSE_KEY with team tier)

docsync onboarding [directory]

Generate a comprehensive onboarding guide for new developers.

bash "<SKILL_DIR>/scripts/docsync.sh" onboarding [directory]

docsync architecture [directory]

Generate architecture documentation showing module relationships and data flow.

bash "<SKILL_DIR>/scripts/docsync.sh" architecture [directory]

### Supported Languages

DocSync uses tree-sitter grammars and supports:

JavaScript / TypeScript (including JSX/TSX)
Python
Rust
Go
Java
C / C++
Ruby
PHP
C#
Swift
Kotlin

### Configuration

Users can configure DocSync in ~/.openclaw/openclaw.json:

{
  "skills": {
    "entries": {
      "docsync": {
        "enabled": true,
        "apiKey": "YOUR_LICENSE_KEY_HERE",
        "config": {
          "outputDir": "docs",
          "templateOverrides": {},
          "excludePatterns": ["**/node_modules/**", "**/dist/**", "**/.git/**"],
          "languages": ["typescript", "python", "go"],
          "driftThreshold": "warning",
          "autoFix": false
        }
      }
    }
  }
}

### Important Notes

Free tier works immediately with no configuration
Pro/Team tiers require a license key from https://docsync.pages.dev
All processing happens locally — no code is sent to external servers
License validation is offline — no network calls needed
Git hooks use lefthook which must be installed (see install metadata above)
tree-sitter and difftastic are optional but recommended for best results; the skill falls back to regex-based parsing if unavailable

### Error Handling

If tree-sitter is not installed, fall back to regex-based symbol extraction (less accurate but functional)
If lefthook is not installed and user tries hooks install, prompt to install it
If license key is invalid or expired, show clear message with link to https://docsync.pages.dev/renew
If a language grammar is not available, skip that file with a warning

### When to Use DocSync

The user might say things like:

"Generate docs for this file/project"
"Are my docs up to date?"
"Check for documentation drift"
"Set up auto-docs on my commits"
"Create an onboarding guide"
"Document the architecture"
"What's undocumented in this codebase?"
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: suhteevah
- Version: 1.0.1
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-04-29T17:08:11.231Z
- Expires at: 2026-05-06T17:08:11.231Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/docsync)
- [Send to Agent page](https://openagent3.xyz/skills/docsync/agent)
- [JSON manifest](https://openagent3.xyz/skills/docsync/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/docsync/agent.md)
- [Download page](https://openagent3.xyz/downloads/docsync)