dsh-sdd-generator

Readme

# dsh-sdd-generator

A [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) plugin that scans a
codebase and generates a **Software Design Document (SDD)** outline — module inventory,
entry points, and a per-file summary.

## Install

```powershell
dsh plugin --profile web add dsh-sdd-generator
```

The plugin auto-mounts via its `dsh.bundle.patch` declaration (no manual `cordis.patch.yml`
editing needed). Restart `dsh web` afterwards.

## Use

In the chat, ask the model to generate an SDD, e.g.:

> "Generate an SDD for C:\Users\me\projects\my-app using the generate_sdd tool"

The model calls the `generate_sdd` tool with:

| param     | type     | description                                  |
| --------- | -------- | -------------------------------------------- |
| `root`    | string   | Absolute path to the codebase root to scan  |
| `maxFiles`| number   | Cap on files scanned (default 200, max 500) |

The tool returns a Markdown SDD skeleton that the model can then expand into a full document.

## Develop

This package ships plain JS (`lib/index.js`) so no build step is required for consumers.

```bash
npm publish        # publish to npm, then others can `dsh plugin add` it
```

Add the `dsh-plugin` topic to the GitHub repo to appear in community listings.

## License

MIT