用途:创建、更新和校验 README.md 文件,并自动检测项目类型与安装命令。
主要能力:
- 新建 README:对没有 README.md 的项目运行 scripts/init_readme.py [--path <project>] [--force],会从包文件检测项目类型、提取元数据(名称、描述、许可证)、从包管理器提取安装与测试命令,并按模板生成结构化 README。
- 更新已有 README:运行 scripts/update_readme.py [--path <project>],解析现有章节,刷新 <auto> 标签内的内容,保留标签外所有用户撰写的内容。
- 校验 README:运行 scripts/validate_readme.py [--path <project>] [--fix],检查必需章节是否存在、安装命令是否为最新、引用的文件是否存在;提供 --fix 时应用修复。
项目类型检测与安装命令:package.json + pnpm-lock.yaml 对应 nodejs,命令 pnpm install;package.json + yarn.lock 对应 nodejs,命令 yarn;package.json + bun.lockb 对应 nodejs,命令 bun install;仅 package.json 对应 nodejs,命令 npm install;pyproject.toml(poetry)对应 python,命令 poetry install;pyproject.toml(uv)对应 python,命令 uv sync;pyproject.toml 对应 python,命令 pip install -e .;Cargo.toml 对应 rust,命令 cargo build;go.mod 对应 go,命令 go build ./...。
自动生成章节:<auto> 标签内的内容会在更新时刷新,包括安装命令、测试命令、前置条件/版本;标签外的自定义说明会被保留。完整 README 模板结构见 references/template.md。
限制:资料未提供支持的语言范围、依赖要求、错误处理细节及平台限制等信息。