DeepSeek Harness 生态正在快速扩张，新插件往往缺少 README，从零手写文档是开发者第一小时的常见摩擦。dsh-readme-forge 从 package.json、cordis.patch.yml 和源码布局读取信息，生成包含标题、描述、安装命令、CLI、工具、开发和许可证的确定性起始文档。默认只读，写盘需显式开启。
核心功能¶
从配置文件中提取信息生成标准化的 README.md：
- 自动生成标题、描述、安装命令、CLI 说明、开发指南与许可证。
- 读取
cordis.patch.yml中的 Tools 配置。 - 零运行时依赖，默认只读，安全运行。
- 提供 CLI 工具与 Agent 可调用的
readme_forge接口。
安装与启用¶
通过 DSH 插件系统安装：
dsh plugin add dsh-readme-forge
也可作为独立 CLI 工具运行：
npx dsh-readme-forge .
典型用法¶
生成并覆盖现有 README 文件：
npx dsh-readme-forge . --write --overwrite
仅生成内容不写入磁盘（机器可读）：
npx dsh-readme-forge ./my-plugin --no-tools --json
查看 CLI 选项：
npx dsh-readme-forge --help
在 Harness 内使用（Agent 调用）¶
在 Harness Agent 中调用 readme_forge 工具，指定目录并开启写入：
{
"tool": "readme_forge",
"dir": "/path/to/plugin",
"write": true,
"overwrite": true
}
工具返回 dsh-readme-forge/v1 结果，包含生成内容与警告，仅在 options.write 为 true 时写入文件。
注意事项¶
- 默认只读，写入操作必须显式开启（
--write或write: true）。 - 零运行时依赖，可在任何环境安全执行。
- 生成的内容需与
package.json和cordis.patch.yml保持同步，以确保信息准确。
总结¶
dsh-readme-forge 解决了插件开发中文档缺失和重复劳动的问题，提供了确定性的文档生成流水线起点。它与 dsh-llms-forge 互补，前者生成 README，后者将其转换为 llms.txt，共同完善插件生态的可发现性。
