前言¶

在 DeepSeek Harness (DSH) 的生态中，插件是扩展智能体能力的主要方式。面对一个新项目，手动编写 README.md 往往既耗时又容易遗漏关键信息，比如目录结构、脚本命令或技术栈细节。# dsh-readme 插件旨在解决这一痛点，通过扫描项目文件自动生成结构化的文档骨架。

是什么¶

这是一个工作流插件，由 uckkk 维护。它扫描项目（package.json、目录结构、技术栈、脚本、许可证），自动生成一份结构化的 README.md。它是纯 Node 实现，无需网络连接或外部服务。

核心功能¶

1. 项目扫描：读取 package.json、目录结构、脚本和许可证文件。
2. 技术栈识别：自动识别依赖，包括 React、Vue、Next、Vite、Express、NestJS、TypeScript、Tailwind 等。
3. 文档生成：生成包含标题、描述、安装、使用方法、项目结构树和许可证的结构化骨架。

安装与启用¶

1. 安装插件：

dsh plugin add dsh-readme

2. 安装后，需在 profile 的 package.json 文件的 dsh.profile.bundles 字段中添加 "dsh-readme"，以启用该插件。

典型用法¶

安装完成后，在会话中调用该插件注册的工具即可。

帮我给这个项目生成一份 README
→ 调用 generate_readme(root="/workspace")

适用场景与注意¶

• 该插件生成的是结构化骨架（含项目结构树、scripts），具体的功能特性、API 说明等可生成后再补充润色。
• 安全提示：安装即在本机运行第三方代码，请自行审阅源码与许可证（MIT）后再使用。

结尾¶

经过上面的步骤，你可以快速获得一份标准化的 README 骨架，专注于填充业务细节。相关代码与目录可在此查看：GitHub。