# DeepSeek Harness Usage & Cost Tracker (dsh-usage) [简体中文](./README.md) · **English** [GitHub](https://github.com/feiyang-dev/dsh-usage-plugin) · [npm](https://www.npmjs.com/package/@feiyang666/deepseekharnessdesktop) · MIT License **A community plugin for DeepSeek Harness** — records token usage and cost for every model call, with peak/off-peak billing, balance query, a calendar heatmap, and CSV / JSON / PNG export. ![License](https://img.shields.io/badge/license-MIT-blue.svg) ![Node](https://img.shields.io/badge/node-%3E%3D18-339933) ![Platform](https://img.shields.io/badge/platform-web%20%26%20desktop-4d9fff)
--- ## Overview dsh-usage is a **usage & cost tracker** plugin in the DeepSeek Harness ecosystem (a DSH plugin shipped as a Host + Client two-in-one package). After installation, **"Usage & Cost"** and **"Balance Query"** tabs appear in the Web UI, right after "Conversation" and "Trace": > Supports **Windows / macOS / Linux**: paths are handled per platform (`node:path`), and the folder picker / "reveal in file manager" use each OS's native mechanism (macOS: `osascript` / `open`; Linux: `zenity` / `xdg-open`). Balance query and export do not depend on Windows-only commands. - **Usage & Cost**: records each model call's token usage and cache hits (input miss / cache hit / cache write / output / reasoning / finish reason), and computes cost using DeepSeek's peak/valley or base pricing (peak hours are automatically priced by Beijing time 09:00–12:00 and 14:00–18:00). Model names come from the actual request parameters, so non-DeepSeek models are shown truthfully instead of "unknown model"; models without an official price are counted as 0. The overview shows a by-model table plus a by-API-provider × model drill-down (each provider grouped with every model's calls and peak/off-peak cost split) and a grand total row. - **Usage Calendar**: a monthly daily-usage heatmap (colored by cost or call count), hover for details including the peak/off-peak cost split, click a day for its call list and peak/off-peak totals, plus a per-day statistics table with peak cost / off-peak cost / total columns and monthly rollups. - **Cache Hit List**: newest-first, fully scrollable, with quick filters (Today / 7 days / 30 days / All) and custom date ranges; the summary line and footer total split peak vs off-peak consumption with a grand cost total. The list is paginated (100 rows per page), so it stays smooth even with large data volumes. - **Price Table**: the official DeepSeek API price table — base and peak/valley unit prices shown side by side (peak vs off-peak), editable in-panel and persisted to `pricing.json`, with a reset-to-default option. - **Balance Query**: queries your DeepSeek account balance using the configured `DEEPSEEK_API_KEY`. - **Export**: CSV / JSON / **PNG long image** (newest-first, up to the latest 2000 records, warns if exceeded; the PNG report includes peak/off-peak cost columns), to any directory (native picker), auto-opens the folder after export. - **Import**: merge-imports JSON / CSV files, deduplicated by time. - **Persistence**: records are written live to `/dsh-usage/usage-records.json` and restored on restart (cap 100000 records). - **UI adaptation**: panel typography scales with the app's display-size setting (em-relative fonts); table wrapping and spacing are tuned so large display sizes stay readable. --- ## Screenshots ### Usage & Consumption ![Usage & Consumption](./docs/assets/usage-overview.png) ### Balance Query ![Balance Query](./docs/assets/balance-query.png) ## Recommended Installation > Either method works and is equivalent. **We recommend the desktop app** — fully graphical, no command line needed. ### Option 1 (recommended): One-click via the desktop app Install [DeepSeek Harness Desktop](https://github.com/feiyang-dev/DeepSeek-Harness-Desktop), open it, then go to **"Install Plugins" → Recommended → Usage & Cost Tracker → Install** and click **"Restart Service Now"** to activate. ### Option 2: Command line ```bash # Prerequisite: install dsh (npm install -g @deepseek-ai/dsh) dsh plugin --profile web add @feiyang666/deepseekharnessdesktop ``` Or install to another profile: ```bash dsh plugin --profile web add @feiyang666/deepseekharnessdesktop dsh plugin --profile headless add @feiyang666/deepseekharnessdesktop ``` Restart the dsh web service after installation. Detailed manual install / wiring / uninstall / troubleshooting follows below. --- ## What's in the package One npm package = a **host half** (Node-side Cordis plugin: recording, billing, balance query, export — see `lib/index.js`) + a **client half** (browser-side panel — see `lib/client.js`, which talks to the host via `/usage/api`). The package integrates with DSH through two declarations: | Declaration | Purpose | | --- | --- | | `dsh.bundle.patch` (`cordis.patch.yml`) | Lets DSH recognize it as a **standard bundle plugin package**: `dsh plugin --profile add ` installs and wires it in one command, no manual config editing | | `dsh.client` + `exports["./client"]` | Lets the web client auto-load the browser panel at `/plugins//client.js` | So for users, **installation is one command** — no YAML editing, no manual file copying. --- ## Installation (for users) ### 0. Prerequisites - DeepSeek Harness installed (`npm install -g @deepseek-ai/dsh`, or a desktop app built on it, or `npx @deepseek-ai/dsh web`). - Option A (recommended) needs **pnpm**: `npm install -g pnpm` (or `corepack enable`). - Make sure `dsh` is on PATH (for the desktop app, run in its bundled terminal). ### 1. Method A (recommended): one command ```bash dsh plugin --profile web add @feiyang666/deepseekharnessdesktop ``` This does three things (all automatic): 1. Installs the package via pnpm into `~/.dsh/profiles/web` (auto-initializes the profile on first use); 2. Detects the package's `dsh.bundle` declaration and writes the package name into the profile's `dsh.profile.bundles` layer list; 3. After restart, DSH reads the package's `cordis.patch.yml` and mounts the plugin row into the app tree — **no manual config editing**. Same for other profiles (replace `web` with your profile name, e.g. `dsh plugin --profile headless add ...`; `dsh web` equals `dsh --profile web`). > Test a local tarball: `dsh plugin --profile web add C:\path\to\feiyang666-deepseekharnessdesktop-1.1.0.tgz` ### 2. Method B: manual install (no pnpm / no `dsh plugin`) Only for when you have no pnpm or want full manual control. **Do not `npm install` directly at `~/.dsh/profiles`** (that dir has no package.json; npm would treat the whole node_modules as residue and wipe it). **B1. Use pnpm but not `dsh plugin`:** ```bash cd ~/.dsh/profiles/web pnpm add @feiyang666/deepseekharnessdesktop # then manually append the plugin row to web/cordis.patch.yml (see B3) and restart ``` **B2. Or use npm:** add a minimal package.json to the profile first, then install: ```bash cd ~/.dsh/profiles/web # if no package.json exists there yet (only after `dsh plugin` init): # echo '{"name":"dsh-profile-web","private":true,"dependencies":{}}' > package.json npm install @feiyang666/deepseekharnessdesktop ``` **B3. Wire it up (once, idempotent):** append to `~/.dsh/profiles/web/cordis.patch.yml`: ```yaml - insert: - id: usage-plugin name: '@feiyang666/deepseekharnessdesktop' inject: - fs - webServer - subprocess - credentials - sandboxPolicy - agents ``` Or just run the package's built-in wiring script (auto-finds the profile and appends, idempotent): ```bash node node_modules/@feiyang666/deepseekharnessdesktop/scripts/wire.js ``` > ⚠️ The `inject` list is **required**: it makes Cordis wait until `fs` / `webServer` / `subprocess` / `credentials` / `sandboxPolicy` / `agents` are ready before activating the plugin. Without it the `/usage/api` route never registers and the panel fails with `Unexpected end of JSON input`. ### 3. Method C: desktop app The desktop app (e.g. [DeepSeek Harness Desktop](https://github.com/feiyang-dev/DeepSeek-Harness-Desktop)) uses the same `~/.dsh/profiles` underneath. Run Method A's command in any terminal, restart the app, and the plugin activates automatically (the app starts the same `dsh web`). ### 4. Restart and verify Restart the DeepSeek Harness web app (command line: kill the old process and re-run `dsh web`; desktop: fully quit and reopen). Then: - Refresh http://127.0.0.1:3080 — after "Conversation" and "Trace", you should see **"Usage & Cost"** and **"Balance Query"** tabs; there are entries in Settings too. - The "Usage & Cost" panel contains **Overview / Usage Calendar / Cache Hit List / Price Table** subtabs. - Send a message and the "Usage & Cost" panel should show this call's token / cost record. ### 5. Configuration (for balance query) "Balance Query" uses the configured `DEEPSEEK_API_KEY`: set the API Key in **Settings → Models** (same key used for chats), then open the "Balance Query" tab and click "Query Balance". --- ## Uninstall ```bash dsh plugin --profile web remove @feiyang666/deepseekharnessdesktop ``` (Equivalent to pnpm remove; `dsh plugin` auto-removes the package name from the `dsh.profile.bundles` layer list.) Restart the app afterward. For manual installs (Method B), do it in reverse: remove the `usage-plugin` row from `cordis.patch.yml`, then `pnpm remove` / `npm uninstall` the package, and restart. > Upgrading from a 1.0.x manual-wiring install to 1.1.x: first remove the old `usage-plugin` row from `cordis.patch.yml` (or follow the uninstall flow), then reinstall via Method A to avoid mounting the plugin twice. --- ## Data & locations - Records: `/dsh-usage/usage-records.json` - Price config (edited & saved in the panel): `/dsh-usage/pricing.json` - Default export dir: `/dsh-usage/{csv,json,images}/` - Custom export dir: set in the panel's "Export target directory" or click "Choose directory…" - Startup diagnostics (if the plugin fails to activate): `dsh-usage-boot.log` in the session workspace --- ## FAQ | Symptom | Cause / Fix | | --- | --- | | Panel reports `Unexpected end of JSON input` | The plugin row is missing the `inject` list, so the route isn't registered. Add the inject list per Method B3 and restart | | Panel blank / no top tab | Plugin not activated. Check `dsh-usage-boot.log`; confirm the `cordis.patch.yml` row exists with the correct `name` | | Balance query fails with "DEEPSEEK_API_KEY not configured" | Set the API Key in Settings → Models | | Balance query network error | Ensure `api.deepseek.com` is reachable (configure a proxy if needed) | | `dsh plugin` reports pnpm not found | Install pnpm: `npm install -g pnpm` | | Install can't reach the npm registry | Set a mirror: `npm config set registry https://registry.npmmirror.com` (or `pnpm config set registry ...`) and retry | | After uninstall, still reports `Cannot find package '@feiyang666/...'` | A package reference remains in the profile. Remove the corresponding row from `cordis.patch.yml` and the package name from `dsh.profile.bundles`, then restart | --- ## Publish to npm (for maintainers) ```bash npm login # use your own npm account npm run check # pre-publish self-check (also runs via prepublishOnly) npm pack # inspect the tarball contents npm publish --access public # scoped packages must use --access public ``` > Publishing to public npm makes the source public — make sure no sensitive info is in the package (API keys are user-configured at runtime only). > If your network can't reach `registry.npmjs.org`, run `npm config set registry https://registry.npmjs.org` before publishing (the package's `.npmrc` presets this registry). --- ## Related Projects | Project | Description | Installation | | --- | --- | --- | | [DeepSeek Harness Desktop](https://github.com/feiyang-dev/DeepSeek-Harness-Desktop) | Windows desktop console: install/start/stop/restart the dsh web service with one click, built-in plugin management — **install this plugin from its Recommended section** | Download the desktop app and click a few buttons | | [Data Vault (dsh-vault)](https://github.com/feiyang-dev/deepseekharnessdesktop-vault) | Auto backup / wipe detection / one-click restore — protects chat history and workspace data | One-click from the desktop app, or `dsh plugin add @feiyang666/deepseekharnessdesktop-vault` | | [DeepSeek-Harness](https://github.com/deepseek-ai/DeepSeek-Harness) | Official CLI / Web service | Quick start below | ### Running DeepSeek Harness **Quick start (via npm)** Install Node.js, then run: ```bash npx @deepseek-ai/dsh web ``` This command starts the Web UI at the default address http://127.0.0.1:3080. See the [Web UI Guide](https://github.com/deepseek-ai/DeepSeek-Harness) for details. **Run from source** To run from the repository source: ```bash git clone https://github.com/deepseek-ai/deepseek-harness.git cd deepseek-harness pnpm install pnpm run build pnpm dsh web ``` ## Acknowledgements - **[@liu3734](https://github.com/liu3734)**: reported and diagnosed the Windows-only path handling / spawn issues on macOS (POSIX) and proposed the cross-platform fix ([#1](https://github.com/feiyang-dev/dsh-usage-plugin/issues/1)). ## License MIT © dsh-usage-plugin