@alpacachen/dsh-kanban 1.9.0 → 1.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -103
- package/README.zh.md +54 -103
- package/docs/guide.md +125 -0
- package/docs/guide.zh.md +125 -0
- package/docs/readme/board-en.png +0 -0
- package/docs/readme/board-zh.png +0 -0
- package/docs/readme/cover-en-mobile.png +0 -0
- package/docs/readme/cover-en.png +0 -0
- package/docs/readme/cover-zh-mobile.png +0 -0
- package/docs/readme/cover-zh.png +0 -0
- package/docs/testing-images.md +36 -0
- package/index.js +284 -12
- package/lib/client.js +112 -27
- package/package.json +12 -7
- package/search.js +7 -0
package/README.md
CHANGED
|
@@ -1,137 +1,88 @@
|
|
|
1
|
-
<
|
|
1
|
+
<p align="center">
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(max-width: 600px)" srcset="docs/readme/cover-en-mobile.png">
|
|
4
|
+
<img src="docs/readme/cover-en.png" alt="dsh-kanban — Plan together. See work move. A shared board for you and your agent in DeepSeek Harness." width="100%">
|
|
5
|
+
</picture>
|
|
6
|
+
</p>
|
|
2
7
|
|
|
3
|
-
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/@alpacachen/dsh-kanban"><img src="https://img.shields.io/npm/v/@alpacachen/dsh-kanban?style=flat-square&color=3867e8&label=npm" alt="npm version"></a>
|
|
10
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-3867e8?style=flat-square" alt="MIT license"></a>
|
|
11
|
+
<a href="https://awesome-dsh-plugin.com"><img src="https://awesome-dsh-plugin.com/badge.svg" alt="Awesome DSH Plugin"></a>
|
|
12
|
+
</p>
|
|
4
13
|
|
|
5
|
-
|
|
14
|
+
<p align="center">
|
|
15
|
+
<a href="README.zh.md">简体中文</a> · <strong>English</strong><br>
|
|
16
|
+
<a href="#get-started">Get started</a> · <a href="docs/guide.md">User guide</a> · <a href="docs/guide.md#agent-tool-reference">Agent tools</a>
|
|
17
|
+
</p>
|
|
6
18
|
|
|
7
|
-
|
|
19
|
+
<br>
|
|
8
20
|
|
|
9
|
-
|
|
10
|
-

