DSH Plugins
返回列表
⚙️

dsh-readme-forge

工作流 更新于 2026.08.25

在终端中运行以下命令:

dsh plugin install zoahdev/dsh-readme-forge

将以下提示词粘贴到 DeepSeek Harness 对话框中:

在 DeepSeek Harness 中执行 dsh plugin install zoahdev/dsh-readme-forge 即可安装该插件,源码仓库为 https://github.com/zoahdev/dsh-readme-forge

插件介绍

DeepSeek Harness 插件生态每周新增上千个仓库,但大多数在发布时缺少一份可读的 README。对新插件作者而言,从零手写标题、描述、CLI 参考、工具列表和许可证段落,往往是第一个小时最大的摩擦。dsh-readme-forge 将这一步压缩为一次确定性的调用:它读取 package.json、cordis.patch.yml 与源码目录结构,自动输出一份结构完整的 README 起始文档,涵盖标题、摘要、安装命令、CLI 参考、工具文档(从 cordis.patch.yml 提取)、开发说明与许可证段落,只需人工润色即可发布。

生成结果是可复现且可进 CI 的:支持 --json 输出与标准化退出码(0 干净、1 警告、2 用法或 IO 错误)。配合 dsh-plugin-doctor 预检与打包集成测试,README 质量可以成为一条可度量的质量门禁。零运行时依赖、默认只读,任何磁盘写入都必须显式开启 options.write 标志,在任何环境中运行都不会产生意外的副作用。

它适合三类用户:独立开发者在发布 dsh 插件前补齐文档、维护者需要为整个插件组合回填缺失的 README、以及团队 CI 流水线要求 README 可审计可验证。生成之后,可交给互补的 dsh-llms-forge 插件再生成 llms.txt,完成从源码到人类可读与 AI 可读文档的完整管道。

使用场景

  • 新插件作者发布前一键生成结构化 README 起始文档
  • CI 流水线用 --json 与退出码校验 README 完整性
  • 维护者批量为缺少文档的插件仓库回填 README

适合人员

  • 独立开发者,准备发布 dsh 插件
  • 管理多个插件仓库的组合维护者
  • 需要文档质量门禁的 CI/CD 团队