vibekanban

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Vibe Kanban

Orchestration platform for AI coding agents. Plan, review, and manage AI-generated code in isolated git worktrees.

面向AI编码Agent的编排平台。在独立的Git工作树中规划、审查和管理AI生成的代码。

Quick Navigation

快速导航

Topic	Reference
Installation & Setup	getting-started.md
Workspaces (Beta)	workspaces.md
Projects, Tasks, Review	core-features.md
Subtasks, Attempts, Conflicts	advanced-features.md
Settings, Agents, Tags	configuration.md
GitHub, Azure, VSCode, MCP	integrations.md
Common Issues	troubleshooting.md
Best Practices	vibe-guide.md

主题	参考链接
安装与设置	getting-started.md
Workspaces（Beta版）	workspaces.md
项目、任务、审查	core-features.md
子任务、尝试、冲突	advanced-features.md
设置、Agent、标签	configuration.md
GitHub、Azure、VSCode、MCP	integrations.md
常见问题	troubleshooting.md
最佳实践	vibe-guide.md

Quick Start

快速开始

Install & Run

安装与运行

bash

npx vibe-kanban

bash

npx vibe-kanban

Release Highlights (0.1.14 → 0.1.15)

版本更新亮点（0.1.14 → 0.1.15）

Workspace creation flow improved with better defaults, callback-based navigation, and
```
executor_config
```
handling.
Spin-off workspaces now preserve linked issue context and preferred repo/branch choices.
PR creation dialog can prefill fields from initial prompt context.
Core reliability improved with Electric fallback and timeout-based failover.
Claude Code integration updated for newer message types.

Opens browser automatically. Use

PORT=8080 npx vibe-kanban

for fixed port.

优化了工作区创建流程，提供更合理的默认配置、基于回调的导航，并改进了
```
executor_config
```
的处理。
衍生工作区现在会保留关联的问题上下文以及偏好的仓库/分支选择。
PR创建对话框可根据初始提示上下文预填充字段。
通过Electric降级方案和基于超时的故障转移提升了核心可靠性。
更新了Claude Code集成以适配新版消息类型。

会自动打开浏览器。使用

PORT=8080 npx vibe-kanban

指定固定端口。

Prerequisites

前置要求

Node.js LTS
Authenticated coding agent (Claude Code, Codex, Gemini, etc.)
GitHub CLI (
```
gh
```
) for PR integration

Node.js LTS
已认证的编码Agent（Claude Code、Codex、Gemini等）
GitHub CLI (
```
gh
```
) 用于PR集成

First Steps

初始步骤

Authenticate with a coding agent externally
Run
```
npx vibe-kanban
```
Complete setup dialogs
Create project from existing git repo
Add tasks and start executing

先在外部完成编码Agent的认证
运行
```
npx vibe-kanban
```
完成设置对话框
从现有Git仓库创建项目
添加任务并开始执行

Two UI Modes

两种UI模式

Classic Kanban (Tasks)

经典看板（任务）

Traditional board with columns: To do → In Progress → In Review → Done

Updates in v0.1.7:

Per-project Kanban views and a refreshed filter dialog
Sub-issues and Workspaces visibility toggles moved to the filter bar

传统看板，包含列：待办 → 进行中 → 审查中 → 已完成

v0.1.7版本更新：

支持按项目查看看板，优化了筛选对话框
子任务和工作区可见性切换移至筛选栏

Workspaces (Beta) — NEW

工作区（Beta版）—— 新增

Modern interface with:

Sessions: Multiple conversation threads per workspace
Command Bar:
```
Cmd/Ctrl + K
```
for all actions
Workspace Notes: Document requirements and decisions
Multi-repo support: Work across multiple repositories
Integrated Terminal: PTY-backed terminal with shell support
Session Dropdown: Agent icons displayed next to session titles
Sidebar filters: Filter by project and PR status (including “No project”)
Needs Attention: Includes workspaces with unseen activity

Switch between modes via Command Bar → "Open in Old UI"

现代化界面，包含：

会话：每个工作区支持多对话线程
命令栏：使用
```
Cmd/Ctrl + K
```
执行所有操作
工作区笔记：记录需求与决策
多仓库支持：跨多个仓库协作
集成终端：基于PTY的终端，支持Shell
会话下拉菜单：会话标题旁显示Agent图标
侧边栏筛选：按项目和PR状态筛选（包括“无项目”）
需要关注：标记有未查看活动的工作区

