← 返回 Skills 市场
1033
总下载
0
收藏
3
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-generator
功能描述
Generate a production-quality README.md by analyzing project structure, framework, and code
安全使用建议
This skill appears to do what it says: scan files in a repository and generate a README. Before installing or running it, confirm the agent will only be given access to the project directory (so it doesn't read unrelated files), back up any existing README (or choose README.generated.md) as the instructions suggest, and ensure the repository does not contain secrets you wouldn't want read by the agent. Also verify how your agent implements filesystem access and whether it will actually prompt before overwriting files in your environment.
功能分析
Type: OpenClaw Skill
Name: readme-generator
Version: 1.0.0
The OpenClaw AgentSkill bundle 'readme-generator' is benign. Its instructions and embedded shell commands (`find`, `Get-ChildItem`) are entirely consistent with its stated purpose of analyzing project structure to generate a README.md. It reads common project configuration files and lists file paths, explicitly excluding sensitive directories like `.git` and `node_modules`. There is no evidence of data exfiltration, malicious execution, persistence, or prompt injection. The skill also includes a safeguard to ask the user before overwriting an existing `README.md`.
能力评估
Purpose & Capability
The name/description (README generator) matches the actions in SKILL.md: inspecting manifests, source files, CI, Dockerfiles, and producing a README. There are no unrelated credentials, binaries, or configuration paths requested.
Instruction Scope
Runtime instructions explicitly direct the agent to read repository files and run simple directory-listing commands (find / Get-ChildItem) and to write README.md (with a confirmation step described). These actions are within scope for generating a README. The skill does not instruct the agent to read unrelated system files, environment variables, or post data to external endpoints.
Install Mechanism
No install spec or code files are present (instruction-only). Nothing is downloaded or written to disk by an installer, so install risk is minimal.
Credentials
The skill declares no required env vars, credentials, or config paths. The SKILL.md does not attempt to access environment secrets beyond inferring configuration from repository files.
Persistence & Privilege
always is false and the skill does not request or modify other skills' configs or system-wide agent settings. It asks to write README.md in project root but specifies asking before overwriting.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of readme-generator.
- Analyzes project files and structure to generate a production-quality README.md.
- Detects frameworks, dependencies, and project configuration across multiple languages (Node.js, Python, Rust, Go, etc.).
- Infers install/run commands, generates relevant badges, and tailors documentation sections based on detected tools and frameworks.
- Handles monorepos, missing config files, and existing READMEs with user prompts and sensible defaults.
元数据
常见问题
README Generator 是什么？
Generate a production-quality README.md by analyzing project structure, framework, and code. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 1033 次。
如何安装 README Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-generator」即可一键安装，无需额外配置。
README Generator 是免费的吗？
是的，README Generator 完全免费（开源免费），可自由下载、安装和使用。
README Generator 支持哪些平台？
README Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 README Generator？
由 Fratua（@fratua）开发并维护，当前版本 v1.0.0。
推荐 Skills