← 返回 Skills 市场
lanyasheng

README Craft

作者 _silhouette · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
88
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-craft
功能描述
README 写作与优化。从零创建、审计已有、或重写 README。 蒸馏自 OMC/ECC 实战 README + awesome-readme/Standard README/Art of README 社区标准 + ClawHub 10+ README skills。 当需要为项目写 README、审计 R...
安全使用建议
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.
功能分析
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.
能力评估
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.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install readme-craft
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /readme-craft 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Initial release: README writing, auditing, and rewriting with 22-item scoring
元数据
Slug readme-craft
版本 1.0.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

README Craft 是什么?

README 写作与优化。从零创建、审计已有、或重写 README。 蒸馏自 OMC/ECC 实战 README + awesome-readme/Standard README/Art of README 社区标准 + ClawHub 10+ README skills。 当需要为项目写 README、审计 R... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 88 次。

如何安装 README Craft?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-craft」即可一键安装,无需额外配置。

README Craft 是免费的吗?

是的,README Craft 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

README Craft 支持哪些平台?

README Craft 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 README Craft?

由 _silhouette(@lanyasheng)开发并维护,当前版本 v1.0.0。

💬 留言讨论