dsh-office-tool

dsh-office-tool

A DeepSeek Harness (dsh) plugin that gives the agent complete Office document capabilities — create, read, query, and edit .docx / .xlsx / .pptx — by driving the OfficeCLI binary, plus in-document preview in the dsh web sidebar through dsh-better-sidebar.

Everything renders with OfficeCLI's built-in high-fidelity HTML engine, so the agent and the user can see the document (via the sidebar preview) instead of guessing from the DOM — no Microsoft Office required.

---

Features

• 9 model-facing tools (office_create / get / query / set / add / remove / view / batch + office_cli passthrough), covering the full OfficeCLI command surface (move/swap/merge/dump/import/validate/raw/… via office_cli).
• Structured --json envelopes everywhere — success {success, data} / failure {success:false, error:{code, suggestion}}, with OfficeCLI's self-healing error codes surfaced to the model.
• Sidebar preview: opening a .docx / .xlsx / .pptx in better-sidebar renders it with OfficeCLI's HTML engine in an iframe (auto-reloads when the file changes). A dedicated 「Office 预览」tab runs officecli watch for live SSE-refreshing preview while the agent edits.
• Works headless too: the tools activate in any profile (no web UI needed); only the preview routes wait for a web server.

Prerequisites

• dsh installed and a working profile (the web profile for preview).
• OfficeCLI binary available (officecli install, or any PATH install). The plugin fails loud at load if it cannot resolve the binary.
• For the sidebar preview: dsh-better-sidebar installed in the same profile.

Install

# into your web profile (requires dsh-better-sidebar for the preview)
dsh plugin --profile web add dsh-better-sidebar
dsh plugin --profile web add dsh-office-tool

# restart `dsh web`, then hard-refresh the browser (Cmd/Ctrl+Shift+R)

Install from a local checkout with dsh plugin --profile web add ./dsh-office-tool, or build/attach it from a clone of this repository (the prepare script builds lib/ on install):

git clone https://github.com/rong-coder/dsh-office-tool.git
cd dsh-office-tool && pnpm install
dsh plugin --profile web add ./dsh-office-tool

Configuration

Override rows in your profile cordis.patch.yml (a patch replaces a row's whole config):

- id: office-tool
  config:
    command: 'C:\path\to\officecli.exe'   # binary name or absolute path (env DSH_OFFICECLI wins)
    timeoutMs: 60000
    maxOutputBytes: 16777216
- id: office-tool-preview
  config:
    preview:
      allowOutsideWorkspace: false        # allow rendering absolute paths outside the host cwd
    watch:
      enabled: true
      idleSeconds: 300

command accepts a bare name resolved on PATH, or an absolute path (Windows .exe). $DSH_OFFICECLI overrides the default 'officecli'.

Tools

OfficeCLI's path/selector syntax and error codes apply throughout — see officecli --help or officecli help <fmt> <verb> for details.

Sidebar preview

The client half registers, through ctx.betterSidebar:

• File viewer (office:officecli, exts docx/xlsx/pptx, priority: 100): opens the file in an iframe served by the host /office/preview route, which renders it with officecli view <file> html. A refresh button and a lightweight mtime probe keep it current as the agent edits. Conflicts with the bundled docx/xlsx/pptx viewer are resolved by priority (100 wins).
• 「Office 预览」tab: enter a document path and it starts officecli watch (host-managed, ephemeral port) and iframes the live preview; the watch process stops when the tab closes or the plugin unloads.

Host routes (registered only when ctx.webServer exists — never in headless):

• GET /office/preview?path=…&cwd=…&page=… — rendered HTML (probe=1 → {mtime}).
• GET /office/watch?path=…&action=open|close|status — JSON {url, port} for the live tab.

Repository layout

GitHub で README 全文を読む →