← Back to Skills Marketplace
README Craft
by
_silhouette
· GitHub ↗
· v1.0.0
· MIT-0
88
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-craft
Description
README 写作与优化。从零创建、审计已有、或重写 README。 蒸馏自 OMC/ECC 实战 README + awesome-readme/Standard README/Art of README 社区标准 + ClawHub 10+ README skills。 当需要为项目写 README、审计 R...
Usage Guidance
This skill appears coherent for README auditing and generation. Before running it, consider: 1) Allow it to write only after you review diffs (use --mode audit or --score-only first). 2) If you don't want automated network access or shell commands, restrict or review uses of WebFetch/Bash/Agent in your agent policy—GIF generation or external badge fetching may trigger installs or network calls. 3) Because the skill may read repository files (package.json, pyproject.toml, source files), run it on trusted repos or a copy if you are concerned about sensitive information in the repository. No credentials are requested, which reduces risk.
Capability Analysis
Type: OpenClaw Skill
Name: readme-craft
Version: 1.0.0
The readme-craft skill is a highly detailed tool for generating and auditing project documentation, but it is classified as suspicious due to its use of high-risk tools like 'Bash', 'Write', and 'WebFetch' as defined in SKILL.md. These capabilities are used to scan local project files (e.g., package.json, Makefile) and validate external links, which are actions plausibly needed for the stated purpose but represent a significant attack surface. Additionally, references in references/badge-and-visuals.md to using external CLI tools like 'vhs' for visual asset generation further increase the risk of unintentional command execution if the agent processes malicious project metadata.
Capability Assessment
Purpose & Capability
Name and description match the manifest and included files: the skill audits, creates, and rewrites README files and references repo metadata (package.json, pyproject.toml, etc.). It requests no environment variables, no installs, and no config paths, which is appropriate for a documentation-focused skill.
Instruction Scope
SKILL.md instructs the agent to read README and project metadata, run a 22-item audit, and generate or rewrite README.md—these actions are within scope. However the allowed-tools list (Bash, WebFetch, Agent, Read/Write/Edit, Grep, Glob) gives the agent broad capabilities (network fetches and shell execution). The skill text references optional actions like generating GIF demos (vhs/asciinema) and verifying artifacts, which could require network access or installing tools; these are plausible for the stated purpose but grant the agent additional discretion. The instructions do not explicitly tell the agent to execute project code or exfiltrate data.
Install Mechanism
There is no install spec and no code files to execute; this instruction-only skill does not download or install third-party packages by default, reducing risk.
Credentials
The skill declares no required environment variables, no primary credential, and no config paths. Nothing requests unrelated credentials or elevated access beyond reading repository files.
Persistence & Privilege
always is false and the skill is user-invocable. It does not request permanent presence or attempt to modify other skills or system-wide settings. The skill will write README.md in create/rewrite modes but that behavior is consistent with its purpose.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-craft - After installation, invoke the skill by name or use
/readme-craft - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release: README writing, auditing, and rewriting with 22-item scoring
Metadata
Frequently Asked Questions
What is README Craft?
README 写作与优化。从零创建、审计已有、或重写 README。 蒸馏自 OMC/ECC 实战 README + awesome-readme/Standard README/Art of README 社区标准 + ClawHub 10+ README skills。 当需要为项目写 README、审计 R... It is an AI Agent Skill for Claude Code / OpenClaw, with 88 downloads so far.
How do I install README Craft?
Run "/install readme-craft" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is README Craft free?
Yes, README Craft is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does README Craft support?
README Craft is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created README Craft?
It is built and maintained by _silhouette (@lanyasheng); the current version is v1.0.0.
More Skills