vibe-kanban

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Vibe Kanban — Task Board Skill

Vibe Kanban(VK)——任务看板技能

Vibe Kanban (VK) is the shared task board for all agents and the single source of truth for current work.
Vibe Kanban(VK)是所有Agent共用的任务看板,也是当前工作的唯一可信数据源。

When to Use

使用场景

Use this skill when you need to:
  • Check what you should work on next
  • Claim, create, update, or complete tasks
  • Run a heartbeat task check
  • Scan for
    @your-agent-id
    mentions in task descriptions
  • Generate a daily standup summary
当你需要以下操作时,可以使用本技能:
  • 查看接下来应处理的工作
  • 认领、创建、更新或完成任务
  • 执行心跳任务检查
  • 扫描任务描述中@your-agent-id的提及内容
  • 生成每日站会总结

Access

访问方式

CLI (primary)

CLI(主要方式)

The
vk
binary is a standalone CLI generated from the VK MCP server schema. It lives at
vibe-kanban/scripts/vk
and requires
bun
at runtime.
bash
vk <command> [--flag value ...]
vk --help                         # list all commands
vk <command> --help               # help for a specific command
vk
二进制文件是从VK MCP服务器架构生成的独立CLI工具,位于
vibe-kanban/scripts/vk
路径下,运行时需要依赖
bun
bash
vk <command> [--flag value ...]
vk --help                         # 列出所有命令
vk <command> --help               # 查看特定命令的帮助

MCP tools (alternative)

MCP工具(替代方式)

If the
vibe_kanban
MCP server is configured in your Claude Code session, you can call tools directly (e.g.
list_projects
,
list_tasks
) without the CLI.
如果你的Claude Code会话中已配置
vibe_kanban
MCP服务器,你可以直接调用工具(如
list_projects
list_tasks
),无需使用CLI。

Tool Reference

工具参考

Task management

任务管理

bash
vk list-projects
vk list-tasks --project-id <ID>
vk list-tasks --project-id <ID> --status todo
vk list-tasks --project-id <ID> --status inprogress --limit 10
vk create-task --project-id <ID> --title "[agent-id] Task description"
vk create-task --project-id <ID> --title "Title" --description "Details"
vk get-task --task-id <ID>
vk update-task --task-id <ID> --status inprogress
vk update-task --task-id <ID> --status done
vk delete-task --task-id <ID>
bash
vk list-projects
vk list-tasks --project-id <ID>
vk list-tasks --project-id <ID> --status todo
vk list-tasks --project-id <ID> --status inprogress --limit 10
vk create-task --project-id <ID> --title "[agent-id] Task description"
vk create-task --project-id <ID> --title "Title" --description "Details"
vk get-task --task-id <ID>
vk update-task --task-id <ID> --status inprogress
vk update-task --task-id <ID> --status done
vk delete-task --task-id <ID>

Repository management

仓库管理

bash
vk list-repos --project-id <ID>
vk get-repo --repo-id <ID>
vk update-setup-script --repo-id <ID> --script '#!/bin/bash\n...'
vk update-cleanup-script --repo-id <ID> --script '...'
vk update-dev-server-script --repo-id <ID> --script '...'
bash
vk list-repos --project-id <ID>
vk get-repo --repo-id <ID>
vk update-setup-script --repo-id <ID> --script '#!/bin/bash\n...'
vk update-cleanup-script --repo-id <ID> --script '...'
vk update-dev-server-script --repo-id <ID> --script '...'

Workspace sessions

工作区会话

bash
vk start-workspace-session --task-id <ID> --executor CLAUDE_CODE --repos <repo-id1>,<repo-id2>
Supported executors:
CLAUDE_CODE
,
AMP
,
GEMINI
,
CODEX
,
OPENCODE
,
CURSOR_AGENT
,
QWEN_CODE
,
COPILOT
,
DROID
.
bash
vk start-workspace-session --task-id <ID> --executor CLAUDE_CODE --repos <repo-id1>,<repo-id2>
支持的执行器:
CLAUDE_CODE
AMP
GEMINI
CODEX
OPENCODE
CURSOR_AGENT
QWEN_CODE
COPILOT
DROID

Task Statuses

任务状态

StatusMeaning
todo
Not started
inprogress
Actively being worked on
inreview
Work done, awaiting review
done
Completed
cancelled
No longer needed
状态含义
todo
未开始
inprogress
进行中
inreview
已完成,待审核
done
已完成
cancelled
已取消(不再需要)

Task Assignment Convention

任务分配规则

Assign tasks with a title prefix:
[agent-id]
.
Examples:
  • [main] Configure daily standup cron
  • [andrej] Document all ~/Projects repos
  • [fury] Research LLM fine-tuning approaches
When checking assignments, filter by your own prefix first.
任务标题需添加前缀:
[agent-id]
示例:
  • [main] Configure daily standup cron
  • [andrej] Document all ~/Projects repos
  • [fury] Research LLM fine-tuning approaches
查看已分配任务时,先按自己的前缀筛选。

Heartbeat Workflow

心跳检查流程

  1. List todo tasks:
    vk list-tasks --project-id <ID> --status todo
  2. Filter tasks with your
    [agent-id]
    prefix
  3. Pick the highest-priority task (first valid match is acceptable)
  4. Claim it:
    vk update-task --task-id <ID> --status inprogress
  5. Execute the task work
  6. Mark complete:
    vk update-task --task-id <ID> --status done
  7. If no matching task exists, reply
    HEARTBEAT_OK
  8. Scan descriptions for
    @your-agent-id
    mentions and respond as needed
  1. 列出待办任务:
    vk list-tasks --project-id <ID> --status todo
  2. 筛选带有你的
    [agent-id]
    前缀的任务
  3. 选择优先级最高的任务(第一个有效匹配即可)
  4. 认领任务:
    vk update-task --task-id <ID> --status inprogress
  5. 执行任务工作
  6. 标记完成:
    vk update-task --task-id <ID> --status done
  7. 如果没有匹配任务,回复
    HEARTBEAT_OK
  8. 扫描任务描述中的
    @your-agent-id
    提及内容并按需响应

Standup Summary Workflow

站会总结流程

  1. List all tasks across all statuses
  2. Group by status: done (last 24h), inprogress, inreview, todo
  3. Format as:
📋 Daily Standup — YYYY-MM-DD

✅ Completed:
- [agent] Task description

🔍 In Review:
- [agent] Task description

🔄 In Progress:
- [agent] Task description

📌 To Do:
- [agent] Task description
  1. 列出所有状态的任务
  2. 按状态分组:已完成(过去24小时)、进行中待审核待开始
  3. 格式如下:
📋 每日站会 — YYYY-MM-DD

✅ 已完成:
- [agent] 任务描述

🔍 待审核:
- [agent] 任务描述

🔄 进行中:
- [agent] 任务描述

📌 待开始:
- [agent] 任务描述

Tips

小贴士

  • Keep titles concise and descriptive
  • Always include
    [agent-id]
    when creating tasks
  • Update task status promptly so board state stays reliable
  • Use descriptions for details, links, and handoff context
  • Pass empty string to
    --script
    to clear a script
  • Use
    -o json
    or
    --output json
    for machine-readable output (formats: text, markdown, json, raw)
  • 标题需简洁且具有描述性
  • 创建任务时务必添加
    [agent-id]
    前缀
  • 及时更新任务状态,确保看板状态可信
  • 任务描述中填写详细信息、链接和交接上下文
  • 传入空字符串给
    --script
    参数可清空脚本
  • 使用
    -o json
    --output json
    参数获取机器可读格式的输出(支持格式:text、markdown、json、raw)