dsh-readme

dsh-readme · README 生成

扫描项目（package.json、目录结构、技术栈、npm scripts、许可证），自动生成一份结构化的 README.md。纯 Node 实现，无网络、无外部服务。

提供的工具

工具	作用
generate_readme	扫描项目并生成 README.md（标题、描述、技术栈、安装、使用、项目结构、许可证）

安装

dsh plugin add dsh-readme

安装后在 profile 的 package.json 的 dsh.profile.bundles 中加入 "dsh-readme"。

用法示例

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

说明

• 技术栈从依赖自动识别（React/Vue/Next/Vite/Express/NestJS/TypeScript/Tailwind 等）。
• 生成的是结构化骨架（含项目结构树、scripts），具体功能特性、API 说明等可生成后再补充润色。

安装

dsh plugin add github:uckkk/dsh-readme

安装即在本机运行第三方代码，请自行审阅源码。

安装

dsh plugin add github:uckkk/dsh-readme

使用

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

许可

MIT

安装即在本机运行第三方代码，请自行审阅源码。