← Back to Skills Marketplace
zyqfxy

README Sync

by ZYQFXY · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
73
Downloads
1
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-sync
Description
在每次代码查询/修改工作开始前按需读取README.md了解项目状态,工作结束后按需更新README。触发场景:(1)用户询问项目相关问题(如"并发数是多少?"),(2)需要进行代码查询或修改时。读取时无需确认;写入README或代码时必须先确认。支持跨平台(Claude Code、OpenClaw、Trae、C...
Usage Guidance
This skill appears to do what it says (read/scan/update README), but there is a meaningful inconsistency: the documentation promises user confirmation before any write, yet the included script performs writes without prompting (adding pending items and the sync operation). Before installing or enabling it for autonomous use, consider: - Review the full scripts locally. Search for functions named sync, add, auto-init and confirm whether they prompt before writing. In particular, patch sync_to_readme to require explicit user confirmation if you expect interactive approval. - Test the tool in a disposable repository (backup your README first). Verify behavior of add, pending, sync, init, and auto-init commands. - If you plan to allow autonomous agent invocation, disable autonomous use until you can ensure writes are always gated by an explicit user prompt. Alternatively, restrict the skill to user-invoked only. - Note the skill creates a .readme_pending.json file in the project root; review that file for any cached content you may not want committed. - There is a truncated/possibly buggy section in the provided script (a partial token like "item.name.star" appears in the package listing). Verify the script runs correctly and fix any bugs before use. If the author updates the code so that all write actions prompt for explicit confirmation (or documents clearly which commands are non-interactive), the current concerns would be resolved.
Capability Analysis
Type: OpenClaw Skill Name: readme-sync Version: 1.0.0 The skill is a utility designed to help AI agents maintain project documentation by synchronizing updates to a README.md file. It includes a Python script (scripts/readme_operations.py) that handles reading specific Markdown sections, scanning project directory structures to infer technology stacks, and performing incremental updates to the README. The instructions in SKILL.md explicitly require user confirmation for any file modifications and focus on token-efficient reading strategies. No indicators of data exfiltration, unauthorized network access, or malicious execution were identified.
Capability Tags
cryptocan-make-purchases
Capability Assessment
Purpose & Capability
Name, description, SKILL.md, README.md and the included Python script all align: this skill is intended to read, scan, and update README.md and to cache pending update items. No unrelated credentials, binaries, or external services are requested.
Instruction Scope
SKILL.md repeatedly states that writes to README or code require user confirmation and that reads do not. The shipped script, however, will: (1) add pending items immediately (add_pending writes .readme_pending.json without confirmation), and (2) sync_to_readme writes README.md directly (no interactive confirmation in sync_to_readme). This is a direct mismatch between declared runtime policy and actual file operations. The script also scans the repository (iterates directories and lists code files) which is expected for the purpose but means it will access repo structure and up to 20 code file paths.
Install Mechanism
Instruction-only skill with a small Python utility included. No installers, downloads, or external packages are requested. No extracted archives or remote code installs were declared.
Credentials
The skill requests no environment variables, no credentials, and no config paths. File access is limited to the project tree (README.md and a dotfile .readme_pending.json), which is proportional to the documented functionality.
Persistence & Privilege
The skill is not force-enabled (always: false) and asks no special permissions, but it will write to repository files (.readme_pending.json and README.md). Because autonomous invocation is permitted by default on the platform, the mismatch (SKILL.md says writes require confirmation while the code performs writes without prompting) increases the risk of unintentional or unattended modifications. The skill does not modify other skills or system-wide settings.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install readme-sync
  3. After installation, invoke the skill by name or use /readme-sync
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release
Metadata
Slug readme-sync
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is README Sync?

在每次代码查询/修改工作开始前按需读取README.md了解项目状态,工作结束后按需更新README。触发场景:(1)用户询问项目相关问题(如"并发数是多少?"),(2)需要进行代码查询或修改时。读取时无需确认;写入README或代码时必须先确认。支持跨平台(Claude Code、OpenClaw、Trae、C... It is an AI Agent Skill for Claude Code / OpenClaw, with 73 downloads so far.

How do I install README Sync?

Run "/install readme-sync" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is README Sync free?

Yes, README Sync is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does README Sync support?

README Sync is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created README Sync?

It is built and maintained by ZYQFXY (@zyqfxy); the current version is v1.0.0.

💬 Comments