zoahdev/dsh-readme-forge
Generate README.md for DeepSeek Harness (dsh) plugin repositories from package.json + cordis.patch.yml + sourc
Generates a README.md for DeepSeek Harness plugin repositories from the artifacts that already exist — package.json, cordis.patch.yml and the source layout. The prompt behind it: every new plugin needs a README before humans or AI can find it, and most authors write it last or not at all. The tool produces a deterministic starter covering title, description, install command, CLI, the Tools section derived from cordis.patch.yml, development and license, which the author then polishes. It is read-only by default: --write is required to touch disk, and --overwrite is required to replace an existing README.
Install
dsh plugin add dsh-readme-forgeREADME install line (no profile flag is shown in the README — add --profile web if your dsh boots the web profile). It also runs fully standalone: npx dsh-readme-forge . generates a starter README for the plugin in the current directory, and --write is what actually writes the file. Read-only by default.
Compatibility
DSH plugin repositories (reads package.json + cordis.patch.yml + source layout). MIT-licensed, verified under the dsh-plugin topic. Companion to dsh-llms-forge, which generates llms.txt from the README you just forged.
Details
- Repo: zoahdev/dsh-readme-forge
- Category: Files & Data
- Stars: 0
- Version: 0.1.0 (npm dsh-readme-forge, verified 2026-09-11; the registry entry carries no repository field)
- Last push: 2026-08-18
- First seen: 2026-08-18
Recent updates
README documents the defaults explicitly: read-only unless --write is passed, --overwrite only valid together with --write, and --no-tools / --no-dev to omit those sections; --json returns structured output for scripting.
FAQ
- How do I install dsh-readme-forge?
- Run: dsh plugin add dsh-readme-forge (add --profile web if your dsh boots the web profile). It also runs standalone via npx dsh-readme-forge .
- Will it overwrite my existing README?
- No. It is read-only by default — you need --write to write README.md, and --overwrite (only with --write) to replace an existing one.
- What does the generated README contain?
- Title, description, install command, CLI, a Tools section derived from cordis.patch.yml, development and license — a deterministic starter derived from package.json plus cordis.patch.yml plus the source layout.