@vibedx/vibekit 0.6.0 → 0.6.2
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 +8 -6
- package/package.json +3 -2
- package/skills/README.md +23 -0
- package/skills/vibekit/SKILL.md +177 -0
package/README.md
CHANGED
|
@@ -51,6 +51,8 @@ npx skills add vibedx/vibekit
|
|
|
51
51
|
|
|
52
52
|
The skill teaches agents the ticket-driven workflow — they'll create focused tickets before writing code, track work through git branches, and keep tickets as living documentation.
|
|
53
53
|
|
|
54
|
+
**Coordinating multiple agents?** See **[docs/agent-workflow.md](./docs/agent-workflow.md)** for a framework-agnostic pattern for running multi-agent teams on a shared repo — assignees, polling loops, escalation, and loop prevention.
|
|
55
|
+
|
|
54
56
|
## 🤔 Why VibeKit?
|
|
55
57
|
|
|
56
58
|
- **🎯 Vibe code with manageable smaller tasks** - Break down complex features into focused tickets
|
|
@@ -94,13 +96,13 @@ vibe get-started
|
|
|
94
96
|
```bash
|
|
95
97
|
# Create a new ticket
|
|
96
98
|
vibe new "Fix login bug"
|
|
97
|
-
vibe new "Add dark mode" --priority high --assignee
|
|
98
|
-
vibe new "Quick task" --assignee
|
|
99
|
+
vibe new "Add dark mode" --priority high --assignee alice
|
|
100
|
+
vibe new "Quick task" --assignee bob -n # -n skips AI prompt
|
|
99
101
|
|
|
100
102
|
# List all tickets (with optional filtering)
|
|
101
103
|
vibe list
|
|
102
104
|
vibe list --status=open
|
|
103
|
-
vibe list --assignee=
|
|
105
|
+
vibe list --assignee=alice
|
|
104
106
|
|
|
105
107
|
# Close/complete a ticket
|
|
106
108
|
vibe close TKT-001
|
|
@@ -116,11 +118,11 @@ vibe start TKT-001 --base main --update-status
|
|
|
116
118
|
vibe team
|
|
117
119
|
|
|
118
120
|
# Add a member (stored in .vibe/team.yml)
|
|
119
|
-
vibe team add
|
|
120
|
-
vibe team add
|
|
121
|
+
vibe team add alice --name "Alice" --github alice --slack U0ABC123 --role Engineer
|
|
122
|
+
vibe team add bob --name "Bob" --github bob --slack U0DEF456 --role Designer
|
|
121
123
|
|
|
122
124
|
# Show a member's details
|
|
123
|
-
vibe team show
|
|
125
|
+
vibe team show alice
|
|
124
126
|
|
|
125
127
|
# Remove a member
|
|
126
128
|
vibe team remove old-member
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vibedx/vibekit",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.2",
|
|
4
4
|
"description": "A powerful CLI tool for managing development tickets and project workflows",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"files": [
|
|
8
8
|
"index.js",
|
|
9
9
|
"src/",
|
|
10
|
-
"assets/"
|
|
10
|
+
"assets/",
|
|
11
|
+
"skills/"
|
|
11
12
|
],
|
|
12
13
|
"bin": {
|
|
13
14
|
"vibe": "index.js"
|
package/skills/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# VibeKit Skills
|
|
2
|
+
|
|
3
|
+
Agent skills for the [open agent skills ecosystem](https://skills.sh).
|
|
4
|
+
|
|
5
|
+
## Installing
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx skills add vibedx/vibekit
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or install directly:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add https://github.com/vibedx/vibekit/tree/main/skills/vibekit
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Available Skills
|
|
18
|
+
|
|
19
|
+
### vibekit
|
|
20
|
+
|
|
21
|
+
Ticket-driven development workflow. Teaches AI coding agents how to use the vibekit CLI to create scoped tickets before writing code, track work through git branches, and maintain living documentation.
|
|
22
|
+
|
|
23
|
+
See [skills/vibekit/SKILL.md](./vibekit/SKILL.md) for full details.
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vibekit
|
|
3
|
+
description: Ticket-driven development workflow for AI coding agents using VibeKit CLI. Use when the user asks to create a task, feature, bug fix, or ticket; mentions "vibe new", "vibe list", or vibekit commands; or wants structured, scoped work breakdown. Triggers on phrases like "add a ticket", "track this task", "break this down", or "start a new feature". Helps agents create focused tickets with clear acceptance criteria before writing code.
|
|
4
|
+
license: MIT
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# VibeKit — Ticket-Driven Development
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
## 🔴 MANDATORY RULE: Always Create a Ticket First
|
|
12
|
+
|
|
13
|
+
**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.
|
|
14
|
+
|
|
15
|
+
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:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
vibe new "descriptive title" --assignee <your-username> --priority <level> -n
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Then read the ticket, plan the work, and `vibe start TKT-XXX` before touching any code.
|
|
22
|
+
|
|
23
|
+
**Only skip the ticket for truly trivial changes**: typo fixes, single-line config tweaks, or answering a quick question.
|
|
24
|
+
|
|
25
|
+
## Why This Matters
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# 1. Create a ticket
|
|
31
|
+
vibe new "Add user authentication" --assignee <username> --priority high -n
|
|
32
|
+
|
|
33
|
+
# 2. Start working (creates git branch feature/TKT-XXX-slug)
|
|
34
|
+
vibe start TKT-001
|
|
35
|
+
|
|
36
|
+
# 3. Implement the work, commit with ticket reference
|
|
37
|
+
git commit -m "TKT-001: add login endpoint"
|
|
38
|
+
|
|
39
|
+
# 4. Close when done
|
|
40
|
+
vibe close TKT-001
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm install -g @vibedx/vibekit
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Then in any project:
|
|
50
|
+
```bash
|
|
51
|
+
vibe init # Creates .vibe/ directory with config, team, templates
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Core Commands
|
|
55
|
+
|
|
56
|
+
| Command | Purpose |
|
|
57
|
+
|---------|---------|
|
|
58
|
+
| `vibe init` | Initialize vibekit in a project |
|
|
59
|
+
| `vibe new "title"` | Create a ticket |
|
|
60
|
+
| `vibe list` | List all tickets |
|
|
61
|
+
| `vibe start <id>` | Start work (creates git branch) |
|
|
62
|
+
| `vibe close <id>` | Mark ticket done |
|
|
63
|
+
| `vibe lint` | Validate ticket format |
|
|
64
|
+
| `vibe lint --fix` | Auto-fix missing sections |
|
|
65
|
+
| `vibe refine <id>` | AI-enhance ticket details |
|
|
66
|
+
| `vibe team` | Manage team members |
|
|
67
|
+
|
|
68
|
+
## Creating Tickets (for AI agents)
|
|
69
|
+
|
|
70
|
+
**Always use `-n` / `--no-interactive` when creating tickets programmatically.** This skips the AI enhancement prompt which would otherwise block automation.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
vibe new "Fix login redirect loop" --assignee alice --priority high -n
|
|
74
|
+
vibe new "Add dark mode" --assignee bob --author alice -n
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Useful flags
|
|
78
|
+
|
|
79
|
+
- `--priority low|medium|high|critical` (default: medium)
|
|
80
|
+
- `--status open|in_progress|review|done` (default: open)
|
|
81
|
+
- `--assignee <username>` — who works on it
|
|
82
|
+
- `--author <username>` — who created it
|
|
83
|
+
- `-n` / `--no-interactive` — skip AI enhancement prompt
|
|
84
|
+
|
|
85
|
+
## Ticket Structure
|
|
86
|
+
|
|
87
|
+
Tickets live in `.vibe/tickets/` as markdown files with YAML frontmatter:
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
---
|
|
91
|
+
id: TKT-001
|
|
92
|
+
title: Add user authentication
|
|
93
|
+
slug: TKT-001-add-user-authentication
|
|
94
|
+
status: open
|
|
95
|
+
priority: high
|
|
96
|
+
assignee: "alice"
|
|
97
|
+
author: "bob"
|
|
98
|
+
created_at: 2026-04-11T10:00:00Z
|
|
99
|
+
updated_at: 2026-04-11T10:00:00Z
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Description
|
|
103
|
+
What needs to be done and why.
|
|
104
|
+
|
|
105
|
+
## Acceptance Criteria
|
|
106
|
+
- [ ] Concrete checkbox 1
|
|
107
|
+
- [ ] Concrete checkbox 2
|
|
108
|
+
|
|
109
|
+
## Implementation Notes
|
|
110
|
+
Technical details, file paths, API references.
|
|
111
|
+
|
|
112
|
+
## Testing & Test Cases
|
|
113
|
+
Brief test scenarios.
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Filtering Tickets
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
vibe list # All tickets
|
|
120
|
+
vibe list --status=open # Only open
|
|
121
|
+
vibe list --assignee=alice # Only alice's tickets
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Team Management
|
|
125
|
+
|
|
126
|
+
Teams are stored in `.vibe/team.yml`. Assignee values in tickets should match team member IDs.
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
vibe team add alice --name "Alice" --github alice --slack U0ABC123 --role Engineer
|
|
130
|
+
vibe team # List members
|
|
131
|
+
vibe team show alice # Show one member
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## When to Use This Skill
|
|
135
|
+
|
|
136
|
+
Apply vibekit workflow when:
|
|
137
|
+
|
|
138
|
+
- User asks to "add a feature", "fix a bug", "implement X", "build Y"
|
|
139
|
+
- Task is non-trivial (more than a one-line fix)
|
|
140
|
+
- Work touches multiple files or requires planning
|
|
141
|
+
- User mentions `vibe`, tickets, tracking, or task management
|
|
142
|
+
- Working in a project that has a `.vibe/` directory
|
|
143
|
+
|
|
144
|
+
**Don't force tickets for trivial changes** — typo fixes, config tweaks, or single-line edits can skip the ticket workflow.
|
|
145
|
+
|
|
146
|
+
## Integration with Git
|
|
147
|
+
|
|
148
|
+
`vibe start TKT-001` automatically:
|
|
149
|
+
1. Creates branch `feature/TKT-001-<slug>` (or configured prefix)
|
|
150
|
+
2. Updates ticket status to `in_progress`
|
|
151
|
+
3. Switches to the new branch
|
|
152
|
+
|
|
153
|
+
`vibe close TKT-001`:
|
|
154
|
+
1. Updates ticket status to `done`
|
|
155
|
+
2. Leaves the branch for manual merge/PR
|
|
156
|
+
|
|
157
|
+
## Automation Pattern
|
|
158
|
+
|
|
159
|
+
For bots and automated agents working through tickets:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
# Find open tickets assigned to you
|
|
163
|
+
vibe list --assignee=mybotname --status=open
|
|
164
|
+
|
|
165
|
+
# For each ticket:
|
|
166
|
+
# 1. Read .vibe/tickets/TKT-XXX-*.md for full context
|
|
167
|
+
# 2. Do the work on branch opus/<ticket-id>-<description>
|
|
168
|
+
# 3. Commit changes
|
|
169
|
+
# 4. Close: vibe close TKT-XXX
|
|
170
|
+
# 5. Notify team
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Links
|
|
174
|
+
|
|
175
|
+
- Repo: https://github.com/vibedx/vibekit
|
|
176
|
+
- npm: https://www.npmjs.com/package/@vibedx/vibekit
|
|
177
|
+
- Issues: https://github.com/vibedx/vibekit/issues
|