dsh-readme

by uckkk

0 工具与能力github 检测到 manifest package.json#dsh收录于 08-16

README 生成:扫描项目技术栈/目录结构/脚本,自动生成结构化 README.md

安装

dsh plugin --profile web add github:uckkk/dsh-readme

GitHub 源码安装:首次需按提示配置 allowBuilds 构建授权后重试

安装与环境配置指引、插件开发教程见 DSH 中文社区文档 ↗

安装即在你的机器上以你的权限运行第三方代码——它可读写文件、使用凭据、访问网络,DSH 的工具审批不会为插件代码加沙箱。「检测到 manifest」仅代表发现 dsh.bundle / dsh.plugin 清单,不构成兼容性或安全审查;安装前请审阅源码,不熟悉的插件先在不含密钥的环境试用。

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 说明等可生成后再补充润色。

原始 README: https://github.com/uckkk/dsh-readme/blob/main/README.md ↗