DeepSeek Harness plugin

dsh-readme

README 生成:扫描项目(package.json、目录结构、技术栈、脚本、许可证),自动生成结构化 README.md

Jump to install

Source facts

Repository
uckkk/dsh-readme
Latest update
Aug 19, 2026
Category
Tools & Capabilities
GitHub stars
0
Format
plugin
Catalog evidence
Upstream dsh.bundle evidence
Evidence path
package.json#dsh.bundle
Checked against
0.1.0-rc.8
Upstream check date
2026-08-20

This evidence comes from the upstream catalog. This site has not installed, run, or security-reviewed the plugin.

Install

Start with a prompt that asks an agent to review the GitHub repository and source. Switch to the command if you want to install it yourself.

Copy this prompt into DSH, Codex, or another agent and ask it to review the GitHub repository and source first.

Do not install or run any commands yet. Read this plugin's GitHub repository, README, and relevant source code. Then answer the questions below clearly and directly so I can decide whether it fits my needs:

1. What is this plugin, and what problem does it solve?
2. Who is it for, and what are its typical use cases?
3. How is it used after installation? Include one minimal example.
4. What known limitations or privacy, security, compatibility, or maintenance risks does it have?
5. Give a clear recommendation: recommend, conditionally recommend, or do not recommend, with reasons.

Distinguish statements documented by the repository, inferences from source code, and unknowns. If evidence is insufficient, say so explicitly. Do not guess or simply repeat the README.

GitHub: https://github.com/uckkk/dsh-readme
Plugin: dsh-readme
Author: uckkk

Check the source files

Read the README and other files from this plugin directory before installing.

File explorer3 files
README.mdSource · read only

dsh-readme · README 生成

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

提供的工具

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

安装

dsh plugin add dsh-readme

安装后在 profile 的 package.jsondsh.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

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