Plugin directory / Developer / dsh-readme
dsh-readme
Verified · install-tested on dsh uckkk
What it does
README 生成：扫描项目技术栈/目录结构/脚本，自动生成结构化 README.md
Works — verified, early-stage project
README 生成：扫描项目技术栈/目录结构/脚本，自动生成结构化 README.md It installs cleanly and boots without issues in our testing. It's early-stage but functional.
“Verified” means our automated CI actually ran dsh plugin add in a clean profile and it booted — nothing more. Feature descriptions and version compatibility are the author’s claims. This is not a security audit and not an endorsement of third-party code.
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
安装即在本机运行第三方代码，请自行审阅源码。
Install
Install the catalog once, then DeepSeek Harness can find and install any plugin from this site automatically:
dsh plugin add dshbase-catalogThen say "install dsh-readme for me" — your agent finds it in the directory and installs it. Docs: dshbase-catalog · verified packs.
This plugin is GitHub source (not published to npm) — install it straight from the repo:
Web profile:
dsh plugin --profile web add github:uckkk/dsh-readmeHeadless (CLI) profile:
dsh plugin --profile headless add github:uckkk/dsh-readmeTest report
Verified: L1 install + L2 load + L3 runtime from GitHub source on dsh 0.1.0-rc.6.
Share this badge
Drop this badge into your README — it links back here and updates automatically when our test status changes:
[](https://dshbase.com/plugins/dsh-readme/)<a href="https://dshbase.com/plugins/dsh-readme/"><img src="https://dshbase.com/badges/dsh-readme.svg" alt="dshbase install-tested"></a>