通过命令栏 → "Open in Old UI" 在模式间切换

Core Concepts

核心概念

Git Worktrees

Git工作树

Each task/workspace runs in an isolated git worktree:

Agents can't interfere with each other
Safe from main branch changes
Automatic cleanup after completion

每个任务/工作区都运行在独立的Git工作树中：

Agent之间不会互相干扰
不受主分支变更影响
完成后自动清理

Task Flow (Classic)

任务流程（经典模式）

To do → In Progress → In Review → Done

To do: Task created
In Progress: Agent executing
In Review: Agent finished, awaiting review
Done: Merged or PR merged

待办 → 进行中 → 审查中 → 已完成

待办：任务已创建
进行中：Agent正在执行
审查中：Agent执行完成，等待审查
已完成：已合并或PR已合并

Task Attempts

任务尝试

One task can have multiple attempts:

Different agent
Different branch
Fresh conversation context

单个任务可进行多次尝试：

使用不同的Agent
使用不同的分支
使用全新的对话上下文

Supported Agents

支持的Agent

Agent	Variants
Claude Code	DEFAULT, PLAN, ROUTER
Codex	DEFAULT, HIGH
Gemini	DEFAULT, FLASH
GitHub Copilot	DEFAULT
Amp	DEFAULT
Cursor Agent	DEFAULT
OpenCode	DEFAULT
Qwen Code	DEFAULT
Droid	DEFAULT
Antigravity	DEFAULT

Select agent when creating task attempt or workspace session.

Agent	变体
Claude Code	DEFAULT, PLAN, ROUTER
Codex	DEFAULT, HIGH
Gemini	DEFAULT, FLASH
GitHub Copilot	DEFAULT
Amp	DEFAULT
Cursor Agent	DEFAULT
OpenCode	DEFAULT
Qwen Code	DEFAULT
Droid	DEFAULT
Antigravity	DEFAULT

创建任务尝试或工作区会话时选择Agent。

Project Configuration

项目配置

Setup Scripts

设置脚本