|
|
11
|
-
[](https://awesome-dsh-plugin.com)
|
|
12
|
-

|
|
21
|
+
Turn plans from your conversations into tasks you can move forward. You and your agent share one board for planning, context, and progress, all inside DeepSeek Harness.
|
|
13
22
|
|
|
14
|
-
[
|
|
23
|
+

|
|
15
24
|
|
|
16
|
-
</
|
|
25
|
+
<p align="center"><sub>Current plugin UI · Isolated demo data · A separate board for every workspace</sub></p>
|
|
17
26
|
|
|
18
|
-
|
|
19
|
-
<tr>
|
|
20
|
-
<td width="50%"><img src="./image.png" alt="Full dsh-kanban board in light mode with English tasks, labels and priorities" width="100%"></td>
|
|
21
|
-
<td width="50%"><img src="./docs/screenshots/card-details-dark.png" alt="Full dsh-kanban board in dark mode with an open task drawer showing a Markdown description" width="100%"></td>
|
|
22
|
-
</tr>
|
|
23
|
-
</table>
|
|
27
|
+
## From a conversation to the next step
|
|
24
28
|
|
|
25
|
-
|
|
29
|
+
### Describe the goal. Let your agent create the tasks.
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
Ask your agent to break down a requirement, write implementation steps and acceptance criteria, and assign labels and priorities. With 19 built-in tools, the plan goes straight onto the board.
|
|
28
32
|
|
|
29
|
-
|
|
33
|
+
> Break phone sign-in into testable tasks. Check existing cards first to avoid duplicates. Write implementation steps and acceptance criteria for each card, and mark launch blockers as P0.
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
### See the progress. Take over at any time.
|
|
32
36
|
|
|
33
|
-
|
|
37
|
+
Drag cards between stages, then use search and filters to find the next task. Markdown descriptions, comments, and activity history keep the work's context in one place.
|
|
34
38
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
**Prepare a weekly meeting from the board**
|
|
42
|
-
|
|
43
|
-
> Use the current card statuses, descriptions, and comments to prepare our meeting notes: completed work, work in progress, and blockers that need coordination. Reference the relevant cards and suggest the three most useful next actions. Flag missing information as questions to resolve.
|
|
44
|
-
|
|
45
|
-
**Build a workflow for your profession**
|
|
46
|
-
|
|
47
|
-
> I'm a lawyer handling contract reviews and case preparation. Set up suitable stages and labels, then create cards for the matters I provide below. Record deliverables, required documents, and agreed dates in each description. Put matters with missing documents in “Waiting for documents.”
|
|
39
|
+
| What matters | How to find it |
|
|
40
|
+
| --- | --- |
|
|
41
|
+
| Important work | P0 / P1 / P2 priorities and custom labels |
|
|
42
|
+
| Upcoming deadlines | Due dates, due-today and overdue filters |
|
|
43
|
+
| Existing decisions | Search card IDs, titles, full descriptions, and comments |
|
|
48
44
|
|
|
49
|
-
|
|
45
|
+
### Bring the context back into conversation.
|
|
50
46
|
|
|
51
|
-
|
|
47
|
+
Paste or drop screenshots into a task, then choose **Chat with agent** to bring its text and saved images into the current conversation or a new one. Everything starts as an editable draft for you to review and send.
|
|
52
48
|
|
|
53
|
-
|
|
49
|
+
[Image and saving rules →](docs/guide.md#usage-details) · [More prompt examples →](docs/guide.md#prompt-examples)
|
|
54
50
|
|
|
55
|
-
|
|
56
|
-
| --- | --- | --- |
|
|
57
|
-
| Manage the board with 16 built-in `kanban_*` tools. | Edit, comment, drag, prioritize, label, and filter from the UI. | Install the prebuilt plugin—no frontend setup required. |
|
|
58
|
-
| **🗂️ Keep work separate** | **🌓 Feel at home** | **🤝 Share one source of truth** |
|
|
59
|
-
| Every DSH workspace gets its own board. | Follows your DSH language, theme, and dark mode. | You and the agent always see the same tasks and status. |
|
|
51
|
+
## Get started
|
|
60
52
|
|
|
61
|
-
|
|
53
|
+
**Desktop** — Open **Plugins**, add `@alpacachen/dsh-kanban`, and enable it.
|
|
62
54
|
|
|
63
|
-
|
|
55
|
+
**Web** — Run the command below, then restart `dsh web` to load the plugin.
|
|
64
56
|
|
|
65
57
|
```sh
|
|
66
58
|
dsh plugin --profile web add @alpacachen/dsh-kanban
|
|
67
59
|
```
|
|
68
60
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
```sh
|
|
72
|
-
dsh --profile web --dump-config
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
Look for a `dsh-kanban` layer in the output.
|
|
76
|
-
|
|
77
|
-
### 2. Open your board
|
|
78
|
-
|
|
79
|
-
Enter any workspace and choose the **Board** tab beside the conversation views. A fresh board starts with four familiar stages:
|
|
61
|
+
Enter a workspace and open the **Board** tab beside the conversation views. Start with four default stages:
|
|
80
62
|
|
|
81
|
-
|
|
63
|
+
**Todo → In Progress → Review → Done**
|
|
82
64
|
|
|
83
|
-
|
|
65
|
+
Declared compatibility: DSH **0.2.0-rc.2 / 0.2.1-rc.3**, on Web and desktop. Version 1.10 uses newer image-preview and conversation-attachment APIs; upgrade DSH first if you use 0.1.5.
|
|
84
66
|
|
|
85
|
-
|
|
67
|
+
<details>
|
|
68
|
+
<summary>Check the Web plugin configuration</summary>
|
|
86
69
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
## 🧩 Everything you need to keep work moving
|
|
92
|
-
|
|
93
|
-
### On the Board
|
|
94
|
-
|
|
95
|
-
- Create, edit, delete, and drag cards between lists
|
|
96
|
-
- Read task details in a resizable side drawer that remembers its width and fills narrow screens
|
|
97
|
-
- Write descriptions as Markdown source with **Edit**; **Done editing** previews the result and **Save** applies changes
|
|
98
|
-
- Add labels and P0 / P1 / P2 priorities
|
|
99
|
-
- Set an optional due date; spot tasks due today or overdue, and choose a completion column in the column editor so finished tasks stop showing alerts
|
|
100
|
-
- Exchange persistent card comments with the agent and see comment counts at a glance
|
|
101
|
-
- Open a card's activity timeline to see when it changed, what changed, and whether you or the agent made the change
|
|
102
|
-
- Track card creation, comments, moves, title and note edits, label changes, priority changes, and due date changes
|
|
103
|
-
- Send any card to the agent in your current conversation or a new one
|
|
104
|
-
- Create, rename, reorder, and remove workflow lists
|
|
105
|
-
- Create color-coded labels for fast visual scanning
|
|
106
|
-
- Filter the entire board by priority, label, and due date from the toolbar; combine filters or show only unlabeled cards
|
|
107
|
-
- Clear any filter with **All**, or manually refresh the board whenever needed
|
|
108
|
-
- Use **Feedback · GitHub** at the bottom of the toolbar to report an issue or suggest an improvement
|
|
109
|
-
|
|
110
|
-
### Continue any card with your agent
|
|
111
|
-
|
|
112
|
-
Open a card and choose **Chat with agent**. dsh-kanban carries its ID, title, label, due date, and notes into either the current conversation or a fresh one, so the agent has the context it needs immediately. The content is inserted as an editable draft—it is never sent until you choose to send it.
|
|
113
|
-
|
|
114
|
-
### In conversation
|
|
115
|
-
|
|
116
|
-
The plugin automatically gives the agent these tools in every workspace:
|
|
117
|
-
|
|
118
|
-
| Area | Tools |
|
|
119
|
-
| --- | --- |
|
|
120
|
-
| **Board** | `kanban_get`, `kanban_set_completed_column` |
|
|
121
|
-
| **Cards** | `kanban_get_card`, `kanban_add_comment`, `kanban_add_card`, `kanban_update_card`, `kanban_delete_card`, `kanban_move_card` |
|
|
122
|
-
| **Lists** | `kanban_add_column`, `kanban_rename_column`, `kanban_delete_column`, `kanban_move_column` |
|
|
123
|
-
| **Labels** | `kanban_get_label`, `kanban_add_label`, `kanban_update_label`, `kanban_delete_label` |
|
|
124
|
-
|
|
125
|
-
For `kanban_add_card` and `kanban_update_card`, the task description uses the existing `note` field: send raw Markdown with line breaks, not HTML. Headings, lists, tables and fenced code blocks are rendered in task details. Keep the source within 2,000 characters, including Markdown syntax and newlines; longer input is truncated with a warning. Before editing a description, read `kanban_get_card` for its complete Markdown source (`kanban_get` only returns a summary). Updating `note` replaces the whole description; omit it to preserve the current text, or pass an empty string to clear it. Comments remain plain text.
|
|
70
|
+
```sh
|
|
71
|
+
dsh --profile web --dump-config
|
|
72
|
+
```
|
|
126
73
|
|
|
127
|
-
|
|
74
|
+
Look for a `dsh-kanban` layer. Its presence confirms the configuration, not that the running service has loaded it; restart the Web service after installation.
|
|
128
75
|
|
|
129
|
-
|
|
76
|
+
</details>
|
|
130
77
|
|
|
131
|
-
|
|
78
|
+
## Explore further
|
|
132
79
|
|
|
133
|
-
|
|
80
|
+
- [User guide](docs/guide.md) — Editing, search, images, and collaboration.
|
|
81
|
+
- [Agent tool reference](docs/guide.md#agent-tool-reference) — All 19 tools, arguments, and completion rules.
|
|
82
|
+
- [Data and backups](docs/guide.md#data-and-backups) — Keep both the board file and the DSH attachment store to preserve images.
|
|
83
|
+
- [Development and validation](docs/testing-images.md) — Node.js 26, pnpm 11.8.0, builds, and tests.
|
|
84
|
+
- [Issues and ideas](https://github.com/alpacachen/dsh-kanban/issues) — Report a problem or share feedback.
|
|
134
85
|
|
|
135
|
-
|
|
86
|
+
---
|
|
136
87
|
|
|
137
|
-
MIT
|
|
88
|
+
[MIT](LICENSE) · Built for DeepSeek Harness
|
package/README.zh.md
CHANGED
|
@@ -1,137 +1,88 @@
|
|
|
1
|
-
<
|
|
1
|
+
<p align="center">
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(max-width: 600px)" srcset="docs/readme/cover-zh-mobile.png">
|
|
4
|
+
<img src="docs/readme/cover-zh.png" alt="dsh-kanban — 一起规划,让进展可见。你与 Agent 共用的 DeepSeek Harness 看板。" width="100%">
|
|
5
|
+
</picture>
|
|
6
|
+
</p>
|
|
2
7
|
|
|
3
|
-
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/@alpacachen/dsh-kanban"><img src="https://img.shields.io/npm/v/@alpacachen/dsh-kanban?style=flat-square&color=3867e8&label=npm" alt="npm 版本"></a>
|
|
10
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-3867e8?style=flat-square" alt="MIT 许可"></a>
|
|
11
|
+
<a href="https://awesome-dsh-plugin.com"><img src="https://awesome-dsh-plugin.com/badge.svg" alt="Awesome DSH Plugin"></a>
|
|
12
|
+
</p>
|
|
4
13
|
|
|
5
|
-
|
|
14
|
+
<p align="center">
|
|
15
|
+
<strong>简体中文</strong> · <a href="README.md">English</a><br>
|
|
16
|
+
<a href="#开始使用">开始使用</a> · <a href="docs/guide.zh.md">使用指南</a> · <a href="docs/guide.zh.md#agent-工具参考">Agent 工具</a>
|
|
17
|
+
</p>
|
|
6
18
|
|
|
7
|
-
|
|
19
|
+
<br>
|
|
8
20
|
|
|
9
|
-
|
|
10
|
-

|
|
11
|
-
[](https://awesome-dsh-plugin.com)
|
|
12
|
-

|
|
21
|
+
把对话里的计划变成可推进的任务。你和 Agent 在同一块看板上拆解工作、补充上下文、更新进度,始终留在 DeepSeek Harness 中。
|
|
13
22
|
|
|
14
|
-
|
|
23
|
+

|
|
15
24
|
|
|
16
|
-
|
|
25
|
+
<p align="center"><sub>当前插件界面 · 隔离示例数据 · 每个工作区独立保存</sub></p>
|
|
17
26
|
|
|
18
|
-
|
|
19
|
-
<tr>
|
|
20
|
-
<td width="50%"><img src="./image.png" alt="浅色模式下的完整 dsh-kanban 看板,展示英文任务、标签与优先级" width="100%"></td>
|
|
21
|
-
<td width="50%"><img src="./docs/screenshots/card-details-dark.png" alt="深色模式下的完整 dsh-kanban 看板,打开的任务详情抽屉展示 Markdown 描述" width="100%"></td>
|
|
22
|
-
</tr>
|
|
23
|
-
</table>
|
|
27
|
+
## 从一句话,到下一步行动
|
|
24
28
|
|
|
25
|
-
|
|
29
|
+
### 说清目标,Agent 来建卡
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
让 Agent 拆解需求,写下实现步骤与验收标准,安排标签和优先级。19 个内置工具,让规划直接落到看板上。
|
|
28
32
|
|
|
29
|
-
|
|
33
|
+
> 把手机号登录拆成可验收的任务,先检查已有卡片,避免重复。每张卡写清实现步骤和验收标准,把上线阻塞项标为 P0。
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
### 看清进展,随时接手
|
|
32
36
|
|
|
33
|
-
|
|
37
|
+
拖动卡片调整阶段,用搜索和筛选找到下一件事。任务描述支持 Markdown,评论和活动记录留下推进过程。
|
|
34
38
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
**用现有看板准备周会**
|
|
42
|
-
|
|
43
|
-
> 根据当前卡片的状态、描述和评论,整理周会提纲:已完成什么、哪些工作还在推进、有哪些阻塞需要协调。引用相关卡片,给出接下来最值得推进的三件事;信息不全的地方列成待确认项。
|
|
44
|
-
|
|
45
|
-
**为自己的职业建立工作流**
|
|
46
|
-
|
|
47
|
-
> 我是一名律师,要同时跟进合同审查和案件材料准备。帮我整理适合的阶段列表与标签,把我下面提供的事项逐一建卡,在描述里记录交付要求、材料清单和约定时间;缺少材料的放到「等待补充」。
|
|
39
|
+
| 关注什么 | 怎么找到 |
|
|
40
|
+
| --- | --- |
|
|
41
|
+
| 重要的事 | P0 / P1 / P2 优先级与自定义标签 |
|
|
42
|
+
| 快到期的事 | 截止日期、今天到期与逾期筛选 |
|
|
43
|
+
| 已有的结论 | 搜索卡片 ID、标题、完整描述和评论 |
|
|
48
44
|
|
|
49
|
-
|
|
45
|
+
### 带上上下文,继续对话
|
|
50
46
|
|
|
51
|
-
|
|
47
|
+
把截图粘贴或拖进任务,点击「与 Agent 聊一聊」,将任务文字和已保存的图片一起带到当前或新会话。内容先进入可编辑草稿,由你确认发送。
|
|
52
48
|
|
|
53
|
-
|
|
49
|
+
[查看图片与保存规则 →](docs/guide.zh.md#使用规则) · [更多对话示例 →](docs/guide.zh.md#对话示例)
|
|
54
50
|
|
|
55
|
-
|
|
56
|
-
| --- | --- | --- |
|
|
57
|
-
| 通过 16 个 `kanban_*` 工具直接管理任务。 | 在界面中编辑、评论、拖拽、标记和筛选卡片。 | 浏览器端已预构建,无需配置前端环境。 |
|
|
58
|
-
| **🗂️ 项目隔离** | **🌓 原生体验** | **🤝 实时协作** |
|
|
59
|
-
| 每个 DSH 工作区都有自己的独立看板。 | 自动跟随 DSH 的语言、主题与暗色模式。 | 你做的调整,Agent 立即可见;反之亦然。 |
|
|
51
|
+
## 开始使用
|
|
60
52
|
|
|
61
|
-
|
|
53
|
+
**桌面端** — 打开「插件」,添加并启用 `@alpacachen/dsh-kanban`。
|
|
62
54
|
|
|
63
|
-
|
|
55
|
+
**Web** — 运行以下命令,安装后重启 `dsh web` 以加载插件。
|
|
64
56
|
|
|
65
57
|
```sh
|
|
66
58
|
dsh plugin --profile web add @alpacachen/dsh-kanban
|
|
67
59
|
```
|
|
68
60
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
```sh
|
|
72
|
-
dsh --profile web --dump-config
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
如果输出中包含 `dsh-kanban` 配置层,就说明安装成功。
|
|
76
|
-
|
|
77
|
-
### 2. 打开看板
|
|
78
|
-
|
|
79
|
-
进入任意工作区,点击会话视图旁的 **「看板」** 标签页。新看板已经准备好四个常用阶段:
|
|
61
|
+
进入工作区,打开会话视图旁的 **「看板」**,即可从四个默认阶段开始:
|
|
80
62
|
|
|
81
|
-
|
|
63
|
+
**Todo → In Progress → Review → Done**
|
|
82
64
|
|
|
83
|
-
|
|
65
|
+
兼容声明:DSH **0.2.0-rc.2 / 0.2.1-rc.3**,支持 Web 与桌面端。1.10 依赖新版图片预览与对话附件接口,0.1.5 用户需先升级。
|
|
84
66
|
|
|
85
|
-
|
|
67
|
+
<details>
|
|
68
|
+
<summary>确认 Web 插件配置</summary>
|
|
86
69
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
## 🧩 推进工作需要的能力,都在这里
|
|
92
|
-
|
|
93
|
-
### 在「看板」标签页中
|
|
94
|
-
|
|
95
|
-
- 创建、编辑、删除卡片,并将卡片拖到其他列表
|
|
96
|
-
- 在侧边抽屉中查看任务详情,可拖动调整宽度并记忆,窄屏自动铺满
|
|
97
|
-
- 描述支持 Markdown:点击**「编辑」**修改原文,**「完成编辑」**切回预览,点击**「保存」**后生效
|
|
98
|
-
- 为卡片添加标签和 P0 / P1 / P2 优先级
|
|
99
|
-
- 设置可选的截止日期,快速查看今天到期和已逾期任务;在列编辑中指定完成列,让已完成任务停止显示到期提示
|
|
100
|
-
- 与 Agent 在卡片下持续评论,并在看板上快速查看评论数量
|
|
101
|
-
- 打开卡片活动时间线,查看变更时间、具体内容,以及操作来自你还是 Agent
|
|
102
|
-
- 追踪卡片创建、评论、移动、标题与备注编辑、标签变化、优先级变化和截止日期变化
|
|
103
|
-
- 从任意卡片发起对话,在当前会话或新会话中让 Agent 接着处理
|
|
104
|
-
- 创建、重命名、排序和删除工作流列表
|
|
105
|
-
- 创建彩色标签,让不同任务一眼可辨
|
|
106
|
-
- 在工具栏按优先级、标签和截止日期筛选整个看板,可组合筛选或只看无标签卡片
|
|
107
|
-
- 选择「全部」清除对应筛选,也可以随时手动刷新
|
|
108
|
-
- 点击工具栏底部的「反馈与建议 · GitHub」,提交问题或功能建议
|
|
109
|
-
|
|
110
|
-
### 从任意卡片继续与 Agent 协作
|
|
111
|
-
|
|
112
|
-
打开卡片并选择 **「与 Agent 聊一聊」**,dsh-kanban 会把卡片 ID、标题、标签、截止日期和备注带入当前会话或一个新会话,让 Agent 立即获得完整上下文。内容只会填入输入框作为可编辑草稿,由你确认后发送,不会自动提交。
|
|
113
|
-
|
|
114
|
-
### 在对话中
|
|
115
|
-
|
|
116
|
-
插件会自动为每个工作区中的 Agent 提供以下工具:
|
|
117
|
-
|
|
118
|
-
| 范围 | 工具 |
|
|
119
|
-
| --- | --- |
|
|
120
|
-
| **看板** | `kanban_get`、`kanban_set_completed_column` |
|
|
121
|
-
| **卡片** | `kanban_get_card`、`kanban_add_comment`、`kanban_add_card`、`kanban_update_card`、`kanban_delete_card`、`kanban_move_card` |
|
|
122
|
-
| **列表** | `kanban_add_column`、`kanban_rename_column`、`kanban_delete_column`、`kanban_move_column` |
|
|
123
|
-
| **标签** | `kanban_get_label`、`kanban_add_label`、`kanban_update_label`、`kanban_delete_label` |
|
|
124
|
-
|
|
125
|
-
`kanban_add_card` 和 `kanban_update_card` 的任务描述仍使用 `note` 字段,传入保留换行的 Markdown 原文,不传 HTML。任务详情会渲染标题、列表、表格和代码块。原文最多 2,000 字符,Markdown 标记和换行也计入长度,超出会截断并返回警告。修改已有描述前,应先调用 `kanban_get_card` 读取完整原文(`kanban_get` 只返回摘要)。传入 `note` 会替换整段描述;省略则保留原文,传空字符串则清空。评论仍为纯文本。
|
|
70
|
+
```sh
|
|
71
|
+
dsh --profile web --dump-config
|
|
72
|
+
```
|
|
126
73
|
|
|
127
|
-
|
|
74
|
+
输出中应包含 `dsh-kanban` 配置层。配置存在不代表当前服务已加载,安装后仍需重启 Web 服务。
|
|
128
75
|
|
|
129
|
-
|
|
76
|
+
</details>
|
|
130
77
|
|
|
131
|
-
|
|
78
|
+
## 继续了解
|
|
132
79
|
|
|
133
|
-
|
|
80
|
+
- [使用指南](docs/guide.zh.md) — 编辑、搜索、图片与协作。
|
|
81
|
+
- [Agent 工具参考](docs/guide.zh.md#agent-工具参考) — 全部 19 个工具、参数与完成状态规则。
|
|
82
|
+
- [数据与备份](docs/guide.zh.md#数据与备份) — 图片备份需同时保留看板文件和 DSH 附件存储。
|
|
83
|
+
- [开发与验证](docs/testing-images.md) — Node.js 26、pnpm 11.8.0,构建和测试说明。
|
|
84
|
+
- [问题与建议](https://github.com/alpacachen/dsh-kanban/issues) — 提交问题或分享使用反馈。
|
|
134
85
|
|
|
135
|
-
|
|
86
|
+
---
|
|
136
87
|
|
|
137
|
-
MIT
|
|
88
|
+
[MIT](LICENSE) · 为 DeepSeek Harness 构建
|
package/docs/guide.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# User guide
|
|
2
|
+
|
|
3
|
+
[Back to README](../README.md) · [简体中文](guide.zh.md)
|
|
4
|
+
|
|
5
|
+
## Using the board
|
|
6
|
+
|
|
7
|
+
| Action | How it works |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| Find tasks | Search card IDs, titles, descriptions, and comments; the three adjacent buttons filter by priority, label, and due date. |
|
|
10
|
+
| Manage the board | **Settings** at the top right contains refresh, column editing, label editing, and **Feedback · GitHub**. |
|
|
11
|
+
| Move work forward | Create, edit, delete, and drag cards; add color-coded labels and P0 / P1 / P2 priorities. |
|
|
12
|
+
| Read task details | A resizable side drawer remembers its width and fills narrow screens; descriptions support Markdown editing and preview. |
|
|
13
|
+
| Attach images | Choose files, paste from the clipboard, or drag images in; see counts on cards and preview, remove, or retry in task details. |
|
|
14
|
+
| Track dates | Set due dates, find tasks due today or overdue, and record completion dates automatically when cards enter the completion column. |
|
|
15
|
+
| Collaborate | Exchange comments, inspect the activity timeline, or continue a task in the current conversation or a new one. |
|
|
16
|
+
|
|
17
|
+
Click **Save** to apply text and Markdown edits; **Done editing** only switches back to preview. Active filters appear below the toolbar. Remove a filter with its × button or choose **All** in its menu.
|
|
18
|
+
|
|
19
|
+
### Continue any card with your agent
|
|
20
|
+
|
|
21
|
+
Open a card and choose **Chat with agent**. dsh-kanban carries its ID, title, label, due date, and notes into either the current conversation or a fresh one. Saved images are also added to the target composer as previewable, removable attachments. Text and images remain an editable draft until you choose to send it. An image-read failure keeps the task dialog open with an error for retry.
|
|
22
|
+
|
|
23
|
+
<details>
|
|
24
|
+
<summary>Earlier dark-mode and Markdown task details</summary>
|
|
25
|
+
|
|
26
|
+

|
|
27
|
+
|
|
28
|
+
Interface example captured in an earlier version.
|
|
29
|
+
|
|
30
|
+
</details>
|
|
31
|
+
|
|
32
|
+
## Prompt examples
|
|
33
|
+
|
|
34
|
+
Start with work you actually need to move forward. Replace the project names and context below with your own, then send the prompt to your agent.
|
|
35
|
+
|
|
36
|
+
**Turn a requirement into tasks with clear acceptance criteria**
|
|
37
|
+
|
|
38
|
+
> We need to ship phone-number sign-in next week. Check the existing cards, then create tasks for any missing API, verification code, abuse prevention, UI, and testing work. Record dependencies and use Markdown descriptions for implementation steps and acceptance criteria. Mark launch blockers as P0 and prioritize the remaining work.
|
|
39
|
+
|
|
40
|
+
**Pick up work already in progress**
|
|
41
|
+
|
|
42
|
+
> Continue “Redirected back to login after signing in.” Read the full description and comments, summarize what we know and the next step, and move it to In Progress. Record progress and test results in comments, then move it to Review for me to verify.
|
|
43
|
+
|
|
44
|
+
<details>
|
|
45
|
+
<summary>More examples: blockers, weekly meetings, and custom workflows</summary>
|
|
46
|
+
|
|
47
|
+
**Track work blocked on someone else**
|
|
48
|
+
|
|
49
|
+
> “Payment integration” is waiting for a test account from the provider. Create a Blocked list if needed and move the card there. Add a comment with the blocker, the contact we still need to confirm, and what to do once the account arrives.
|
|
50
|
+
|
|
51
|
+
**Prepare a weekly meeting from the board**
|
|
52
|
+
|
|
53
|
+
> Use the current card statuses, descriptions, and comments to prepare our meeting notes: completed work, work in progress, and blockers that need coordination. Reference the relevant cards and suggest the three most useful next actions. Flag missing information as questions to resolve.
|
|
54
|
+
|
|
55
|
+
**Build a workflow for your profession**
|
|
56
|
+
|
|
57
|
+
> I'm a lawyer handling contract reviews and case preparation. Set up suitable stages and labels, then create cards for the matters I provide below. Record deliverables, required documents, and agreed dates in each description. Put matters with missing documents in “Waiting for documents.”
|
|
58
|
+
|
|
59
|
+
</details>
|
|
60
|
+
|
|
61
|
+
## Usage details
|
|
62
|
+
|
|
63
|
+
<details>
|
|
64
|
+
<summary>Search scope, image limits, and saving behavior</summary>
|
|
65
|
+
|
|
66
|
+
### Search tasks
|
|
67
|
+
|
|
68
|
+
Search covers the current workspace's card ID, title, complete description, and comment text. It matches a literal substring, ignores case and surrounding whitespace, and combines with all active filters using AND. It preserves card order and resets when switching workspaces. The agent uses the same search through `kanban_get` with `{"query":"login"}`.
|
|
69
|
+
|
|
70
|
+
### Add and preview images
|
|
71
|
+
|
|
72
|
+
Images support PNG, JPEG, and WebP, up to 10 MiB each and 10 images per card; the DSH Host can impose stricter format or size limits. In a new card, selected images stay in the browser until **Save** creates the card. If an upload fails, the created card and successful images remain saved, and the drawer keeps failed files for retry without creating another card. Canceling before creation uploads nothing. For an existing card, image uploads and removals save immediately; text edits still require **Save**. Unsupported Hosts or workspaces that cannot persist data show an upload-unavailable message.
|
|
73
|
+
|
|
74
|
+
Click a thumbnail to open DSH's native full-size preview. Escape, the close button, or the backdrop returns to task details. Image contents are not included in text search; OCR is not supported.
|
|
75
|
+
|
|
76
|
+
</details>
|
|
77
|
+
|
|
78
|
+
## Data and backups
|
|
79
|
+
|
|
80
|
+
Each card has an `images` array containing only `attachmentId`, `mediaType`, `bytes`, `width`, and `height` per image. Names and captions are not saved. Schema v6 adds `images: []` to existing cards and backs up the old board file before migration. The workspace's `.dsh-kanban.json` holds image references; image files live in DSH's native attachment store under its DSH home, shared independently of a particular workspace or conversation. Back up both the board file and the DSH attachment store to preserve images. Removing an image or card removes the association, not the shared image object.
|
|
81
|
+
|
|
82
|
+
## Agent tool reference
|
|
83
|
+
|
|
84
|
+
The plugin gives the agent 19 tools in every workspace:
|
|
85
|
+
|
|
86
|
+
| Area | Tools |
|
|
87
|
+
| --- | --- |
|
|
88
|
+
| **Board** | `kanban_get`, `kanban_set_completed_column` |
|
|
89
|
+
| **Cards** | `kanban_get_card`, `kanban_add_comment`, `kanban_add_card`, `kanban_update_card`, `kanban_delete_card`, `kanban_move_card` |
|
|
90
|
+
| **Images** | `kanban_add_image`, `kanban_read_image`, `kanban_remove_image` |
|
|
91
|
+
| **Lists** | `kanban_add_column`, `kanban_rename_column`, `kanban_delete_column`, `kanban_move_column` |
|
|
92
|
+
| **Labels** | `kanban_get_label`, `kanban_add_label`, `kanban_update_label`, `kanban_delete_label` |
|
|
93
|
+
|
|
94
|
+
<details>
|
|
95
|
+
<summary>Image arguments and access scope</summary>
|
|
96
|
+
|
|
97
|
+
For images, create the card first and use the returned `cardId` as `id`. Call `kanban_add_image` with one of these argument objects:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{"id":"k1","source":{"kind":"workspace_file","path":"screenshots/login.png"}}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{"id":"k1","source":{"kind":"session_attachment","attachmentId":"sha256:<actual attachment hash>"}}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The file path must be relative to the current workspace and stay inside it. A session attachment must actually belong to the executing agent's current session; use its real ID, not a fabricated hash. Do not pass base64 or a remote URL. Repeating the same image does not create another association. `kanban_get` returns image counts; `kanban_get_card` returns the five-field references. Use `kanban_read_image` with `{"id":"k1","attachmentId":"sha256:<actual attachment hash>"}` to inspect pixels, or `kanban_remove_image` with the same arguments to detach it. Both verify that the image belongs to that card in the current workspace.
|
|
108
|
+
|
|
109
|
+
</details>
|
|
110
|
+
|
|
111
|
+
<details>
|
|
112
|
+
<summary>Markdown descriptions, due dates, and completion</summary>
|
|
113
|
+
|
|
114
|
+
For `kanban_add_card` and `kanban_update_card`, the task description uses the existing `note` field: send raw Markdown with line breaks, not HTML. Headings, lists, tables and fenced code blocks are rendered in task details. Keep the source within 2,000 characters, including Markdown syntax and newlines; longer input is truncated with a warning. Before editing a description, read `kanban_get_card` for its complete Markdown source (`kanban_get` only returns a summary). Updating `note` replaces the whole description; omit it to preserve the current text, or pass an empty string to clear it. Comments remain plain text.
|
|
115
|
+
|
|
116
|
+
For due dates, `kanban_add_card` and `kanban_update_card` accept `dueDate` as a real calendar date in `YYYY-MM-DD` format. Omit it to keep the current date (new cards default to none); use `null` or an empty string to clear it. Dates have no time or timezone: a task due today becomes overdue the next local calendar day. Resolve phrases such as “this Friday” against the user's local date and confirm the concrete date instead of sending relative text or a UTC timestamp. Both `kanban_get` and `kanban_get_card` return the date and the board's `completedColumnId`.
|
|
117
|
+
|
|
118
|
+
Completion dates are recorded automatically when a card enters the configured completion list (including creation there). Reopening clears the date; completing again records a new timestamp. Edits, comments, same-list sorting, and column renames/reordering preserve it. Card details show the local completion time next to the due date; it is read-only. Both read tools return `completedAt` as a UTC ISO timestamp, or `null`. A completed card with `null` has an unknown completion time. Changing or clearing the completion list resets completion dates; existing cards in the newly selected list have unknown dates. Deleting a list applies the same completion rules to its automatic card moves. When upgrading from a schema older than v5, historical completion times remain unknown rather than being inferred from the activity log.
|
|
119
|
+
|
|
120
|
+
Use `kanban_set_completed_column` with an existing `columnId` to designate the finished stage, or `null` to clear it. New boards use their default Done column; existing boards need an explicit choice. Completion follows the column ID through renames and reordering, and deleting that column clears the setting. Cards in the completion column keep their dates but are excluded from **Due today** and **Overdue** filters; moving them out resumes date checks. There are no automatic reminders or date-based reordering.
|
|
121
|
+
|
|
122
|
+
> Set the payment integration task's due date to this Friday, then show me unfinished tasks that are due today or overdue so I can decide what to tackle first.
|
|
123
|
+
|
|
124
|
+
</details>
|
|
125
|
+
|