# @chaiyahang/dsh-scratchpad 中文文档

规范地址：https://npmcn.com/package/%40chaiyahang/dsh-scratchpad/

版本：0\.2\.9
npm 元数据更新时间：2026-11-07T12:16:06.292Z
中文译文更新时间：2026-11-09T12:55:41.849Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chaiyahang/dsh-scratchpad
原文对照：https://npmcn.com/package/%40chaiyahang/dsh-scratchpad/?lang=original
项目主页：https://github.com/Chaiyahang/dsh-scratchpad#readme
源码仓库：https://github.com/Chaiyahang/dsh-scratchpad

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：176 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-10-25T02:19:10.371Z
- 最新版本发布：2026-11-07T12:16:05.922Z
- 近 30 天下载量：2685（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

为 DeepSeek Harness 所制作的 Scratchpad 面板: 有标记的注释,图像和文件附件,可点击任务的 Markdown 预览, 有真实附件的发到聊天, 一个醒目快捷键, JSON 进出口, 和代理工具在 Host-side 存储器之上.

## 安装

```sh
npm install @chaiyahang/dsh-scratchpad
```

也可以使用：`pnpm add @chaiyahang/dsh-scratchpad`、`yarn add @chaiyahang/dsh-scratchpad`、`bun add @chaiyahang/dsh-scratchpad`

## README

# 便签 · DSH Scratchpad

