dsh-plugin-office-fill-tool 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,75 @@
-# Temporary Holding Version
+# office fill tool（DSH 插件）
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+在 DeepSeek Harness 中批量生成 Office 文件：传入模板、数据台账和输出目录，返回生成的文件列表。
+
+## 形态
+
+- **bundle 插件**：`package.json` 声明 `dsh.bundle.patch`，由 `cordis.patch.yml` 插入插件行。
+- 入口 `index.js` 注册两个工具：
+  - `batch_generate_files`：无界面批量生成，返回 `folder`、`count`、`files`。
+  - `open_office_fill_tool`：打开图形界面，供手动操作。
+- `bin/office fill tool.exe` + `bin/_internal/`：PyInstaller onedir 程序，同时支持 GUI 和 `--cli` 模式。
+
+## 安装
+
+```sh
+dsh plugin --profile desktop add "C:\Users\Administrator\Desktop\DSH工作区\office fill tool"
+dsh --profile desktop --dump-config
+```
+
+发布给其他人：
+
+```sh
+# npm（先 pnpm publish）
+dsh plugin --profile desktop add dsh-plugin-office-fill-tool
+
+# tarball
+pnpm pack
+dsh plugin --profile desktop add .\dsh-plugin-office-fill-tool-0.1.0.tgz
+```
+
+## 工具参数
+
+`batch_generate_files`：
+
+| 参数 | 必填 | 说明 |
+|---|---|---|
+| `template` | 是 | Excel 模式用 `.xlsx` 模板；Word 模式用 `.docx` 模板 |
+| `data` | 是 | 数据台账 `.xlsx`，第一行为表头 |
+| `output_dir` | 是 | 输出目录（会在其下创建 `生成文件_YYYYMMDD`） |
+| `mode` | 否 | `excel`（默认）或 `word` |
+
+返回：
+
+```json
+{
+  "folder": "输出目录\\生成文件_20261025",
+  "count": 9,
+  "files": ["...xlsx", "...xlsx"]
+}
+```
+
+当前 Agent 看到的文本形式：
+
+```text
+已生成 9 个文件
+输出目录：...
+- ...\A区...xlsx
+- ...\B区...xlsx
+```
+
+## CLI 模式（exe 直接调用）
+
+```bat
+"office fill tool.exe" --cli --mode excel ^
+  --template "模板.xlsx" --data "台账.xlsx" ^
+  --output "输出目录" --result-file "result.json"
+```
+
+结果 JSON 写入 `--result-file`，同时尽量打印到 stdout。`ok` 为 `false` 时附带 `error` 和 `messages`。
+
+## 限制
+
+- 仅 Windows 可用。
+- 生成器会把配置/日志写在 `bin/` 目录；升级插件时可能丢失。
+- Word 模板中的页眉页脚、文本框等仍沿用 2.3 的替换范围。