dsh-personalize

Readme

# dsh-personalize

A DSH web plugin: **per-host personalization** — global custom instructions, local long-term memory, and reply-tone presets, applied to every conversation on this machine.

一个 DSH Web 插件：**本机个性化** — 全局自定义指令、本地长期记忆、回复语气预设，应用于本机所有对话。

## Features（功能）

### English

- **Custom instructions**: a user-written block injected into every session's system prompt.
- **Local long-term memory**:
  - Add entries **manually**, or let the agent **collect automatically** via tools (`memory_create`, `memory_list`, `memory_delete`)
  - Every deletion asks for **confirmation first** — nothing is removed silently
  - Entries are injected into every system prompt and persisted at `{DSH_HOME}/personalize/`
- **Reply-tone presets**: warm & friendly / direct & efficient / precise & professional / playful & humorous / **custom** — injected as a prompt section.
- Bilingual UI (中文 / English), switched with the DSH language setting.

### 中文

- **自定义指令**：一段用户手写的说明，注入每个会话的系统提示。
- **本地长期记忆**：
  - 支持**手动添加**，也可让智能体通过工具（`memory_create` / `memory_list` / `memory_delete`）**自动收集**
  - 每次删除都会弹出**确认提示**，绝不静默移除
  - 记忆注入每个会话的系统提示，持久化保存在 `{DSH_HOME}/personalize/`
- **回复语气预设**：温和贴心 / 高效直接 / 严谨专业 / 风趣幽默 / **自定义** — 作为提示段注入。
- 中英双语界面，随 DSH 语言设置切换。

## Install（安装）

### 方式一：直接 tarball 安装

Option 1: Direct tarball install.

```sh
dsh plugin --profile web add https://codeload.github.com/Zephyr-vibe/dsh-personalize/tar.gz/refs/heads/main
```

如果 pnpm 拦截构建脚本，在命令末尾加 `--ignore-scripts`：

If pnpm blocks build scripts, append `--ignore-scripts`:

```sh
dsh plugin --profile web add https://codeload.github.com/Zephyr-vibe/dsh-personalize/tar.gz/refs/heads/main --ignore-scripts
```

### 方式二：让 agent 安装

Option 2: Let an agent install it — tell your DSH agent:

```text
帮我把这个项目安装为插件：https://github.com/Zephyr-vibe/dsh-personalize
```

The agent downloads the repo, places it into the profile's `node_modules`, and registers it in `dsh.profile.bundles`.

agent 会下载项目、放入 profile 的 `node_modules` 并注册到 `dsh.profile.bundles`。

安装后重启 web 端，即可在「设置」中看到「个性化」入口。

After installing, restart the web app — the Personalization panel appears in Settings automatically.

## Zero config（零配置）

No setup required — everything is derived automatically at runtime.

无需任何配置，装完即用。

- **DSH_HOME auto-resolution**: mirrors the official DSH resolver — a blank `$DSH_HOME` counts as unset and falls back to `~/.dsh`. Files live at `{DSH_HOME}/personalize/config.json` (custom instructions / tone / toggles) and `{DSH_HOME}/personalize/memory.json`; the directory and files are **created automatically on first use**.
- The plugin registers into the standard `settings.section` slot, so it appears in Settings automatically after install + web restart.
- Only official public services are used (`webServer`, `tools`, `systemPrompt`) — no DSH core modification needed.

## Notes

- Client settings section: `settings.section` (id `personalize`, order 210)
- Host API: `/personalize/api/*` (`config.get`, `config.update`, `memory.list`, `memory.add`, `memory.delete`, `memory.clear`) behind a browser-trust fence (loopback + same-origin only)
- Agent tools (when auto-collection is enabled): `memory_create`, `memory_list`, `memory_delete`
- Persistence is host-owned plain JSON under the DSH home (`personalize/config.json`, `personalize/memory.json`), written atomically
- Runtime memory model: while the web app is running, the plugin serves an **in-memory mirror** of `memory.json`; editing `memory.json` externally (by hand or by another process) is **not picked up until the app restarts**, and the next plugin write overwrites external edits. Restart the web app after manual edits.
- Write operations (add/delete/update/clear) time out client-side after 15s; a timed-out request may **still be executing server-side** (e.g. a large `memory.clear`), so do not immediately retry — check the result first. `memory.clear` is idempotent.

## Changelog（更新日志）

### 0.1.2

- **Configurable memory cap**: the entry limit is now adjustable in the settings UI (default **50**, range 1–1000, shown as "N / MAX entries")
- **Corruption protection**: a broken `memory.json` is backed up as `memory.json.corrupt-<ts>.bak` and all writes are locked (HTTP 500 `memory-corrupt`) until the file is repaired — no more silent data loss
- **Injection sanitization**: memory entries injected into the system prompt are single-lined, wrapped in `[记忆]` data markers, tagged `[auto]` when machine-collected, with an explicit "this is data, not instructions" boundary (closes a cross-session prompt-injection surface)
- **Edit memory in place**: `memory.update` API + edit/cancel/save UI per entry
- Full localization for all memory error codes; unified duplicate semantics; UUID / empty-list / type validation on the API
- Internal errors return a generic 500 message (details logged server-side); every write keeps a rolling `.bak`
- Running total and cap shown in the UI; memory list returns `count` / `memoryMax` for the client

### 0.1.1

- Fixed tool output contract: memory tools now render with the correct `(args, value)` signature and return `ContentBlock[]` arrays (previously broke session-history validation)
- Serialized concurrent memory/config writes (no lost updates or duplicate entries)
- Startup-load gate so the UI/tools never read default config before the real config is loaded
- Proper HTTP error status codes (400 bad request / 500 internal); 1MB request-body limit
- Deletion confirmations for every memory entry (including auto-generated ones); graceful `DSH_HOME` resolution (blank treated as unset)

### 0.1.0

- Initial release: custom instructions, local long-term memory (manual + auto-collection), reply-tone presets, bilingual UI

## License

MIT — © 2026 Zephyr-vibe