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，共同完善插件生態的可發現性。
