← 返回 Skills 市场
README Auto Generator
作者
ericlooi504
· GitHub ↗
· v1.0.0
· MIT-0
29
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-auto-gen
功能描述
Auto-generate comprehensive, well-structured README.md files by analyzing your project's codebase, dependencies, configuration, and structure. Scans package....
使用说明 (SKILL.md)
k97bbxr43z14qn7xh9v4hf5ktx865nad
安全使用建议
This appears safe for normal use as a README generator. Before installing or invoking it, make sure you are comfortable with the agent reading the target project’s files and review any generated README changes before committing them.
功能分析
Type: OpenClaw Skill
Name: readme-auto-gen
Version: 1.0.0
The skill bundle describes a utility for auto-generating README.md files by scanning project structure, source code, and configuration files (e.g., package.json, pyproject.toml). While the instructions in SKILL.md mention analyzing environment variables and configuration files, this behavior is consistent with the stated goal of documenting project requirements and setup. No evidence of data exfiltration, malicious execution, or harmful prompt injection was found in the provided files.
能力评估
Purpose & Capability
The described behavior—analyzing a codebase, configs, dependencies, and existing docs to generate README.md—is directly aligned with the skill’s purpose.
Instruction Scope
The skill says it may scan the entire project and update or generate README.md, so users should invoke it only in the intended repository and review the resulting documentation before publishing.
Install Mechanism
There is no install script or bundled code; it is instruction-only. The only declared required binary is git, which is reasonable for repository-aware documentation generation.
Credentials
Reading source code, package files, CI configs, and existing docs is proportionate for README generation, but it may expose project details to the agent context.
Persistence & Privilege
No credential use, background persistence, autonomous worker, or persistent memory mechanism is described in the artifacts.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-auto-gen - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-auto-gen触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
Initial release — auto-generate README.md from project structure and code analysis
元数据
常见问题
README Auto Generator 是什么？
Auto-generate comprehensive, well-structured README.md files by analyzing your project's codebase, dependencies, configuration, and structure. Scans package.... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 29 次。
如何安装 README Auto Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-auto-gen」即可一键安装，无需额外配置。
README Auto Generator 是免费的吗？
是的，README Auto Generator 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
README Auto Generator 支持哪些平台？
README Auto Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 README Auto Generator？
由 ericlooi504（@ericlooi504）开发并维护，当前版本 v1.0.0。
推荐 Skills