Run before agent execution (e.g.,

npm install

cargo build

在Agent执行前运行（例如

npm install

、

cargo build

）。

Dev Server Scripts

开发服务器脚本

Start dev server for preview (e.g.,

npm run dev

启动开发服务器用于预览（例如

npm run dev

）。

Cleanup Scripts

清理脚本

Run after agent finishes (e.g.,

npm run format

在Agent执行完成后运行（例如

npm run format

）。

Copy Files

文件复制

Files to copy from main project to worktree (e.g.,

.env

从主项目复制到工作树的文件（例如

.env

）。

Task Creation

任务创建

Press C or click + to create task

Options:

Create Task: Add to board only
Create & Start: Add and immediately execute with default agent

Press C or click + to create task

选项：

创建任务：仅添加到看板
创建并启动：添加后立即使用默认Agent执行

Task Tags

任务标签

Reusable snippets via

@mention

Type
```
@
```
in description
Select tag from dropdown
Content inserted at cursor

Task description editor supports markdown paste and preserves inline code formatting.

通过

@提及

使用可复用片段：

在描述中输入
```
@
```
从下拉菜单选择标签
内容将插入到光标位置

任务描述编辑器支持粘贴Markdown并保留行内代码格式。

Code Review

代码审查

Task moves to "In Review" when agent finishes
Click Diff icon to view changes
Click
```
+
```
on any line to add comment
Submit all comments together
Task returns to "In Progress" for fixes

Agent执行完成后，任务移至“审查中”状态
点击Diff图标查看变更
在任意行点击
```
+
```
添加评论
一次性提交所有评论
任务返回“进行中”状态以修复问题

Git Operations

Git操作

Action	Description
Merge	Merge to target branch
Create PR	Open PR on GitHub/Azure
Rebase	Update with target branch changes
Push	Push additional changes to PR

操作	描述
合并	合并到目标分支
创建PR	在GitHub/Azure上创建PR
变基	同步目标分支的变更
推送	将额外变更推送到PR

Preview Mode

预览模式

Test web apps without leaving Vibe Kanban:

Configure dev server script in project settings
Click "Start Dev Server" in Preview tab
View app in embedded iframe
Install
```
vibe-kanban-web-companion
```
for component selection

无需离开Vibe Kanban即可测试Web应用：

在项目设置中配置开发服务器脚本
在预览标签页点击“启动开发服务器”
在嵌入的iframe中查看应用
安装
```
vibe-kanban-web-companion
```
以支持组件选择

Keyboard Shortcuts

键盘快捷键

Key	Action
`C`	Create task
`⌘/Ctrl + Enter`	Submit/Send message
`k/j`	Navigate up/down in column
`h/l`	Navigate left/right between columns
`Enter`	Open task
`⌘/Ctrl + S`	Focus search

按键	操作
`C`	创建任务
`⌘/Ctrl + Enter`	提交/发送消息
`k/j`	在列内向上/向下导航
`h/l`	在列间向左/向右导航
`Enter`	打开任务
`⌘/Ctrl + S`	聚焦搜索

MCP Integration

MCP集成

Add MCP Servers to Agents

为Agent添加MCP服务器

Settings → MCP Servers → Select agent → Add servers

设置 → MCP服务器 → 选择Agent → 添加服务器

Vibe Kanban MCP Server

Vibe Kanban MCP服务器

Expose Vibe Kanban to external MCP clients:

json

{
  "mcpServers": {
    "vibe_kanban": {
      "command": "npx",
      "args": ["-y", "vibe-kanban@latest", "--mcp"]
    }
  }
}

MCP tools:

list_projects

list_tasks

create_task

start_task_attempt

将Vibe Kanban暴露给外部MCP客户端：

json

{
  "mcpServers": {
    "vibe_kanban": {
      "command": "npx",
      "args": ["-y", "vibe-kanban@latest", "--mcp"]
    }
  }
}

MCP工具：

list_projects

list_tasks

create_task

start_task_attempt

Critical Safety Note

重要安全提示

Vibe Kanban runs agents with

--dangerously-skip-permissions

--yolo

by default for autonomous operation. Each task runs in isolated worktree, but agents can still perform system-level actions. Review work and keep backups.

Vibe Kanban默认使用

--dangerously-skip-permissions

--yolo

参数运行Agent以支持自主操作。每个任务都在独立工作树中运行，但Agent仍可能执行系统级操作。请仔细审查工作内容并做好备份。

Critical Prohibitions

重要注意事项

Do not skip agent authentication before first use
Do not ignore worktree isolation benefits
Do not forget to configure setup/cleanup scripts for dependencies
Do not mix multiple agents on same task without new attempts
Do not ignore rebase conflicts — resolve or abort

首次使用前请勿跳过Agent认证
请勿忽视工作树隔离的优势
请勿忘记为依赖项配置设置/清理脚本
同一任务使用多个Agent时请创建新的任务尝试
请勿忽视变基冲突 — 解决或终止

vibekanban

Original

Translation

Vibe Kanban

Vibe Kanban

Quick Navigation

快速导航

Quick Start

快速开始

Install & Run

安装与运行

Release Highlights (0.1.14 → 0.1.15)

版本更新亮点（0.1.14 → 0.1.15）

Prerequisites

前置要求

First Steps

初始步骤

Two UI Modes

两种UI模式

Classic Kanban (Tasks)

经典看板（任务）

Workspaces (Beta) — NEW

工作区（Beta版）—— 新增

Core Concepts

核心概念

Git Worktrees

Git工作树

Task Flow (Classic)

任务流程（经典模式）

Task Attempts

任务尝试

Supported Agents

支持的Agent

Project Configuration

项目配置

Setup Scripts

设置脚本

Dev Server Scripts

开发服务器脚本

Cleanup Scripts

清理脚本

Copy Files

文件复制

Task Creation

任务创建

Task Tags

任务标签

Code Review

代码审查

Git Operations

Git操作

Preview Mode

预览模式

Keyboard Shortcuts

键盘快捷键

MCP Integration

MCP集成

Add MCP Servers to Agents

为Agent添加MCP服务器

Vibe Kanban MCP Server

Vibe Kanban MCP服务器

Critical Safety Note

重要安全提示

Critical Prohibitions

重要注意事项

Links

相关链接