Introduction

In the DeepSeek Harness (DSH) ecosystem, plugins are the primary way to extend agent capabilities. When starting a new project, manually writing README.md is often time-consuming and prone to missing key information, such as directory structure, script commands, or technology stack details. The dsh-readme plugin aims to solve this pain point by scanning project files to automatically generate a structured documentation skeleton.

What Is It

This is a workflow plugin maintained by uckkk. It scans a project (package.json, directory structure, technology stack, scripts, license) and automatically generates a structured README.md. It is implemented purely in Node and does not require network access or external services.

Core Features

  1. Project scanning: Reads package.json, directory structure, scripts, and license files.
  2. Technology stack detection: Automatically detects dependencies, including React, Vue, Next, Vite, Express, NestJS, TypeScript, Tailwind, and more.
  3. Documentation generation: Generates a structured skeleton containing the title, description, installation, usage, project structure tree, and license.

Installation and Enablement

  1. Install the plugin:
dsh plugin add dsh-readme
  1. After installation, add "dsh-readme" to the dsh.profile.bundles field in the profile’s package.json file to enable the plugin.

Typical Usage

After installation, you can invoke the tool registered by the plugin in a session.

Help me generate a README for this project
→ Call generate_readme(root="/workspace")

Use Cases and Cautions

  • The plugin generates a structured skeleton (including the project structure tree and scripts). Specific features, API documentation, and other details can be supplemented and refined after generation.
  • Security notice: Installing it runs third-party code on your local machine. Please review the source code and license (MIT) before use.

Conclusion

By following the steps above, you can quickly obtain a standardized README skeleton and focus on filling in business details. The related code and directory can be viewed here: GitHub.