技能 readme-generator-free
📦
readme-generator-free
v1.0.0 内容修订 r1 安全 ⚙️ 外部命令🌐 网络访问
Create Accurate READMEs From Project Code
Project documentation becomes stale when it relies on assumptions. This skill inspects repository evidence and creates a tailored README with installation, usage, API, and license sections.
支持: Claude Codex Code(CC)
使用我的智能体安装
将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。
智能体请求
Review the Skillstore skill "readme-generator-free" from https://skillstore.io/skills/justhandledlabs-readme-generator-free.md and its manifest at https://skillstore.io/api/skills/justhandledlabs-readme-generator-free/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划，并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“readme-generator-free”。 Generate a README for this Node package from its current files.
预期结果:
- A title and description based on package metadata.
- Installation and usage sections based on verified package scripts.
- Dependency, contribution, and license details supported by repository evidence.
正在使用“readme-generator-free”。 Update this Python project README without running project code.
预期结果:
- Python setup guidance based on the detected package files.
- Entry-point and API summaries derived from source and docstrings.
- TODO labels for details that the repository does not establish.
正在使用“readme-generator-free”。 Create onboarding documentation for this Go service.
预期结果:
- Verified build, test, and run guidance from the Go module and project files.
- Public API notes supported by Go comments.
- Contribution and license sections with unresolved facts clearly marked.
安全审计
安全v1 • 2026/7/22 打开版本化报告
The apparent PowerShell invocation, badge URLs, and most backtick findings are documentation syntax, not executable behavior. Two instructions permit local help commands, which can execute arbitrary project initialization code. No prompt injection, credential access, or data-exfiltration intent was found.
2
已扫描文件
315
分析行数
2
复核项
0
已忽略误报
能力复核项 (2)
这些是真实的本地能力，对此技能可能是预期行为，因此需要复核，但不会按已确认恶意行为计分。
中
Ruby/shell backtick execution
- Usage examples from `--help` output when safe to run, otherwise from scripts and entry points
The instruction permits obtaining help output by running a local project command, which can execute arbitrary initialization code before showing help.
中
Ruby/shell backtick execution
- Only run `--help` commands when they are likely safe and local; skip them if the command may start
The skill explicitly allows local help commands, and untrusted project entry points can execute code before processing the help flag.
风险因素
⚙️ 外部命令 (26)
references/templates.md:106 SKILL.md:15 SKILL.md:20 SKILL.md:21 SKILL.md:22 SKILL.md:23 SKILL.md:24 SKILL.md:25 SKILL.md:26 SKILL.md:28 SKILL.md:29 SKILL.md:30 SKILL.md:31 SKILL.md:32 SKILL.md:34 SKILL.md:35 SKILL.md:36 SKILL.md:37 SKILL.md:40 SKILL.md:41 SKILL.md:45 SKILL.md:53 SKILL.md:60 SKILL.md:68 SKILL.md:69 SKILL.md:73
审计者: codex
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/justhandledlabs-readme-generator-free/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/justhandledlabs-readme-generator-free?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/justhandledlabs-readme-generator-free?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/justhandledlabs-readme-generator-free/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/justhandledlabs-readme-generator-free.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学术引用 (APA · BibTeX · CFF)
APA 引用
justhandledlabs. (2026). readme-generator-free security audit report (audit version 1) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/justhandledlabs-readme-generator-free/audits/1BibTeX 引用
@techreport{justhandledlabs-justhandledlabs-readme-generator-free-2026,
author = {justhandledlabs},
title = {readme-generator-free security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/justhandledlabs-readme-generator-free/audits/1},
note = {Author version 1.0.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "readme-generator-free security audit report (audit version 1)"
version: "1.0.0"
type: report
authors:
- name: "justhandledlabs"
date-released: "2026-07-22"
url: "https://skillstore.io/skills/justhandledlabs-readme-generator-free/audits/1"
identifiers:
- type: other
value: "skillstore:justhandledlabs-readme-generator-free:audit:1"
description: "Skillstore immutable audit report identifier"
Skillstore 评分
评分依据 证据置信度: 中 41
架构
100
可维护性
87
内容
65
社区
83
规范符合性
你能构建什么
Document a New Repository
Create a first README from existing manifests, entry points, scripts, comments, and license data.
Refresh Stale Project Instructions
Compare an existing README with current repository evidence and replace outdated installation or usage details.
Improve Contributor Onboarding
Produce clear setup, usage, API, contribution, and license sections for public collaboration.
试试这些提示
Generate a Basic README
Generate a README for this repository. Use only verified project files. Include installation, usage, contributing, and license sections. Mark missing facts as TODO.
Update an Existing README
Review the existing README against the repository. Correct stale commands and dependencies, preserve accurate content, and list each unresolved detail as a TODO.
Document a Command-Line Tool
Create a README for this command-line project. Identify entry points and manifest scripts. Do not execute project code. Derive examples from static files only.
Produce Release Documentation
Create a release-ready README. Document verified APIs from comments, map build and test commands, include accurate badges, and summarize the repository evidence used.
最佳实践
- Review every proposed command before publishing the README.
- Keep unknown facts as TODO items until repository evidence confirms them.
- Use static files instead of executing project commands when the repository is untrusted.
避免
- Do not invent dependencies, commands, APIs, environment variables, or deployment steps.
- Do not copy every template section when the repository lacks supporting evidence.
- Do not publish placeholder badges or license claims as verified facts.
常见问题
Which project types does this skill support?
It provides specific guidance for Node, Python, Go, Rust, and Java, plus evidence-based documentation for other repositories.
Can it update an existing README?
Yes. It can preserve accurate content while correcting details that conflict with current repository files.
Does it invent missing project details?
No. It uses TODO labels when manifests, source files, comments, or licenses do not provide enough evidence.
Will it run project commands?
It may run a local help command when considered safe. Untrusted repositories should use static analysis only.
Can it generate API documentation?
Yes, when JSDoc, docstrings, Go comments, Rust documentation comments, or JavaDoc describe public interfaces.
Where does it write the result?
It writes README.md in the project root unless the user requests another path.
开发者详情
许可证
MIT
作者版本
v1.0.0
Skillstore 修订
r1
引用
63a7faa9009090de3c32992de371fe05cd9642b6
维护新鲜度
2026/7/22
使用量
0 次下载 · 0 次浏览
文件结构