roadmap-skill 0.2.9 → 0.2.11
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/CHANGELOG.md +67 -0
- package/README.md +28 -80
- package/README.zh.md +33 -80
- package/dist/index.js +129 -15
- package/dist/index.js.map +1 -1
- package/dist/web/server.js +86 -5
- package/dist/web/server.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,73 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.2.11] - 2026-03-09
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- **MCP Prompts**: Added non-intrusive task hints to `open-web-ui` and `quick-capture` prompts
|
|
12
|
+
- **Port Display**: Fixed NaN display when port parameter is not provided in `open-web-ui` prompt
|
|
13
|
+
- **Prompt Wording**: Removed command-like phrasing that could be misidentified as injection attempts
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## [0.2.10] - 2026-02-27
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
- **Contributing Section**: Added Contributing section to README (en/zh)
|
|
20
|
+
|
|
21
|
+
### Changed
|
|
22
|
+
- **README**: Revamped copy for both en/zh versions, improved clarity and tone
|
|
23
|
+
- **Tag ID Workflow**: Unified tag-id handling with deterministic color fallback
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## [0.2.9] - 2026-02-26
|
|
27
|
+
|
|
28
|
+
### Added
|
|
29
|
+
- **Development Scripts**: Added `dev:web`, `dev:server`, `dev:full`, and `inspector` npm scripts
|
|
30
|
+
- **Vite Proxy**: Frontend dev server now proxies API requests to backend automatically
|
|
31
|
+
- **Verbose Parameter**: Tools now support `verbose` parameter for compact vs full data responses
|
|
32
|
+
- **Summary Types**: Added `TaskSummary` and `ProjectSummary` types for lightweight responses
|
|
33
|
+
- **MCP Inspector**: Added `npm run inspector` command for debugging MCP server
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
- **UI Layout**: Moved filter bar to header alongside title for better space usage
|
|
37
|
+
- **Compact Mode**: Optimized spacing, removed tags, reduced margins and padding
|
|
38
|
+
- **Hover Animation**: Reduced card hover displacement from `-translate-y-1` to `-translate-y-0.5`
|
|
39
|
+
- **Create Button**: Changed task creation button color to project theme green
|
|
40
|
+
|
|
41
|
+
### Fixed
|
|
42
|
+
- **Completed Tasks**: Fixed "All" filter to properly include completed tasks via `includeCompleted` parameter
|
|
43
|
+
|
|
44
|
+
## [0.2.8] - 2026-02-26
|
|
45
|
+
|
|
46
|
+
### Fixed
|
|
47
|
+
- **MCP Transport**: Resolved stdio transport issues for better CLI compatibility
|
|
48
|
+
- **Tag System**: Improved tag management and display in task cards
|
|
49
|
+
|
|
50
|
+
### Changed
|
|
51
|
+
- Updated README with latest features and improvements
|
|
52
|
+
|
|
53
|
+
## [0.2.7] - 2026-02-26
|
|
54
|
+
|
|
55
|
+
### Fixed
|
|
56
|
+
- **Static Files Path**: Corrected bundled static files path for npx environment execution
|
|
57
|
+
|
|
58
|
+
### Added
|
|
59
|
+
- **Release Documentation**: Added release workflow documentation to AGENTS.md
|
|
60
|
+
|
|
61
|
+
## [0.2.6] - 2026-02-26
|
|
62
|
+
|
|
63
|
+
### Fixed
|
|
64
|
+
- **Static Files Path**: Resolved static files path resolution for npx execution environment
|
|
65
|
+
|
|
66
|
+
## [0.2.5] - 2026-02-26
|
|
67
|
+
|
|
68
|
+
### Added
|
|
69
|
+
- **NovaBoard UI**: Integrated tag system with NovaBoard-style dashboard design
|
|
70
|
+
- **Tag System**: Full tag management with color coding and filtering
|
|
71
|
+
|
|
72
|
+
### Fixed
|
|
73
|
+
- **Server Path**: Use `__dirname` instead of `process.cwd()` for reliable static files path resolution
|
|
74
|
+
|
|
8
75
|
## [0.2.0] - 2026-02-10
|
|
9
76
|
|
|
10
77
|
### Added
|
package/README.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>
|
|
9
|
-
|
|
8
|
+
<strong>Shared roadmap for humans and AI Agents</strong><br>
|
|
9
|
+
Visual kanban for you. MCP server for Agents. Local-first.
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
@@ -26,15 +26,15 @@
|
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## What Makes It Different
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
31
|
+
**Shared context** — Chat with your Agent to plan tasks, or edit directly in the Kanban — both stay in sync. Your Agent always sees the latest state.
|
|
32
|
+
|
|
33
|
+
**Agent-native** — Built as an MCP server. Your AI can create, update, and query tasks directly in conversation.
|
|
34
|
+
|
|
35
|
+
**Lightweight Kanban** — Open `localhost:7860` when you feel like it, or ask your Agent to open it with `open_web_interface`. Or just stay in chat. All three work.
|
|
36
|
+
|
|
37
|
+
**Local-first** — Your data lives on your machine. No accounts, no cloud sync, no vendor lock-in.
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -282,70 +282,33 @@ The AI will immediately create the project and tasks, saving them to local stora
|
|
|
282
282
|
|
|
283
283
|
## Who Is This For?
|
|
284
284
|
|
|
285
|
-
|
|
286
|
-
|---------|--------------------------------|
|
|
287
|
-
| **Solo Developers** | Manage personal projects through conversation, avoid getting lost in complex tools |
|
|
288
|
-
| **AI Power Users** | Let Agent directly read/write tasks, goodbye to copy-pasting hassle |
|
|
289
|
-
| **Vibe Coders** | Capture inspirations on the fly, automatically save to collection box |
|
|
290
|
-
| **Small Teams** | Simple task assignment and progress tracking, zero learning curve |
|
|
291
|
-
| **Privacy-conscious Users** | Data stored completely locally, never uploaded to any cloud service |
|
|
285
|
+
Solo developers, AI power users, and vibe coders who want their Agent to be a real collaborator — not just a code generator.
|
|
292
286
|
|
|
293
287
|
---
|
|
294
288
|
|
|
295
289
|
## Typical Use Cases
|
|
296
290
|
|
|
297
|
-
### 1. Capture
|
|
298
|
-
|
|
299
|
-
When discussing new features with AI, suddenly think of an optimization:
|
|
300
|
-
|
|
301
|
-
> "Add this to my collection: Refactor user auth module using JWT + Refresh Token scheme"
|
|
302
|
-
|
|
303
|
-
AI automatically creates the task, and you'll see it in the Kanban later.
|
|
304
|
-
|
|
305
|
-
### 2. Let AI Plan Project Structure
|
|
306
|
-
|
|
307
|
-
Starting a new project? Just ask AI to break it down:
|
|
308
|
-
|
|
309
|
-
> "Create an e-commerce admin dashboard project with product management, order processing, and user permissions modules, broken down into specific development tasks"
|
|
310
|
-
|
|
311
|
-
AI auto-creates the project structure. Just open the Kanban in browser and drag tasks to start working.
|
|
312
|
-
|
|
313
|
-
### 3. Progress Tracking and Status Updates
|
|
314
|
-
|
|
315
|
-
Check progress anytime during coding:
|
|
316
|
-
|
|
317
|
-
> "What's the completion percentage of my current project? What high-priority tasks haven't started yet?"
|
|
291
|
+
### 1. Capture Ideas Without Breaking Flow
|
|
318
292
|
|
|
319
|
-
|
|
293
|
+
Mid-session, something pops into your head:
|
|
320
294
|
|
|
321
|
-
|
|
295
|
+
> "Note this down: switch the auth module to JWT + refresh token rotation"
|
|
322
296
|
|
|
323
|
-
|
|
297
|
+
Use `/quick-capture` or just say "help me note this down" — your Agent turns it into a task, saves it locally, and you keep going. No context switch, no forgotten ideas.
|
|
324
298
|
|
|
325
|
-
|
|
299
|
+
### 2. Let Agent Help You Prioritize
|
|
326
300
|
|
|
327
|
-
|
|
301
|
+
> "This month's OKR is finishing the user system refactor — can you list the related tasks and figure out which ones should come first?"
|
|
328
302
|
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
## Installation
|
|
303
|
+
Use `/auto-prioritize` to let your Agent analyze the current project state and reorder task priorities accordingly.
|
|
332
304
|
|
|
333
|
-
###
|
|
305
|
+
### 3. Let Agent Recommend What to Do Next
|
|
334
306
|
|
|
335
|
-
-
|
|
307
|
+
> "What's left on the current project? Any high-priority tasks I haven't touched yet?"
|
|
336
308
|
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
```bash
|
|
340
|
-
npm install -g roadmap-skill
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
### Use Without Installing
|
|
344
|
-
|
|
345
|
-
```bash
|
|
346
|
-
npx roadmap-skill # Full MCP server
|
|
347
|
-
```
|
|
309
|
+
Or use `/suggest-tasks` — your Agent recommends the next actions based on current progress and priorities.
|
|
348
310
|
|
|
311
|
+
No tab switching. No copy-pasting. Just ask.
|
|
349
312
|
---
|
|
350
313
|
|
|
351
314
|
## Core Features
|
|
@@ -362,10 +325,8 @@ npx roadmap-skill # Full MCP server
|
|
|
362
325
|
|
|
363
326
|
## Supported Platforms
|
|
364
327
|
|
|
365
|
-
- ✅ **Claude Code** — Command-line AI
|
|
366
|
-
- ✅ **
|
|
367
|
-
- ✅ **Cursor** — AI-powered IDE
|
|
368
|
-
- ✅ **VS Code** — Via Cline or Roo Code extensions
|
|
328
|
+
- ✅ **Claude Code, Codex, OpenCode** — Command-line AI assistants
|
|
329
|
+
- ✅ **Cursor, VS Code** — AI-powered IDEs
|
|
369
330
|
- ✅ **Any MCP Client** — Standard MCP protocol support
|
|
370
331
|
|
|
371
332
|
---
|
|
@@ -376,24 +337,11 @@ Roadmap Skill uses **pure local JSON file storage**. All data is saved in your u
|
|
|
376
337
|
|
|
377
338
|
| Platform | Storage Path |
|
|
378
339
|
|---------|-------------|
|
|
379
|
-
|
|
|
380
|
-
|
|
|
381
|
-
|
|
|
382
|
-
|
|
383
|
-
### Data File Structure
|
|
384
|
-
|
|
385
|
-
```
|
|
386
|
-
.roadmap-skill/
|
|
387
|
-
└── data/
|
|
388
|
-
├── projects.json # Project list
|
|
389
|
-
├── tasks.json # All tasks
|
|
390
|
-
└── tags.json # Tag definitions
|
|
391
|
-
```
|
|
340
|
+
| Windows | `%USERPROFILE%\.roadmap-skill` |
|
|
341
|
+
| macOS | `~/.roadmap-skill/` |
|
|
342
|
+
| Linux | `~/.roadmap-skill/` |
|
|
392
343
|
|
|
393
|
-
|
|
394
|
-
- ✅ **Portable** — Copy folder to backup/transfer
|
|
395
|
-
- ✅ **Version control friendly** — JSON format for easy diff
|
|
396
|
-
- ✅ **Privacy secure** — Data never leaves your machine
|
|
344
|
+
You can export or import backup files from the web interface.
|
|
397
345
|
|
|
398
346
|
---
|
|
399
347
|
|
package/README.zh.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong
|
|
9
|
-
|
|
8
|
+
<strong>人类与 AI Agent 共享的项目看板</strong><br>
|
|
9
|
+
你看到的,Agent 也看到。对话里规划,看板里审阅。或者相反。
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
@@ -26,15 +26,15 @@
|
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## 这个 MCP 有什么不同?
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
31
|
+
**人机共享视图** — 在对话里和 Agent 一起规划任务,也可以直接在看板上手动编辑,两种方式实时互通。你和Agent 始终能获取到最新状态。
|
|
32
|
+
|
|
33
|
+
**Agent 原生** — 以 MCP 服务器形式运行。AI 可以在对话中直接创建、更新、查询任务。
|
|
34
|
+
|
|
35
|
+
**轻量看板** — 你想看的时候打开 `localhost:7860`。懒得开浏览器?直接让 Agent `/open-web-ui` 也行。
|
|
36
|
+
|
|
37
|
+
**本地优先** — 数据存在你的机器上。无需账号,无云同步,不依赖任何第三方服务。
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -279,69 +279,31 @@ AI 会立即为你创建项目和任务,并自动写入本地存储。你可
|
|
|
279
279
|
|
|
280
280
|
## 适合谁使用
|
|
281
281
|
|
|
282
|
-
|
|
283
|
-
|------|---------------------------|
|
|
284
|
-
| **独立开发者** | 用对话管理个人项目,避免在复杂工具中迷失 |
|
|
285
|
-
| **AI 重度用户** | 让 Agent 直接读写任务,告别来回粘贴的繁琐 |
|
|
286
|
-
| **Vibe Coder** | 随手让 AI 记录灵感,自动沉淀到收集箱 |
|
|
287
|
-
| **小团队协作** | 简单的任务分配与进度追踪,无需学习成本 |
|
|
288
|
-
| **隐私敏感者** | 数据完全本地存储,不上传任何云端服务 |
|
|
289
|
-
|
|
290
|
-
---
|
|
282
|
+
独立开发者、AI 重度用户、Vibe Coder — 想让 Agent 真正参与项目协作,而不只是写代码的人。
|
|
291
283
|
|
|
292
284
|
## 典型使用场景
|
|
293
285
|
|
|
294
|
-
### 1.
|
|
295
|
-
|
|
296
|
-
正在和 AI 讨论新功能时,突然想到一个优化点:
|
|
297
|
-
|
|
298
|
-
> "帮我把这个想法记到收集箱:重构用户认证模块,使用 JWT + Refresh Token 方案"
|
|
299
|
-
|
|
300
|
-
AI 自动创建任务,稍后你打开看板就能看到待整理的想法。
|
|
301
|
-
|
|
302
|
-
### 2. 让 AI 规划项目结构
|
|
303
|
-
|
|
304
|
-
开始一个新项目时,直接让 AI 帮你分解:
|
|
305
|
-
|
|
306
|
-
> "创建一个电商后台管理项目,包含商品管理、订单处理、用户权限三个模块,每个模块分解为具体的开发任务"
|
|
307
|
-
|
|
308
|
-
AI 自动创建项目结构,你只需要在浏览器中打开看板,拖拽任务开始工作。
|
|
309
|
-
|
|
310
|
-
### 3. 进度追踪与状态更新
|
|
286
|
+
### 1. 不打断流地记录想法
|
|
311
287
|
|
|
312
|
-
|
|
288
|
+
VibeCoding时,突然想到一个新idea/有新Bug:
|
|
313
289
|
|
|
314
|
-
> "
|
|
290
|
+
> "记一下:把认证模块改成 JWT + refresh token 方案"
|
|
315
291
|
|
|
316
|
-
|
|
292
|
+
直接使用 `/quick-capture` 命令,或者直接说“帮我记一下”,Agent 就会把这个想法变成一个项目的代办,保存在本地,然后继续工作。等有空了再回来看,任务已经在那里了,不用担心忘记,也不用打断当前的思路去切换工具。
|
|
317
293
|
|
|
318
|
-
###
|
|
294
|
+
### 2. 让 Agent 帮你划分任务优先级
|
|
319
295
|
|
|
320
|
-
|
|
296
|
+
> "这个月的 OKR 是完成用户系统重构,能不能帮我把相关的任务都列出来,并且分析一下哪些任务应该有限做?"
|
|
321
297
|
|
|
322
|
-
|
|
298
|
+
直接使用 `/auto-prioritize` 命令,让 Agent 根据当前的项目状态,给已有的任务合理调整优先级。
|
|
323
299
|
|
|
324
|
-
|
|
300
|
+
### 3. 让 Agent 自动给你推荐接下来做什么
|
|
325
301
|
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
## 安装
|
|
329
|
-
|
|
330
|
-
### 环境要求
|
|
331
|
-
|
|
332
|
-
- Node.js 18+ (推荐 20+)
|
|
302
|
+
> "当前项目还剩什么?有没有高优先级的任务还没动?"
|
|
333
303
|
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
```bash
|
|
337
|
-
npm install -g roadmap-skill
|
|
338
|
-
```
|
|
304
|
+
或者直接使用 `/suggest-tasks` 命令,让 Agent 根据当前进度和优先级给你推荐下一步行动。
|
|
339
305
|
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
```bash
|
|
343
|
-
npx roadmap-skill # 完整 MCP 服务器
|
|
344
|
-
```
|
|
306
|
+
不用切换标签页,不用复制粘贴。直接问就行。
|
|
345
307
|
|
|
346
308
|
---
|
|
347
309
|
|
|
@@ -359,11 +321,9 @@ npx roadmap-skill # 完整 MCP 服务器
|
|
|
359
321
|
|
|
360
322
|
## 支持平台
|
|
361
323
|
|
|
362
|
-
- ✅ **Claude Code** — 命令行 AI 助手
|
|
363
|
-
- ✅ **
|
|
364
|
-
- ✅
|
|
365
|
-
- ✅ **VS Code** — 通过 Cline 或 Roo Code 扩展
|
|
366
|
-
- ✅ **任意 MCP 客户端** — 标准 MCP 协议支持
|
|
324
|
+
- ✅ **Claude Code, Codex, OpenCode** — 命令行 AI 助手
|
|
325
|
+
- ✅ **Cursor, VS Code** — AI 驱动的 IDE
|
|
326
|
+
- ✅ **任意支持 MCP 的客户端** — 标准 MCP 协议支持
|
|
367
327
|
|
|
368
328
|
---
|
|
369
329
|
|
|
@@ -373,24 +333,17 @@ Roadmap Skill 采用**纯本地 JSON 文件存储**,所有数据保存在你
|
|
|
373
333
|
|
|
374
334
|
| 平台 | 存储路径 |
|
|
375
335
|
|------|---------|
|
|
376
|
-
|
|
|
377
|
-
|
|
|
378
|
-
|
|
|
336
|
+
| Windows | `%USERPROFILE%\.roadmap-skill` |
|
|
337
|
+
| macOS | `~/.roadmap-skill/` |
|
|
338
|
+
| Linux | `~/.roadmap-skill/` |
|
|
379
339
|
|
|
380
|
-
|
|
340
|
+
你可以在前端界面中选择导出/导入备份文件。
|
|
381
341
|
|
|
382
|
-
|
|
383
|
-
.roadmap-skill/
|
|
384
|
-
└── data/
|
|
385
|
-
├── projects.json # 项目列表
|
|
386
|
-
├── tasks.json # 所有任务
|
|
387
|
-
└── tags.json # 标签定义
|
|
388
|
-
```
|
|
342
|
+
---
|
|
389
343
|
|
|
390
|
-
|
|
391
|
-
-
|
|
392
|
-
|
|
393
|
-
- ✅ **隐私安全** — 数据永远不会离开你的电脑
|
|
344
|
+
## 参与贡献
|
|
345
|
+
欢迎任何形式的贡献!无论是 Bug 反馈、功能建议还是 Pull Request,都可以直接在 [GitHub](https://github.com/shiquda/roadmap-skill) 上提 Issue 或 PR。
|
|
346
|
+
如果你想添加新功能,建议先开 Issue 讨论一下方向。
|
|
394
347
|
|
|
395
348
|
---
|
|
396
349
|
|