@alpacachen/dsh-kanban 1.7.0 → 1.9.0
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 +42 -20
- package/README.zh.md +41 -19
- package/index.js +119 -61
- package/lib/client.js +244 -46
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -15,10 +15,36 @@ A collaborative kanban board where you and your AI agent plan, organize, and shi
|
|
|
15
15
|
|
|
16
16
|
</div>
|
|
17
17
|
|
|
18
|
-
<
|
|
19
|
-
<
|
|
20
|
-
|
|
21
|
-
|
|
18
|
+
<table>
|
|
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>
|
|
24
|
+
|
|
25
|
+
## 💡 Things to ask your agent
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
**Turn a requirement into tasks with clear acceptance criteria**
|
|
30
|
+
|
|
31
|
+
> 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.
|
|
32
|
+
|
|
33
|
+
**Pick up work already in progress**
|
|
34
|
+
|
|
35
|
+
> 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.
|
|
36
|
+
|
|
37
|
+
**Track work blocked on someone else**
|
|
38
|
+
|
|
39
|
+
> “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.
|
|
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.”
|
|
22
48
|
|
|
23
49
|
## ✨ From conversation to action
|
|
24
50
|
|
|
@@ -28,7 +54,7 @@ You can take over at any time—drag a card, refine a note, reorder a list—and
|
|
|
28
54
|
|
|
29
55
|
| 💬 Plan naturally | 🧭 Stay in control | ⚡ Start instantly |
|
|
30
56
|
| --- | --- | --- |
|
|
31
|
-
| Manage the board with
|
|
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. |
|
|
32
58
|
| **🗂️ Keep work separate** | **🌓 Feel at home** | **🤝 Share one source of truth** |
|
|
33
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. |
|
|
34
60
|
|
|
@@ -70,18 +96,20 @@ The cards appear directly on your board. Continue in conversation, or switch to
|
|
|
70
96
|
- Read task details in a resizable side drawer that remembers its width and fills narrow screens
|
|
71
97
|
- Write descriptions as Markdown source with **Edit**; **Done editing** previews the result and **Save** applies changes
|
|
72
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
|
|
73
100
|
- Exchange persistent card comments with the agent and see comment counts at a glance
|
|
74
101
|
- Open a card's activity timeline to see when it changed, what changed, and whether you or the agent made the change
|
|
75
|
-
- Track card creation, comments, moves, title and note edits, label changes, and
|
|
102
|
+
- Track card creation, comments, moves, title and note edits, label changes, priority changes, and due date changes
|
|
76
103
|
- Send any card to the agent in your current conversation or a new one
|
|
77
104
|
- Create, rename, reorder, and remove workflow lists
|
|
78
105
|
- Create color-coded labels for fast visual scanning
|
|
79
|
-
- Filter the entire board by priority and
|
|
80
|
-
- Clear
|
|
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
|
|
81
109
|
|
|
82
110
|
### Continue any card with your agent
|
|
83
111
|
|
|
84
|
-
Open a card and choose **Chat with agent**. dsh-kanban carries its ID, title, label, 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.
|
|
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.
|
|
85
113
|
|
|
86
114
|
### In conversation
|
|
87
115
|
|
|
@@ -89,26 +117,20 @@ The plugin automatically gives the agent these tools in every workspace:
|
|
|
89
117
|
|
|
90
118
|
| Area | Tools |
|
|
91
119
|
| --- | --- |
|
|
92
|
-
| **Board** | `kanban_get` |
|
|
120
|
+
| **Board** | `kanban_get`, `kanban_set_completed_column` |
|
|
93
121
|
| **Cards** | `kanban_get_card`, `kanban_add_comment`, `kanban_add_card`, `kanban_update_card`, `kanban_delete_card`, `kanban_move_card` |
|
|
94
122
|
| **Lists** | `kanban_add_column`, `kanban_rename_column`, `kanban_delete_column`, `kanban_move_column` |
|
|
95
123
|
| **Labels** | `kanban_get_label`, `kanban_add_label`, `kanban_update_label`, `kanban_delete_label` |
|
|
96
124
|
|
|
97
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.
|
|
98
126
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
> “Summarize what is currently in progress.”
|
|
102
|
-
|
|
103
|
-
> “Move ‘Fix login redirect’ to In Progress and set it to P0.”
|
|
104
|
-
|
|
105
|
-
> “Add a Blocked list after In Progress.”
|
|
127
|
+
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`.
|
|
106
128
|
|
|
107
|
-
|
|
129
|
+
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. Schema v5 migration backs up the original file and leaves historical completion times unknown rather than guessing from truncated, title-based activity history.
|
|
108
130
|
|
|
109
|
-
|
|
131
|
+
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.
|
|
110
132
|
|
|
111
|
-
|
|
133
|
+
> 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.
|
|
112
134
|
|
|
113
135
|
## License
|
|
114
136
|
|
package/README.zh.md
CHANGED
|
@@ -15,10 +15,36 @@
|
|
|
15
15
|
|
|
16
16
|
</div>
|
|
17
17
|
|
|
18
|
-
<
|
|
19
|
-
<
|
|
20
|
-
|
|
21
|
-
|
|
18
|
+
<table>
|
|
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>
|
|
24
|
+
|
|
25
|
+
## 💡 你可以直接这样说
|
|
26
|
+
|
|
27
|
+
从你正在做的事开始。把下面例子里的项目名称和背景换成自己的,就可以直接发给 Agent。
|
|
28
|
+
|
|
29
|
+
**把需求拆成可验收的任务**
|
|
30
|
+
|
|
31
|
+
> 下周要上线手机号登录。先看看已有卡片,再为缺少的接口、验证码、防刷、前端交互和测试工作建卡。写清依赖关系,并在描述里用 Markdown 列出实现步骤和验收标准。影响上线的任务标为 P0,其余排好优先级。
|
|
32
|
+
|
|
33
|
+
**接手一项正在做的工作**
|
|
34
|
+
|
|
35
|
+
> 接着处理「登录后跳回登录页」。先读完整描述和评论,梳理已有结论与下一步,移到 In Progress。推进过程和测试结果记到评论,完成后移到 Review 等我验收。
|
|
36
|
+
|
|
37
|
+
**跟进被外部依赖卡住的事项**
|
|
38
|
+
|
|
39
|
+
> 「支付联调」还在等对方提供测试账号。建一个 Blocked 列表(已有就复用),把任务移过去,并在评论里记录阻塞原因、待确认的联系人,以及拿到账号后的下一步。
|
|
40
|
+
|
|
41
|
+
**用现有看板准备周会**
|
|
42
|
+
|
|
43
|
+
> 根据当前卡片的状态、描述和评论,整理周会提纲:已完成什么、哪些工作还在推进、有哪些阻塞需要协调。引用相关卡片,给出接下来最值得推进的三件事;信息不全的地方列成待确认项。
|
|
44
|
+
|
|
45
|
+
**为自己的职业建立工作流**
|
|
46
|
+
|
|
47
|
+
> 我是一名律师,要同时跟进合同审查和案件材料准备。帮我整理适合的阶段列表与标签,把我下面提供的事项逐一建卡,在描述里记录交付要求、材料清单和约定时间;缺少材料的放到「等待补充」。
|
|
22
48
|
|
|
23
49
|
## ✨ 从一句话,到一块能执行的看板
|
|
24
50
|
|
|
@@ -28,7 +54,7 @@
|
|
|
28
54
|
|
|
29
55
|
| 💬 自然对话 | 🧭 随时掌控 | ⚡ 开箱即用 |
|
|
30
56
|
| --- | --- | --- |
|
|
31
|
-
| 通过
|
|
57
|
+
| 通过 16 个 `kanban_*` 工具直接管理任务。 | 在界面中编辑、评论、拖拽、标记和筛选卡片。 | 浏览器端已预构建,无需配置前端环境。 |
|
|
32
58
|
| **🗂️ 项目隔离** | **🌓 原生体验** | **🤝 实时协作** |
|
|
33
59
|
| 每个 DSH 工作区都有自己的独立看板。 | 自动跟随 DSH 的语言、主题与暗色模式。 | 你做的调整,Agent 立即可见;反之亦然。 |
|
|
34
60
|
|
|
@@ -70,18 +96,20 @@ dsh --profile web --dump-config
|
|
|
70
96
|
- 在侧边抽屉中查看任务详情,可拖动调整宽度并记忆,窄屏自动铺满
|
|
71
97
|
- 描述支持 Markdown:点击**「编辑」**修改原文,**「完成编辑」**切回预览,点击**「保存」**后生效
|
|
72
98
|
- 为卡片添加标签和 P0 / P1 / P2 优先级
|
|
99
|
+
- 设置可选的截止日期,快速查看今天到期和已逾期任务;在列编辑中指定完成列,让已完成任务停止显示到期提示
|
|
73
100
|
- 与 Agent 在卡片下持续评论,并在看板上快速查看评论数量
|
|
74
101
|
- 打开卡片活动时间线,查看变更时间、具体内容,以及操作来自你还是 Agent
|
|
75
|
-
-
|
|
102
|
+
- 追踪卡片创建、评论、移动、标题与备注编辑、标签变化、优先级变化和截止日期变化
|
|
76
103
|
- 从任意卡片发起对话,在当前会话或新会话中让 Agent 接着处理
|
|
77
104
|
- 创建、重命名、排序和删除工作流列表
|
|
78
105
|
- 创建彩色标签,让不同任务一眼可辨
|
|
79
|
-
-
|
|
106
|
+
- 在工具栏按优先级、标签和截止日期筛选整个看板,可组合筛选或只看无标签卡片
|
|
80
107
|
- 选择「全部」清除对应筛选,也可以随时手动刷新
|
|
108
|
+
- 点击工具栏底部的「反馈与建议 · GitHub」,提交问题或功能建议
|
|
81
109
|
|
|
82
110
|
### 从任意卡片继续与 Agent 协作
|
|
83
111
|
|
|
84
|
-
打开卡片并选择 **「与 Agent 聊一聊」**,dsh-kanban 会把卡片 ID
|
|
112
|
+
打开卡片并选择 **「与 Agent 聊一聊」**,dsh-kanban 会把卡片 ID、标题、标签、截止日期和备注带入当前会话或一个新会话,让 Agent 立即获得完整上下文。内容只会填入输入框作为可编辑草稿,由你确认后发送,不会自动提交。
|
|
85
113
|
|
|
86
114
|
### 在对话中
|
|
87
115
|
|
|
@@ -89,26 +117,20 @@ dsh --profile web --dump-config
|
|
|
89
117
|
|
|
90
118
|
| 范围 | 工具 |
|
|
91
119
|
| --- | --- |
|
|
92
|
-
| **看板** | `kanban_get` |
|
|
120
|
+
| **看板** | `kanban_get`、`kanban_set_completed_column` |
|
|
93
121
|
| **卡片** | `kanban_get_card`、`kanban_add_comment`、`kanban_add_card`、`kanban_update_card`、`kanban_delete_card`、`kanban_move_card` |
|
|
94
122
|
| **列表** | `kanban_add_column`、`kanban_rename_column`、`kanban_delete_column`、`kanban_move_column` |
|
|
95
123
|
| **标签** | `kanban_get_label`、`kanban_add_label`、`kanban_update_label`、`kanban_delete_label` |
|
|
96
124
|
|
|
97
125
|
`kanban_add_card` 和 `kanban_update_card` 的任务描述仍使用 `note` 字段,传入保留换行的 Markdown 原文,不传 HTML。任务详情会渲染标题、列表、表格和代码块。原文最多 2,000 字符,Markdown 标记和换行也计入长度,超出会截断并返回警告。修改已有描述前,应先调用 `kanban_get_card` 读取完整原文(`kanban_get` 只返回摘要)。传入 `note` 会替换整段描述;省略则保留原文,传空字符串则清空。评论仍为纯文本。
|
|
98
126
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
> 「总结一下目前正在进行的任务。」
|
|
102
|
-
|
|
103
|
-
> 「把『修复登录跳转』移到进行中,并设为 P0。」
|
|
104
|
-
|
|
105
|
-
> 「在进行中后面新增一个阻塞列表。」
|
|
127
|
+
完成日期在卡片进入完成列时自动记录(包括直接在完成列创建),移出时清空,再次完成时记录新时间。修改内容、评论、同列排序和列改名/排序不影响完成日期。卡片详情在截止日期旁以本地时区只读展示;两个读取工具均返回 UTC ISO 时间戳 `completedAt` 或 `null`,已完成卡片的 `null` 表示时间未知。更换或清除完成列会重置完成时间,新完成列中已有卡片显示未知;删除列引发自动移动时也遵循进入/离开完成状态的规则。升级至数据格式 v5 时会备份原文件,历史完成时间保留未知,不依据可能被截断、按列名记录的活动日志推测。
|
|
106
128
|
|
|
107
|
-
|
|
129
|
+
`kanban_add_card` 和 `kanban_update_card` 可通过 `dueDate` 设置截止日期,值为真实有效的 `YYYY-MM-DD` 日期。省略则保留原日期(新卡片默认为无日期),传 `null` 或空字符串则清空。日期不含时间和时区:今天到期的任务到本地次日才算逾期。「本周五」等相对日期应由 Agent 按用户本地日期换算,并向用户确认具体日期,不要直接传相对文本或 UTC 时间戳。`kanban_get` 和 `kanban_get_card` 都会返回截止日期与看板的 `completedColumnId`。
|
|
108
130
|
|
|
109
|
-
|
|
131
|
+
使用 `kanban_set_completed_column`,传已有的 `columnId` 指定完成列,传 `null` 清除设置。新看板默认使用 Done,已有看板需要明确选择一次。设置跟随列 ID,改名和排序不影响;删除完成列会清除设置。完成列中的卡片保留日期,但不计入「今天到期」和「已逾期」筛选,移回其他列后恢复判断。暂不包含自动提醒和按日期自动排序。
|
|
110
132
|
|
|
111
|
-
|
|
133
|
+
> 把「支付联调」的截止日期设为本周五,再列出今天到期和已经逾期的未完成任务,方便我安排先做哪几件事。
|
|
112
134
|
|
|
113
135
|
## 开源许可
|
|
114
136
|
|