Back to Details

vibekit

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

VibeKit — Ticket-Driven Development

VibeKit — 工单驱动开发

VibeKit is a CLI for managing development tickets and AI-assisted workflows. This skill teaches agents how to use vibekit properly — create tickets before coding, work through them systematically, and keep tickets as living documentation.
VibeKit是一款用于管理开发工单和AI辅助工作流的CLI工具。本技能将指导Agent如何正确使用vibekit——编码前先创建工单，系统性地推进工单任务，同时将工单作为活的文档进行维护。

🔴 MANDATORY RULE: Always Create a Ticket First

🔴 强制规则：始终优先创建工单

Before writing ANY code on a repo that has a 
.vibe/
directory, you MUST create a vibekit ticket. No exceptions for features, bug fixes, refactors, or multi-step tasks.
This is not a suggestion — it's the core workflow. If the user asks you to "add X", "fix Y", or "build Z", your first action should be:
bash
vibe new "descriptive title" --assignee <your-username> --priority <level> -n
Then read the ticket, plan the work, and 
vibe start TKT-XXX
before touching any code.
Only skip the ticket for truly trivial changes: typo fixes, single-line config tweaks, or answering a quick question.
在带有
.vibe/
目录的代码仓库中编写任何代码之前，你必须先创建vibekit工单。 无论是功能开发、bug修复、重构还是多步骤任务，都没有例外。
这不是建议——而是核心工作流。如果用户要求你“添加X功能”、“修复Y问题”或“搭建Z模块”，你的第一步操作应该是：
bash
vibe new "descriptive title" --assignee <your-username> --priority <level> -n
随后阅读工单内容，规划工作，在改动任何代码之前执行
vibe start TKT-XXX
启动任务。
仅当改动确实非常琐碎时可以跳过创建工单：比如错别字修复、单行配置调整，或者回答简单问题。

Why This Matters

为什么这很重要

Tickets break work into scoped, focused chunks that reduce AI drift and create documentation as a side effect. They also give humans a clear trail of what was done and why — critical for collaboration between humans and agents.
bash
undefined
工单将工作拆解为范围明确、聚焦的任务块，既可以减少AI偏移，还能顺带生成文档。同时工单也能让人类清晰追溯做了什么、为什么这么做——这对人类和Agent之间的协作至关重要。
bash
undefined

1. Create a ticket

1. Create a ticket

vibe new "Add user authentication" --assignee <username> --priority high -n
vibe new "Add user authentication" --assignee <username> --priority high -n

2. Start working (creates git branch feature/TKT-XXX-slug)

2. Start working (creates git branch feature/TKT-XXX-slug)

vibe start TKT-001
vibe start TKT-001

3. Implement the work, commit with ticket reference

3. Implement the work, commit with ticket reference

git commit -m "TKT-001: add login endpoint"
git commit -m "TKT-001: add login endpoint"

4. Close when done

4. Close when done

vibe close TKT-001
undefined
vibe close TKT-001
undefined

Installation

安装

bash
npm install -g @vibedx/vibekit
Then in any project:
bash
vibe init          # Creates .vibe/ directory with config, team, templates
bash
npm install -g @vibedx/vibekit
随后在任意项目中执行：
bash
vibe init          # Creates .vibe/ directory with config, team, templates

Core Commands

核心命令

CommandPurpose
vibe init
Initialize vibekit in a project
vibe new "title"
Create a ticket
vibe list
List all tickets
vibe start <id>
Start work (creates git branch)
vibe close <id>
Mark ticket done
vibe lint
Validate ticket format
vibe lint --fix
Auto-fix missing sections
vibe refine <id>
AI-enhance ticket details
vibe team
Manage team members
Command用途
vibe init
在项目中初始化 vibekit
vibe new "title"
创建工单
vibe list
列出所有工单
vibe start <id>
开始处理工单（自动创建git分支）
vibe close <id>
标记工单已完成
vibe lint
校验工单格式
vibe lint --fix
自动补全缺失的工单部分
vibe refine <id>
用AI增强工单详情
vibe team
管理团队成员

Creating Tickets (for AI agents)

为AI Agent创建工单

Always use 
-n
/ 
--no-interactive
when creating tickets programmatically. This skips the AI enhancement prompt which would otherwise block automation.
bash
vibe new "Fix login redirect loop" --assignee alice --priority high -n
vibe new "Add dark mode" --assignee bob --author alice -n
以程序化方式创建工单时，请始终使用
-n
/ 
--no-interactive
参数。 这会跳过AI增强提示，避免阻塞自动化流程。
bash
vibe new "Fix login redirect loop" --assignee alice --priority high -n
vibe new "Add dark mode" --assignee bob --author alice -n

Useful flags

