AI Agent Hub
Back to plugins
⚙️

dsh-readme-forge

Workflow Updated 2026.08.25

Run the following command in DeepSeek Harness:

dsh plugin install zoahdev/dsh-readme-forge

Paste the following prompt into your AI chat to install this plugin:

Run dsh plugin install zoahdev/dsh-readme-forge in DeepSeek Harness to install this plugin; the source repository is https://github.com/zoahdev/dsh-readme-forge

About this plugin

The DeepSeek Harness plugin ecosystem adds thousands of repositories every week, yet most ship without a readable README. For a new plugin author, hand-writing a title, description, CLI reference, tool list, and license block is the classic first-hour friction. dsh-readme-forge collapses that step into a single deterministic call: it reads package.json, cordis.patch.yml, and the source directory layout, then emits a structurally complete README starter covering title, summary, install command, CLI reference, tool documentation auto-extracted from cordis.patch.yml, development notes, and the license section, ready for a quick human polish.

The output is reproducible and CI-friendly, supporting --json output and standardized exit codes (0 clean, 1 warnings, 2 usage or IO error). Paired with dsh-plugin-doctor preflight and packed-artifact integration tests, README quality becomes a measurable quality gate. With zero runtime dependencies and a read-only default, any write to disk requires the explicit options.write flag, making it safe to run in any environment without unexpected side effects.

It serves three audiences: independent authors publishing or preparing a dsh plugin, maintainers who need to backfill documentation across a portfolio, and teams whose CI pipelines demand verifiable, auditable READMEs. Once generated, the output can be handed to the complementary dsh-llms-forge plugin to produce an llms.txt file, completing a full documentation pipeline from source code to human-readable and AI-readable artifacts.

Use Cases

  • New plugin authors generate a structured README starter before publishing
  • CI pipelines verify README completeness via --json output and exit codes
  • Maintainers backfill missing documentation across a plugin portfolio

Best For

  • Independent developers preparing a dsh plugin for release
  • Maintainers managing a portfolio of plugin repositories
  • CI/CD teams requiring a documentation quality gate