zoahdev/dsh-readme-forge

README 摘要

dsh-readme-forge Generate a README.md for DeepSeek Harness (dsh) plugin repositories from package.json + cordis.patch.yml + source layout. Every new plugin needs a README before it can be found by humans or AI. This one builds a deterministic starter: title, description, install command, CLI, tools (from cordis.patch.yml ), development, and license — then you polish. Read-only by default; writing is explicit. The companion to dsh-llms-forge (which generates llms.txt from the README you just forged). Install Or run standalone: CLI Exit codes: 0 clean, 1 warnings, 2 usage/IO error. In-harness usage (agent-callable) Ask your dsh agent: 给这个插件仓库生成一份 README： readme forge ，目录指向仓库根目录，写入并覆盖。 Generate a README for this plugin repo: readme forge with dir set, then write: true, overwrite: true . The tool returns a dsh-readme-forge/v1 result with the proposed content and warnings, and writes the file only when options.write is true. What it generates Why it exists - The ecosystem grows by thousands of plugins per week; most lack a README, and hand-writing one from scratch is the 1 first-hour friction for new plugin authors. - Generated READMEs are deterministic and CI-checkable ( --json , exit …

分类