常用参数

  • --priority low|medium|high|critical
    (default: medium)
  • --status open|in_progress|review|done
    (default: open)
  • --assignee <username>
    — who works on it
  • --author <username>
    — who created it
  • -n
    / 
    --no-interactive
    — skip AI enhancement prompt
  • --priority low|medium|high|critical
    （默认值：medium）
  • --status open|in_progress|review|done
    （默认值：open）
  • --assignee <username>
    — 工单处理人
  • --author <username>
    — 工单创建人
  • -n
    / 
    --no-interactive
    — 跳过AI增强提示

Ticket Structure

工单结构

Tickets live in 
.vibe/tickets/
as markdown files with YAML frontmatter:
markdown
---
id: TKT-001
title: Add user authentication
slug: TKT-001-add-user-authentication
status: open
priority: high
assignee: "alice"
author: "bob"
created_at: 2026-04-11T10:00:00Z
updated_at: 2026-04-11T10:00:00Z
---
工单以带有YAML frontmatter的markdown文件形式存放在
.vibe/tickets/
目录下：
markdown
---
id: TKT-001
title: Add user authentication
slug: TKT-001-add-user-authentication
status: open
priority: high
assignee: "alice"
author: "bob"
created_at: 2026-04-11T10:00:00Z
updated_at: 2026-04-11T10:00:00Z
---

Description

Description

What needs to be done and why.
What needs to be done and why.

Acceptance Criteria

Acceptance Criteria

  • Concrete checkbox 1
  • Concrete checkbox 2
  • Concrete checkbox 1
  • Concrete checkbox 2

Implementation Notes

Implementation Notes

Technical details, file paths, API references.
Technical details, file paths, API references.

Testing & Test Cases

Testing & Test Cases

Brief test scenarios.
undefined
Brief test scenarios.
undefined

Filtering Tickets

筛选工单

bash
vibe list                       # All tickets
vibe list --status=open         # Only open
vibe list --assignee=alice      # Only alice's tickets
bash
vibe list                       # All tickets
vibe list --status=open         # Only open
vibe list --assignee=alice      # Only alice's tickets

Team Management

团队管理

Teams are stored in 
.vibe/team.yml
. Assignee values in tickets should match team member IDs.
bash
vibe team add alice --name "Alice" --github alice --slack U0ABC123 --role Engineer
vibe team                       # List members
vibe team show alice            # Show one member
团队信息存储在
.vibe/team.yml
中，工单中的处理人值需要和团队成员ID匹配。
bash
vibe team add alice --name "Alice" --github alice --slack U0ABC123 --role Engineer
vibe team                       # List members
vibe team show alice            # Show one member

When to Use This Skill

何时使用本技能

Apply vibekit workflow when:
  • User asks to "add a feature", "fix a bug", "implement X", "build Y"
  • Task is non-trivial (more than a one-line fix)
  • Work touches multiple files or requires planning
  • User mentions 
    vibe
    , tickets, tracking, or task management
  • Working in a project that has a 
    .vibe/
    directory
Don't force tickets for trivial changes — typo fixes, config tweaks, or single-line edits can skip the ticket workflow.
出现以下情况时可应用vibekit工作流：
  • 用户要求“添加功能”、“修复bug”、“实现X需求”、“搭建Y模块”
  • 任务非琐碎（不止是单行修复）
  • 工作涉及多个文件改动或需要提前规划
  • 用户提到
    vibe
    、工单、跟踪、任务管理相关内容
  • 在带有
    .vibe/
    目录的项目中工作
不要对琐碎改动强制要求创建工单——错别字修复、配置调整、单行编辑可以跳过工单工作流。

Integration with Git

与Git集成

vibe start TKT-001
automatically:
  1. Creates branch 
    feature/TKT-001-<slug>
    (or configured prefix)
  2. Updates ticket status to 
    in_progress
  3. Switches to the new branch
vibe close TKT-001
:
  1. Updates ticket status to 
    done
  2. Leaves the branch for manual merge/PR
vibe start TKT-001
会自动执行以下操作：
  1. 创建分支
    feature/TKT-001-<slug>
    （或配置的前缀）
  2. 将工单状态更新为
    in_progress
  3. 切换到新分支
vibe close TKT-001
会自动执行以下操作：
  1. 将工单状态更新为
    done
  2. 保留分支供手动合并/提交PR

Automation Pattern

自动化模式

For bots and automated agents working through tickets:
bash
undefined
对于处理工单的机器人和自动化Agent：
bash
undefined

Find open tickets assigned to you

Find open tickets assigned to you

vibe list --assignee=mybotname --status=open
vibe list --assignee=mybotname --status=open

For each ticket:

For each ticket:

1. Read .vibe/tickets/TKT-XXX-*.md for full context

1. Read .vibe/tickets/TKT-XXX-*.md for full context

2. Do the work on branch opus/<ticket-id>-<description>

2. Do the work on branch opus/<ticket-id>-<description>

3. Commit changes

3. Commit changes

4. Close: vibe close TKT-XXX

4. Close: vibe close TKT-XXX

5. Notify team

5. Notify team

undefined
undefined

Links

链接