An automated project metadata synchronizer that uses package.json as the single source of truth to update Markdown documentation.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install sync-metadata
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install sync-metadata using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is sync-metadata?
The sync-metadata skill is designed to solve the common developer pain point of fragmented documentation. By declaring your package.json as the single source of truth, this Openclaw Skills extension automatically ensures that important project variables—such as version numbers, descriptions, licenses, and repository URLs—remain perfectly mirrored across all Markdown files like README.md and SPEC.md.
This utility eliminates manual copy-pasting and prevents outdated documentation. It scans project files for specialized HTML comment placeholders, matches them against your project configuration, and updates them safely after a differential review. It also comes complete with robust internationalization (i18n) capabilities to keep localized files up to date seamlessly.
sync-metadata Use Cases
- Automatically updating version numbers across README.md and structural spec documents right after a new release.
- Synchronizing project descriptions, display names, and licenses across multiple documentation files simultaneously.
- Migrating repository URLs or author information without having to manually hunt down individual references across markdown content.
- Running automated checks in CI pipelines to ensure localized documentation is completely synchronized with package configuration values.
How sync-metadata Works
- Read package.json: The skill accesses the root configuration file to extract top-level metadata values.
- Resolve i18n placeholders (Optional): If localized files like package.nls.json exist, it maps key strings wrapped in % tags to their localized equivalent.
- Scan Markdown Targets: It uses regex expressions to find comment boundaries matching
...across all.mdfiles. - Evaluate Differences: It compares the current contents inside the HTML comments against live values from the package configuration.
- Generate Summary Report: A visualization of matching status or proposed changes is outputted for user verification.
- User-Approved Write: After presenting the differential updates, it writes changes to the disk only upon direct user confirmation.
sync-metadata Setup
To use this capability within your Claude Code workspace using Openclaw Skills, run the built-in command shortcut or call it conversationally:
/sync-metadata
You can also trigger it by naturally asking the assistant to "sync metadata" or "update readme version".
sync-metadata Data Schema & Taxonomy
The skill targets placeholder tags within Markdown documentation. The following mappings show how package.json keys translate to the comment schema:
| Tag | Source Field | Example Value |
|---|---|---|
| `` | name |
ai-history-auto-record |
| `` | displayName or localized nls |
AI History Auto Record |
| `` | version |
0.0.1 |
| `` | description or localized nls |
Automated AI history tracking... |
| `` | license |
GPL-3.0 |
| `` | repository.url |
https://github.com/guoqw7/ai-history-auto-record |
| `` | author |
guoqw7 |
Nested fields within the JSON structure can be seamlessly queried using standard dot notation (e.g., repository.url).
sync-metadata Advanced Features
- Dry-Run Inspection: Run non-destructive compliance checks using the phrase "check metadata sync" to validate documentation accuracy without changing code files.
- Native Internationalization (i18n): Automatically evaluates
package.nls.jsonand language-specific pairs likepackage.nls.zh-CN.jsonwhen triggered with localized instructions like "sync Chinese metadata". - Interactive Diff Approvals: Provides a structured report detailing files modified and values changed before committing updates to the workspace disk.
SKILL.md
Loading
Related Openclaw Skills
Principal Agent Audit
A local diagnostic and optimization skill for auditing principal AI coordinators to enhance reliability, privacy, and delegation posture without risk of autonomous self-modification.
Podcast Feed Manager
An automated CLI wrapper designed to manage your huisheng.fm podcast feeds and episodes directly from an AI agent sandbox.
Agnes AI Image & Video Generation Skill
An advanced Openclaw Skills extension that equips AI agents with the ability to generate high-density text-to-image variations, image-to-image compositions, and motion videos using the Agnes AI API.
PR Quality Gate
An automated PR quality gate workflow that systematically performs code reviews, registers GitHub issues, and triggers AI-powered bug fixes before merging.
Trading Journal
An AI-powered local trading journal for recording, analyzing, and exporting futures and stock trade performance.
TDengine Database Integration
An integration extending Openclaw Skills with seamless connection, schema management, and optimized querying for TDengine timeseries databases.
Featured*
