zoahdev/dsh-readme-forge

dsh-readme-forge

npm

CI
License: MIT
dsh-plugin

根据 package.json + cordis.patch.yml + 源码布局，为 DeepSeek Harness（dsh）插件仓库生成 README.md。

每个新插件都需要一份 README，才能被人类或 AI 发现。这个工具会生成一份确定性的起始文档：标题、描述、安装命令、CLI、工具（来自 cordis.patch.yml）、开发说明和许可证——然后由你来润色。默认只读；写入需显式指定。它是 dsh-llms-forge 的配套工具（后者根据你刚刚生成的 README 生成 llms.txt）。

安装

dsh plugin add dsh-readme-forge

或独立运行：

npx dsh-readme-forge .

CLI

dsh-readme-forge [dir] [options]

--write        将 README.md 写入磁盘
--overwrite    替换已有的 README.md（仅在配合 --write 时生效）
--no-tools     从 cordis.patch.yml 中省略 Tools 部分
--no-dev       省略 Development 部分
--json         打印机器可读的 dsh-readme-forge/v1 结果
--help         显示此帮助

退出码：0 无问题，1 有警告，2 用法/IO 错误。

npx dsh-readme-forge . --write --overwrite
npx dsh-readme-forge ./my-plugin --no-tools --json

在 harness 内使用（可供 agent 调用）

向你的 dsh agent 提问：

给这个插件仓库生成一份 README：readme_forge，目录指向仓库根目录，写入并覆盖。
Generate a README for this plugin repo: readme_forge with dir set, then write: true, overwrite: true.

该工具会返回一个 dsh-readme-forge/v1 结果，包含建议的内容和警告，并且仅当 options.write 为 true 时才写入文件。

生成的内容

dsh-dep-audit

Dependency supply-chain hygiene audit for DeepSeek Harness ...

Install

dsh plugin add dsh-dep-audit

CLI

npx dsh-dep-audit --help

Tools

- dep_audit

Development

pnpm install && pnpm typecheck && pnpm build && pnpm test

License

MIT © 2026 zoahdev

Generated by dsh-readme-forge. Keep this file in sync with package.json and cordis.patch.yml.

为什么需要它

- 生态系统每周新增数千个插件；大多数都缺少 README，而从零手写一份 README 是新插件作者在第一小时里最大的摩擦点。
- 生成的 README 是确定性的，并且可在 CI 中检查（--json、退出码）——llms-forge 流水线正是从这里结束的地方开始。
- 零运行时依赖，默认只读，在任何地方运行都安全。

开发

pnpm install
pnpm typecheck
pnpm build
pnpm test
pnpm test:integration
CI 在 Windows 上运行 dsh-plugin-doctor 预检、单元测试、打包产物集成（真实 readme_forge 调用），以及全新 profile 的 dsh web 启动冒烟。

许可证

MIT © 2026 zoahdev

dsh-readme-forge（中文）

为 DeepSeek Harness（dsh）插件仓库生成 README.md：数据源是 package.json + cordis.patch.yml + 源码目录结构。

每个新插件在被人类或 AI 发现之前都需要 README。本插件生成确定性起始文档：标题、描述、安装命令、CLI、工具（取自 cordis.patch.yml）、开发与许可证——之后再人工润色。默认只读，写盘需显式开启。与 dsh-llms-forge 互补（它从刚生成的 README 再生成 llms.txt）。

安装

dsh plugin add dsh-readme-forge

独立使用：

npx dsh-readme-forge .

CLI

dsh-readme-forge [dir] [options]

--write        把 README.md 写到磁盘
--overwrite    覆盖已有 README.md（需配合 --write）
--no-tools     省略 cordis.patch.yml 的 Tools 小节
--no-dev       省略 Development 小节
--json         输出机器可读 dsh-readme-forge/v1 结果
--help         帮助

退出码：0 干净，1 有警告，2 用法/IO 错误。

npx dsh-readme-forge . --write --overwrite
npx dsh-readme-forge ./my-plugin --no-tools --json

在 harness 内使用（agent 可调用）

对 agent 说：

给这个插件仓库生成一份 README：readme_forge，目录指向仓库根目录，写入并覆盖。

工具返回 dsh-readme-forge/v1 结果（含生成内容与警告），仅在 options.write 为 true 时写盘。

为什么需要它

- 生态每周新增上千插件，多数没有 README；从零手写是插件作者第一小时的常见摩擦。
- 生成式 README 可复现、可进 CI（--json + 退出码）——llms-forge 管道的起点就在这里。
- 零运行时依赖、默认只读，任何环境都能安全跑。

开发

pnpm install
pnpm typecheck
pnpm build
pnpm test
pnpm test:integration

CI 跑 dsh-plugin-doctor 预检、单元测试、打包集成（真实 readme_forge 调用）、Windows 全新 profile 的 dsh web 启动冒烟。

许可证

MIT © 2026 zoahdev
相关生态工具

- dsh-dep-audit - 依赖供应链卫生
- dsh-quality-score - 插件质量评分卡 + 全注册表排行榜
- dsh-ecosystem - 健康扫描、影响、趋势、实时仪表盘
- dsh-tutorials - 双语插件流水线教程
常见问题

- 如何安装？ dsh plugin add dsh-readme-forge 或直接运行 CLI（见 README）。
- 需要 API key 吗？ 不需要。
- 是只读的吗？ 默认是；任何写入/应用都需要显式标志。
示例

完整 CLI 用法见 README。快速开始：

npx dsh-readme-forge --help