The DeepSeek Harness ecosystem is expanding rapidly. New plugins often lack README files, and writing documentation from scratch is a common source of friction in a developer’s first hour. dsh-readme-forge reads information from package.json, cordis.patch.yml, and the source-code layout to generate deterministic starter documentation with a title, description, install command, CLI section, tools section, development guide, and license. It is read-only by default, and writing to disk requires explicit opt-in.

Core Features

Extracts information from configuration files to generate a standardized README.md:

  • Automatically generates title, description, install command, CLI instructions, development guide, and license.
  • Reads the Tools configuration in cordis.patch.yml.
  • Zero runtime dependencies, read-only by default, and safe to run.
  • Provides CLI tooling and an Agent-callable readme_forge interface.

Installation and Enablement

Install through the DSH plugin system:

dsh plugin add dsh-readme-forge

It can also be run as a standalone CLI tool:

npx dsh-readme-forge .

Typical Usage

Generate and overwrite an existing README file:

npx dsh-readme-forge . --write --overwrite

Generate content only without writing to disk (machine-readable):

npx dsh-readme-forge ./my-plugin --no-tools --json

View CLI options:

npx dsh-readme-forge --help

Using It in Harness (Agent Invocation)

In a Harness Agent, invoke the readme_forge tool, specifying the directory and enabling writes:

{
  "tool": "readme_forge",
  "dir": "/path/to/plugin",
  "write": true,
  "overwrite": true
}

The tool returns a dsh-readme-forge/v1 result containing the generated content and warnings. It writes the file only when options.write is true.

Notes

  • Read-only by default; write operations must be explicitly enabled (--write or write: true).
  • Zero runtime dependencies, safe to execute in any environment.
  • Generated content must stay in sync with package.json and cordis.patch.yml to ensure accuracy.

Summary

dsh-readme-forge solves the problem of missing documentation and repetitive work in plugin development, providing a deterministic starting point for a documentation generation pipeline. It complements dsh-llms-forge: the former generates README files, and the latter converts them into llms.txt, together improving discoverability across the plugin ecosystem.

Project repository: https://github.com/zoahdev/dsh-readme-forge