[![test](https://github.com/Chaiyahang/dsh-scratchpad/actions/workflows/test.yml/badge.svg)](https://github.com/Chaiyahang/dsh-scratchpad/actions/workflows/test.yml) [![npm](https://img.shields.io/npm/v/@chaiyahang/dsh-scratchpad)](https://www.npmjs.com/package/@chaiyahang/dsh-scratchpad) [![npm downloads](https://img.shields.io/npm/dt/@chaiyahang/dsh-scratchpad)](https://www.npmjs.com/package/@chaiyahang/dsh-scratchpad) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://npmcn.com/package/%40chaiyahang/dsh-scratchpad/LICENSE)

给 DeepSeek Harness 的左栏便签插件：随手记、边写边存，Agent 也能读写。

要求 DSH `>=0.2.1-rc.2`；版本变化见 [CHANGELOG](https://npmcn.com/package/%40chaiyahang/dsh-scratchpad/CHANGELOG.md)。

## 功能

-   **双栏布局**：左栏输入、右栏便签流；长文在输入区内滚动，窄窗口自动单栏
-   **左侧栏入口**：点击打开便签面板，`⌘⇧S` 唤起聚焦，`⌘⇧N` 直接新建，`⌘⇧F` 聚焦搜索
-   **多条便签**：边写边存、置顶、搜索、删除二次确认，删错 7 天内可撤销，回收站可随时恢复或彻底删除
-   **附件**：图片/文件，支持选择、拖拽、粘贴；图片预览，文件下载
-   **Markdown 预览**：标题、强调、代码、列表、引用，链接可点击；`- [ ]` 待办可勾选并写回原文
-   **发送到对话**：一键送入当前输入框，图片/文件作为真实附件一并带上
-   **标签**：最多 12 个/条，列表按标签筛选
-   **导入导出**：单个 JSON（附件以 base64 内嵌），导入为合并语义
-   **Agent 工具**：`scratchpad_list / read / create / append / update / delete`

## 安装

把 `PROFILE` 换成你的 profile 名（例如 `desktop`）。从 npm：

```bash
dsh plugin --profile PROFILE add @chaiyahang/dsh-scratchpad@latest
```

从 GitHub（跟随默认分支）：

```bash
dsh plugin --profile PROFILE add github:Chaiyahang/dsh-scratchpad
```

或让插件管理器安装本地目录：`plugin_manager install_bundle /路径/到/dsh-scratchpad`。装完刷新页面。

> 从本地 `link:` 安装切换到 npm 时，`pnpm add <包名>` 会保留原来的 link；请用上面的 `@latest`，或先 `dsh plugin --profile PROFILE remove @chaiyahang/dsh-scratchpad` 再安装。

## 使用

| 操作 | 方式 |
| --- | --- |
| 唤起 | `⌘⇧S` / 点击左栏「便签」 |
| 新建 | 「新建便签」或 `⌘/Ctrl + Enter` |
| 标签 | 编辑器下方输入，回车/逗号确认，Backspace 删最后一个 |
| 预览 | 工具栏「预览」，勾选待办会写回 `- [x]` |
| 发到对话 | 卡片纸飞机，或编辑器「发到对话」 |
| 备份 | 列表右上「导出 / 导入」 |

## Agent 工具

| 工具 | 用途 |
| --- | --- |
| `scratchpad_list` | 列出便签，按文本/标签过滤 |
| `scratchpad_read` | 读全文、标签与附件绝对路径 |
| `scratchpad_create` | 新建（可带标签、置顶） |
| `scratchpad_append` | 追加一段 |
| `scratchpad_update` | 重写正文，可选替换标签 |
| `scratchpad_delete` | 删除便签及附件文件 |

## 数据与限制

-   数据在 `~/.dsh/scratchpad/`（`notes.json` + `files/`），不经过外部网络；卸载不清除
-   每次写入前自动轮转 `notes.json.bak`；文件损坏时自动留档为 `notes.json.corrupt-*` 并从备份恢复
-   图片直接预览；其他附件一律下载，不在浏览器内打开
-   附件是真实文件，Agent 读取时拿到绝对路径；Markdown 渲染不执行 HTML
-   UI 保存会检测其他改动（另一窗口或 Agent）：冲突时面板让用户选择「保留我的版本 / 改用已保存版本」，不会静默覆盖；Agent 工具之间仍是最后写入优先
-   删除为软删除：面板立即隐藏，7 天后连同附件文件一并清理；面板内「回收站」可查看、恢复或彻底删除，Agent 的删除同样可在此期间撤销
-   导入只有合并模式；数据仅本机，不跨设备同步
-   composer 不接受附件时（子会话、类型不支持等），附件名会以文本形式保留

## 开发与发布

```bash
node --check index.js && node --check client.js
npm test
```

打 `v*` tag 推送后，`.github/workflows/publish.yml` 通过 npm Trusted Publishing（OIDC）自动发布，并以 CHANGELOG 对应版本段落为 notes 创建 GitHub Release；首次启用需在 npm 包设置登记仓库与工作流，并设置仓库变量 `NPM_TRUSTED_PUBLISHING=true`。

## 链接

-   仓库：https://github.com/Chaiyahang/dsh-scratchpad
-   发布：https://github.com/Chaiyahang/dsh-scratchpad/releases
-   问题：https://github.com/Chaiyahang/dsh-scratchpad/issues
-   市场：已收录于 [awesome-dsh-plugin](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin)（[收录 PR](https://github.com/awesome-dsh-plugin/awesome-dsh-plugin/pull/9722)）和 [dshopen](https://github.com/polang233/dsh-plugin-index/issues/73)

MIT

## 常见问题

### @chaiyahang/dsh-scratchpad 是什么？

为 DeepSeek Harness 所制作的 Scratchpad 面板: 有标记的注释,图像和文件附件,可点击任务的 Markdown 预览, 有真实附件的发到聊天, 一个醒目快捷键, JSON 进出口, 和代理工具在 Host-side 存储器之上\.

### 如何安装 @chaiyahang/dsh-scratchpad？

在项目目录运行 npm install @chaiyahang/dsh-scratchpad，或使用 pnpm add / yarn add / bun add。

### @chaiyahang/dsh-scratchpad 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chaiyahang\_\_dsh-scratchpad 是否存在。

### @chaiyahang/dsh-scratchpad 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @chaiyahang/dsh-scratchpad 可以商用吗？

@chaiyahang/dsh-scratchpad 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chaiyahang/dsh-scratchpad 的下载量有多少？

根据 npm 官方下载统计，@chaiyahang/dsh-scratchpad 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,685 次，日均约 90 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chaiyahang/dsh-scratchpad 还在维护吗？

最新版本 0\.2\.9 发布于 2026/11/07（2 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

