Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Generate and auto-sync documentation from code with git hooks; detect and fix doc drift using tree-sitter parsing and semantic diffs locally.
Generate and auto-sync documentation from code with git hooks; detect and fix doc drift using tree-sitter parsing and semantic diffs locally.
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
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.
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.
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.
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 .
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]
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]
DocSync uses tree-sitter grammars and supports: JavaScript / TypeScript (including JSX/TSX) Python Rust Go Java C / C++ Ruby PHP C# Swift Kotlin
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 } } } } }
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
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
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?"
Workflow acceleration for inboxes, docs, calendars, planning, and execution loops.
Largest current source with strong distribution and engagement signals.