@su-record/vibe 3.2.6 → 3.2.7
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.en.md +1 -1
- package/README.md +1 -1
- package/dist/cli/postinstall/constants.d.ts.map +1 -1
- package/dist/cli/postinstall/constants.js +10 -9
- package/dist/cli/postinstall/constants.js.map +1 -1
- package/hooks/scripts/__tests__/.vibe/command-log.txt +3 -3
- package/package.json +2 -2
- package/skills/vibe/SKILL.md +27 -86
- package/skills/vibe/references/routing-examples.md +85 -0
- package/skills/vibe.agents-md/SKILL.md +12 -10
- package/skills/vibe.analyze/SKILL.md +22 -211
- package/skills/vibe.analyze/references/mode1-feature.md +81 -0
- package/skills/vibe.analyze/references/mode2-document.md +50 -0
- package/skills/vibe.analyze/references/mode3-website.md +47 -0
- package/skills/vibe.analyze/references/mode4-quality.md +35 -0
- package/skills/vibe.brand-assets/SKILL.md +2 -2
- package/skills/vibe.brand-assets/references/mobile-assets.md +6 -0
- package/skills/vibe.capability-loop/SKILL.md +14 -80
- package/skills/vibe.capability-loop/references/escalate.md +86 -0
- package/skills/vibe.chub-usage/SKILL.md +3 -132
- package/skills/vibe.clone/SKILL.md +43 -358
- package/skills/vibe.clone/references/phase-commands.md +118 -0
- package/skills/vibe.clone/references/setup-and-layout.md +34 -0
- package/skills/vibe.clone/references/verification-loops.md +64 -0
- package/skills/vibe.commit-push-pr/SKILL.md +10 -4
- package/skills/vibe.context7-usage/SKILL.md +3 -99
- package/skills/vibe.continue/SKILL.md +17 -7
- package/skills/{vibe.handoff → vibe.continue}/agents/context-summarizer.md +1 -1
- package/skills/{vibe.handoff → vibe.continue}/agents/document-writer.md +1 -1
- package/skills/{vibe.handoff → vibe.continue}/agents/state-collector.md +1 -1
- package/skills/{vibe.handoff → vibe.continue}/agents/verifier.md +1 -1
- package/skills/{vibe.handoff/rubrics/completeness.md → vibe.continue/references/handoff-completeness.md} +1 -1
- package/skills/{vibe.handoff/templates → vibe.continue/references}/handoff.md +37 -2
- package/skills/vibe.contract/SKILL.md +4 -27
- package/skills/vibe.create-prd/SKILL.md +8 -1
- package/skills/vibe.design/SKILL.md +18 -5
- package/skills/vibe.design/references/design-context.md +184 -0
- package/skills/vibe.design-refine/SKILL.md +7 -0
- package/skills/vibe.design-review/SKILL.md +7 -0
- package/skills/vibe.design-teach/SKILL.md +2 -175
- package/skills/vibe.devlog/SKILL.md +14 -11
- package/skills/vibe.devlog/references/auto-push.md +10 -0
- package/skills/vibe.docs/SKILL.md +27 -198
- package/skills/vibe.docs/references/agent.md +55 -0
- package/skills/vibe.docs/references/arch.md +28 -0
- package/skills/vibe.docs/references/codemaps.md +17 -0
- package/skills/vibe.docs/references/diagram.md +24 -0
- package/skills/vibe.docs/references/guide.md +23 -0
- package/skills/vibe.docs/references/readme.md +45 -0
- package/skills/vibe.docs/references/release.md +31 -0
- package/skills/vibe.documentation-provider/SKILL.md +22 -0
- package/skills/vibe.documentation-provider/references/chub.md +141 -0
- package/skills/vibe.documentation-provider/references/context7.md +107 -0
- package/skills/vibe.educational-content/SKILL.md +7 -0
- package/skills/vibe.event/SKILL.md +47 -146
- package/skills/vibe.event/references/comms.md +173 -0
- package/skills/vibe.event/references/operations.md +208 -0
- package/skills/vibe.event/references/orchestration-legacy.md +97 -0
- package/skills/vibe.event/references/planning.md +145 -0
- package/skills/vibe.event-comms/SKILL.md +3 -165
- package/skills/vibe.event-ops/SKILL.md +3 -200
- package/skills/vibe.event-planning/SKILL.md +3 -137
- package/skills/vibe.figma/SKILL.md +26 -692
- package/skills/vibe.figma/references/branch1-read-convention.md +82 -0
- package/skills/vibe.figma/references/branch2-read-standalone.md +69 -0
- package/skills/vibe.figma/references/branch3-write.md +122 -0
- package/skills/vibe.figma/references/core-implementation.md +453 -0
- package/skills/vibe.git-worktree/SKILL.md +2 -6
- package/skills/vibe.git-worktree/references/troubleshooting.md +9 -0
- package/skills/vibe.handoff/SKILL.md +2 -103
- package/skills/vibe.harness/SKILL.md +17 -12
- package/skills/vibe.image/SKILL.md +8 -1
- package/skills/vibe.llm/SKILL.md +8 -1
- package/skills/vibe.loop/SKILL.md +9 -11
- package/skills/vibe.loop/references/install-adapters.md +10 -0
- package/skills/vibe.presentation/SKILL.md +7 -0
- package/skills/vibe.prioritization/SKILL.md +7 -0
- package/skills/vibe.priority-todos/SKILL.md +2 -57
- package/skills/vibe.react-best-practices/SKILL.md +1 -1
- package/skills/vibe.reason/SKILL.md +9 -2
- package/skills/vibe.regress/SKILL.md +6 -28
- package/skills/vibe.regress/templates/{test-jest.md → test-template.md} +1 -0
- package/skills/vibe.review/SKILL.md +35 -38
- package/skills/vibe.review/references/priority-todos.md +66 -0
- package/skills/vibe.review/references/ui-ux-review.md +39 -0
- package/skills/vibe.run/SKILL.md +57 -656
- package/skills/vibe.run/references/arch-guard.md +178 -0
- package/skills/vibe.run/references/e2e-and-autofix.md +40 -0
- package/skills/vibe.run/references/exec-plan.md +145 -0
- package/skills/vibe.run/references/guidelines-and-tools.md +84 -0
- package/skills/vibe.run/references/process-steps.md +179 -0
- package/skills/vibe.run/references/restraint.md +66 -0
- package/skills/vibe.scaffold/SKILL.md +9 -13
- package/skills/vibe.scaffold/references/clean-architecture.md +17 -0
- package/skills/vibe.spec/SKILL.md +12 -8
- package/skills/vibe.spec/references/legacy-artifacts.md +6 -0
- package/skills/vibe.test/SKILL.md +93 -70
- package/skills/vibe.test/references/report-template.md +101 -0
- package/skills/vibe.tool-fallback/SKILL.md +10 -32
- package/skills/vibe.tool-fallback/references/external-llm.md +10 -0
- package/skills/vibe.tool-fallback/references/file-lookup.md +9 -0
- package/skills/vibe.tool-fallback/references/web-search.md +11 -0
- package/skills/vibe.trace/SKILL.md +2 -264
- package/skills/vibe.ui-ux-pro-max/SKILL.md +1 -3
- package/skills/vibe.ui-ux-pro-max/references/charts-and-data.md +7 -0
- package/skills/vibe.user-personas/SKILL.md +8 -1
- package/skills/vibe.verify/SKILL.md +30 -4
- package/skills/vibe.verify/references/trace-mode.md +271 -0
- package/skills/vibe.regress/templates/test-vitest.md +0 -30
- /package/skills/{vibe.design-teach/rubrics → vibe.design/references}/brand-personality.md +0 -0
- /package/skills/{vibe.design-teach → vibe.design}/templates/design-context.json +0 -0
- /package/skills/{vibe.context7-usage/rubrics/when-to-use.md → vibe.documentation-provider/references/context7-when-to-use.md} +0 -0
- /package/skills/{vibe.event-ops/rubrics → vibe.event/references}/contingency.md +0 -0
- /package/skills/{vibe.event-ops/templates/d-day-checklist.md → vibe.event/references/d-day-checklist-template.md} +0 -0
- /package/skills/{vibe.event-comms/templates/email-invite.md → vibe.event/references/email-invite-template.md} +0 -0
- /package/skills/{vibe.event-planning/templates/event-plan.md → vibe.event/references/event-plan-template.md} +0 -0
- /package/skills/{vibe.event-comms/templates/sns-post.md → vibe.event/references/sns-post-template.md} +0 -0
- /package/skills/{vibe.event-planning/rubrics → vibe.event/references}/timeline.md +0 -0
- /package/skills/{vibe.priority-todos/templates/todo-board.md → vibe.review/references/todo-board-template.md} +0 -0
- /package/skills/{vibe.priority-todos/rubrics/prioritization.md → vibe.review/references/todo-prioritization.md} +0 -0
|
@@ -10,6 +10,13 @@ priority: 50
|
|
|
10
10
|
|
|
11
11
|
# Design Review — Technical Audit + UX Critique
|
|
12
12
|
|
|
13
|
+
## Done Criteria
|
|
14
|
+
|
|
15
|
+
- [ ] review report가 지정 출력 경로에 존재한다.
|
|
16
|
+
- [ ] 모든 finding에 severity와 파일·행 또는 화면 근거가 있다.
|
|
17
|
+
- [ ] accessibility, responsive, performance, theming 검사가 판정되어 있다.
|
|
18
|
+
- [ ] 발견된 P1 개수와 최종 판정이 보고서에 기록되어 있다.
|
|
19
|
+
|
|
13
20
|
Read-only design quality review. Two modes selected by the first argument. No code modifications — report only.
|
|
14
21
|
|
|
15
22
|
## Usage
|
|
@@ -1,184 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: vibe.design-teach
|
|
3
|
+
description: Compatibility alias for gathering project design context. Use for design-teach, design-setup, or design-context requests.
|
|
3
4
|
user-invocable: false
|
|
4
5
|
invocation: [auto]
|
|
5
6
|
tier: standard
|
|
6
|
-
description: "Gather and store project design context — target audience, brand personality, aesthetic direction, constraints. Used by other design-* skills. Use when design-teach, design-setup, design-context."
|
|
7
7
|
triggers: [design-teach, design-setup, design-context]
|
|
8
8
|
priority: 50
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
Collect project-specific design context so all design-* skills produce tailored, brand-aware results. Saves to `.vibe/design-context.json`.
|
|
14
|
-
|
|
15
|
-
## Usage
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
/design-teach # Interactive context gathering
|
|
19
|
-
/design-teach --update # Update existing context
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Process
|
|
23
|
-
|
|
24
|
-
### Step 1: Auto-Explore Codebase
|
|
25
|
-
|
|
26
|
-
Before asking questions, automatically gather existing signals:
|
|
27
|
-
|
|
28
|
-
| Signal | Where to Look |
|
|
29
|
-
|--------|---------------|
|
|
30
|
-
| CSS variables / tokens | `*.css`, `tailwind.config.*`, `theme.*` |
|
|
31
|
-
| Color palette | Existing color definitions, brand assets |
|
|
32
|
-
| Typography | Font imports, font-family declarations |
|
|
33
|
-
| Component library | `package.json` dependencies (MUI, Chakra, shadcn, etc.) |
|
|
34
|
-
| Design system | `.vibe/design-system/*/MASTER.md` |
|
|
35
|
-
| Existing context | `.vibe/design-context.json` (if updating) |
|
|
36
|
-
|
|
37
|
-
### Step 2: Ask Clarifying Questions
|
|
38
|
-
|
|
39
|
-
Present findings from Step 1, then ask what's missing:
|
|
40
|
-
|
|
41
|
-
**1. Target Audience**
|
|
42
|
-
- Who are the primary users? (developers, consumers, enterprise, internal)
|
|
43
|
-
- Technical sophistication? (tech-savvy, general public, mixed)
|
|
44
|
-
- Usage context? (desktop office, mobile on-the-go, both)
|
|
45
|
-
|
|
46
|
-
**2. Brand Personality**
|
|
47
|
-
- How should the product feel? (professional, playful, minimal, bold, warm)
|
|
48
|
-
- Reference products with similar feel? (e.g., "Linear-like", "Notion-like")
|
|
49
|
-
- Any brand guidelines or style guide URL?
|
|
50
|
-
|
|
51
|
-
**3. Aesthetic Direction**
|
|
52
|
-
- Visual density preference? (spacious, balanced, dense)
|
|
53
|
-
- Color mood? (warm, cool, neutral, vibrant)
|
|
54
|
-
- Typography mood? (modern sans, classic serif, monospace-technical)
|
|
55
|
-
|
|
56
|
-
**4. Constraints**
|
|
57
|
-
- Accessibility requirements? (WCAG AA, AAA, specific needs)
|
|
58
|
-
- Supported devices? (desktop-only, mobile-first, responsive)
|
|
59
|
-
- Dark mode required?
|
|
60
|
-
- Performance budget? (target LCP, bundle size limits)
|
|
61
|
-
|
|
62
|
-
### Step 3: Save Context
|
|
63
|
-
|
|
64
|
-
Write gathered context to `.vibe/design-context.json` using the Write tool.
|
|
65
|
-
|
|
66
|
-
**Schema (v1):**
|
|
67
|
-
|
|
68
|
-
```json
|
|
69
|
-
{
|
|
70
|
-
"$schema": "design-context-v1",
|
|
71
|
-
"createdAt": "ISO-8601",
|
|
72
|
-
"updatedAt": "ISO-8601",
|
|
73
|
-
"audience": {
|
|
74
|
-
"primary": "Description of target users",
|
|
75
|
-
"context": "Usage environment (desktop/mobile/mixed)",
|
|
76
|
-
"expertise": "Technical level (beginner/intermediate/expert)"
|
|
77
|
-
},
|
|
78
|
-
"brand": {
|
|
79
|
-
"personality": ["3-5 adjectives"],
|
|
80
|
-
"tone": "formal | casual | playful | professional (guideline, free text allowed)",
|
|
81
|
-
"existingAssets": "Path to existing brand guidelines (optional)"
|
|
82
|
-
},
|
|
83
|
-
"aesthetic": {
|
|
84
|
-
"style": "minimal | bold | elegant | playful | corporate (guideline, free text allowed)",
|
|
85
|
-
"colorMood": "warm | cool | neutral | vibrant | muted (guideline, free text allowed)",
|
|
86
|
-
"typographyMood": "modern | classic | geometric | humanist (guideline, free text allowed)",
|
|
87
|
-
"references": ["Reference site/app URLs"]
|
|
88
|
-
},
|
|
89
|
-
"constraints": {
|
|
90
|
-
"accessibility": "AA | AAA",
|
|
91
|
-
"performance": "core-web-vitals | balanced | unlimited",
|
|
92
|
-
"browsers": ["chrome", "safari", "firefox", "edge"],
|
|
93
|
-
"devices": ["mobile", "tablet", "desktop"]
|
|
94
|
-
},
|
|
95
|
-
"detectedStack": {
|
|
96
|
-
"framework": "Detected framework",
|
|
97
|
-
"componentLibrary": "Detected component library",
|
|
98
|
-
"styling": "Detected styling approach",
|
|
99
|
-
"fonts": ["Detected fonts"]
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
> **Note**: `tone`, `style`, `colorMood`, `typographyMood` values are suggestions, not closed enums. Users can enter free text.
|
|
105
|
-
|
|
106
|
-
> **Size limit**: design-context.json should not exceed 10KB. The `references` array is capped at 5 items.
|
|
107
|
-
|
|
108
|
-
### Step 4: Rerun Semantics
|
|
109
|
-
|
|
110
|
-
When `/design-teach` is run again and `design-context.json` already exists:
|
|
111
|
-
|
|
112
|
-
1. Read the existing file with the Read tool
|
|
113
|
-
2. **Show existing values as defaults** for each question ("Current: professional, clean — do you want to change this?")
|
|
114
|
-
3. User replies "keep" or leaves blank → that field is preserved
|
|
115
|
-
4. New value entered → only that field is replaced (**field-level replacement, not merge**)
|
|
116
|
-
5. `createdAt` is always preserved; only `updatedAt` is updated to the current time
|
|
117
|
-
|
|
118
|
-
### Step 5: Other Skills Reference This Context
|
|
119
|
-
|
|
120
|
-
Each design-* skill does the following when it runs:
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
1. Read `.vibe/design-context.json`
|
|
124
|
-
2. File not found → print "Run /design-teach first for better results" → continue with defaults
|
|
125
|
-
3. Parse failure (invalid JSON) → warn "design-context.json parse failed" + continue with defaults → recommend re-running /design-teach
|
|
126
|
-
4. Success → apply context to analysis criteria
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Design Workflow Integration
|
|
130
|
-
|
|
131
|
-
Design skills are integrated into 3 phases of the vibe workflow:
|
|
132
|
-
|
|
133
|
-
```
|
|
134
|
-
SPEC Phase:
|
|
135
|
-
① Check design-context.json (recommend /design-teach if missing)
|
|
136
|
-
② design-system-gen (industry analysis → design system → layout)
|
|
137
|
-
|
|
138
|
-
REVIEW Phase:
|
|
139
|
-
③ /design-review audit (technical quality check)
|
|
140
|
-
④ /design-review critique (UX review)
|
|
141
|
-
⑤ design-reviewer (AI slop + anti-pattern detection)
|
|
142
|
-
|
|
143
|
-
PRE-SHIP Phase:
|
|
144
|
-
⑥ /design-refine normalize (design system alignment)
|
|
145
|
-
⑦ /design-refine polish (final pass)
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## How Other Skills Use This
|
|
149
|
-
|
|
150
|
-
| Skill | Context Usage |
|
|
151
|
-
|-------|---------------|
|
|
152
|
-
| `/design-review audit` | Weight findings by audience constraints (a11y level, devices) |
|
|
153
|
-
| `/design-review critique` | Adjust persona priorities by target audience |
|
|
154
|
-
| `/design-refine polish` | Apply brand-appropriate micro-interactions |
|
|
155
|
-
| `/design-refine normalize` | Use detected token system for replacement mapping |
|
|
156
|
-
| `/design-refine distill` | Preserve brand-expressive elements based on personality |
|
|
157
|
-
|
|
158
|
-
## Output Format
|
|
159
|
-
|
|
160
|
-
```markdown
|
|
161
|
-
## Design Context: {project}
|
|
162
|
-
|
|
163
|
-
### Auto-Detected
|
|
164
|
-
- Framework: Next.js 15
|
|
165
|
-
- Styling: Tailwind CSS + shadcn/ui
|
|
166
|
-
- Fonts: Inter (heading), Inter (body)
|
|
167
|
-
- Tokens: 24 CSS variables found
|
|
168
|
-
|
|
169
|
-
### User Provided
|
|
170
|
-
- Audience: B2B SaaS, mixed technical level
|
|
171
|
-
- Brand: Professional, clean (like Linear)
|
|
172
|
-
- Density: Balanced
|
|
173
|
-
- A11y: WCAG AA
|
|
174
|
-
- Dark mode: Required
|
|
175
|
-
|
|
176
|
-
### Saved
|
|
177
|
-
✅ .vibe/design-context.json updated
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
## Important
|
|
181
|
-
|
|
182
|
-
- **Non-destructive**: Only creates/updates the context file. No code changes.
|
|
183
|
-
- **Incremental**: Running `--update` preserves existing answers, only asks about gaps.
|
|
184
|
-
- **Foundation**: Run this first before other design-* skills for best results.
|
|
11
|
+
Load `vibe.design` with `init --from=interview`, preserving update intent and all supplied context.
|
|
@@ -2,12 +2,19 @@
|
|
|
2
2
|
name: vibe.devlog
|
|
3
3
|
invocation: [auto]
|
|
4
4
|
tier: standard
|
|
5
|
-
description: "
|
|
5
|
+
description: "Use when accumulated git commits must be turned into a devlog post or the configured N-commit publication threshold is reached."
|
|
6
6
|
triggers: [devlog, 개발일지, dev log, devlog 작성, 개발일지 작성]
|
|
7
7
|
priority: 60
|
|
8
8
|
---
|
|
9
9
|
# Devlog Auto-Generator
|
|
10
10
|
|
|
11
|
+
## Done Criteria
|
|
12
|
+
|
|
13
|
+
- [ ] 처리한 commit 범위가 산출물에 기록되어 있다.
|
|
14
|
+
- [ ] devlog Markdown이 설정된 대상 경로에 존재한다.
|
|
15
|
+
- [ ] 이미 처리한 commit이 중복 포함되지 않았다.
|
|
16
|
+
- [ ] 설정된 frontmatter 필드가 모두 채워져 있다.
|
|
17
|
+
|
|
11
18
|
Analyzes git commit history to automatically generate development logs and saves them as posts to the configured blog repository.
|
|
12
19
|
|
|
13
20
|
## Config
|
|
@@ -46,9 +53,12 @@ Analyzes git commit history to automatically generate development logs and saves
|
|
|
46
53
|
|
|
47
54
|
## Trigger Modes
|
|
48
55
|
|
|
49
|
-
### 1. Auto (
|
|
56
|
+
### 1. Auto (lifecycle acceleration)
|
|
50
57
|
|
|
51
|
-
|
|
58
|
+
When lifecycle hooks are available, `devlog-gen.js` may check the counter after
|
|
59
|
+
each commit and invoke `llm-orchestrate.js`. Hooks are acceleration only: before
|
|
60
|
+
declaring the devlog workflow complete, explicitly count commits since the last
|
|
61
|
+
devlog and run the same generation step when the count reaches `interval`.
|
|
52
62
|
|
|
53
63
|
### 2. Manual
|
|
54
64
|
|
|
@@ -126,14 +136,7 @@ The number is automatically determined as the last existing file number + 1.
|
|
|
126
136
|
|
|
127
137
|
### Step 5: (Optional) Auto Push
|
|
128
138
|
|
|
129
|
-
If `autoPush: true
|
|
130
|
-
|
|
131
|
-
```bash
|
|
132
|
-
cd {targetRepo}
|
|
133
|
-
git add {targetDir}/{prefix}-{NNNN}.md
|
|
134
|
-
git commit -m "post: Add {prefix} #{NNNN}"
|
|
135
|
-
git push
|
|
136
|
-
```
|
|
139
|
+
If `autoPush: true`, read `references/auto-push.md` and require normal external-state confirmation. Calls with `autoPush: false` do not load it.
|
|
137
140
|
|
|
138
141
|
## Rules
|
|
139
142
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: vibe.docs
|
|
3
|
-
description:
|
|
3
|
+
description: Use when README, guides, architecture, release notes, agent instructions, diagrams, or codemaps must be generated or synchronized with the actual codebase.
|
|
4
4
|
argument-hint: "readme, guide, arch, release, agent, diagram, or codemaps"
|
|
5
5
|
user-invocable: true
|
|
6
6
|
---
|
|
@@ -45,207 +45,21 @@ Generate or update project documentation by analyzing the actual codebase.
|
|
|
45
45
|
|
|
46
46
|
## Subcommands
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
## Subcommands (선택된 하나만 로드)
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
한 번의 호출은 서브커맨드 **하나만** 실행한다. 해당 reference 하나만 읽고 나머지 6개는 읽지 않는다.
|
|
51
51
|
|
|
52
|
-
|
|
53
|
-
2. **Extract key info**: Tech stack, installation, usage, API surface
|
|
54
|
-
3. **Generate sections**:
|
|
55
|
-
|
|
56
|
-
```markdown
|
|
57
|
-
# Project Name
|
|
58
|
-
> One-line description from package.json
|
|
59
|
-
|
|
60
|
-
## What is this?
|
|
61
|
-
[2-3 sentences explaining the problem and solution]
|
|
62
|
-
|
|
63
|
-
## Quick Start
|
|
64
|
-
[Installation + minimal usage example]
|
|
65
|
-
|
|
66
|
-
## Features
|
|
67
|
-
[Auto-detected from codebase — exported functions, CLI commands, API endpoints]
|
|
68
|
-
|
|
69
|
-
## Architecture
|
|
70
|
-
[High-level module diagram if 5+ source directories]
|
|
71
|
-
|
|
72
|
-
## Configuration
|
|
73
|
-
[Detected config files and their purposes]
|
|
74
|
-
|
|
75
|
-
## Development
|
|
76
|
-
[Build, test, lint commands from package.json scripts]
|
|
77
|
-
|
|
78
|
-
## License
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**Analysis approach:**
|
|
82
|
-
```
|
|
83
|
-
Read: package.json → name, description, scripts, dependencies
|
|
84
|
-
Glob: src/**/*.ts → module structure
|
|
85
|
-
Grep: pattern="export (function|class|const)" → public API surface
|
|
86
|
-
Grep: pattern="(app|router)\.(get|post|put|delete)" → API endpoints
|
|
87
|
-
Read: CLAUDE.md → project conventions
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
### `/vibe.docs guide` — User Guide
|
|
91
|
-
|
|
92
|
-
Generate a step-by-step user guide:
|
|
93
|
-
|
|
94
|
-
1. **Installation**: Detect package manager, prerequisites
|
|
95
|
-
2. **Configuration**: Find all config files, document each option
|
|
96
|
-
3. **Usage**: Extract CLI commands or API usage patterns
|
|
97
|
-
4. **FAQ**: Common issues from error handling patterns
|
|
98
|
-
5. **Troubleshooting**: Known edge cases from test files
|
|
99
|
-
|
|
100
|
-
Output: `docs/GUIDE.md`
|
|
101
|
-
|
|
102
|
-
**Analysis approach:**
|
|
103
|
-
```
|
|
104
|
-
Read: package.json → bin, scripts, peerDependencies
|
|
105
|
-
Glob: src/cli/commands/*.ts → CLI command list
|
|
106
|
-
Grep: pattern="throw new|Error\(" → common error scenarios
|
|
107
|
-
Grep: pattern="(process\.env|config)\.\w+" → configuration options
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### `/vibe.docs arch` — Architecture Documentation
|
|
111
|
-
|
|
112
|
-
Generate architecture overview with diagrams:
|
|
113
|
-
|
|
114
|
-
1. **Module map**: Directory structure → responsibility mapping
|
|
115
|
-
2. **Dependency graph**: Import analysis → Mermaid diagram
|
|
116
|
-
3. **Data flow**: Entry points → processing → output
|
|
117
|
-
4. **Key decisions**: Extract from CLAUDE.md and code comments
|
|
118
|
-
|
|
119
|
-
Output: `docs/ARCHITECTURE.md`
|
|
120
|
-
|
|
121
|
-
**Mermaid diagram generation:**
|
|
122
|
-
```
|
|
123
|
-
Glob: src/**/ → module list
|
|
124
|
-
Grep: pattern="^import .+ from" → dependency edges
|
|
125
|
-
Read: CLAUDE.md → architecture notes
|
|
126
|
-
|
|
127
|
-
Generate:
|
|
128
|
-
graph TD
|
|
129
|
-
CLI[CLI Commands] --> Core[Core Logic]
|
|
130
|
-
Core --> Infra[Infrastructure]
|
|
131
|
-
Infra --> DB[(Database)]
|
|
132
|
-
Infra --> API[External APIs]
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### `/vibe.docs agent` — Agent Instruction Files (CLAUDE.md / AGENTS.md)
|
|
136
|
-
|
|
137
|
-
**CLI ↔ file mapping:**
|
|
138
|
-
|
|
139
|
-
| CLI | File | Support |
|
|
52
|
+
| 서브커맨드 | 산출물 | 본문 |
|
|
140
53
|
|---|---|---|
|
|
141
|
-
|
|
|
142
|
-
|
|
|
143
|
-
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
- **`CLAUDE.md` is the content SSOT.** Always edit it first; `AGENTS.md` is a regenerated derivative.
|
|
149
|
-
- Behavioral block: `skills/vibe.docs/templates/behavioral-principles.md` (4 Karpathy principles, wrapped in `<!-- VIBE-BEHAVIORAL:START/END -->` markers).
|
|
150
|
-
|
|
151
|
-
**Procedure (applies to both creation and modification):**
|
|
152
|
-
|
|
153
|
-
1. **Detect state** — check which of `CLAUDE.md` / `AGENTS.md` / `GEMINI.md` exist in project root. **`CLAUDE.md` is always the SSOT**; if missing, create it first (never derive from AGENTS.md).
|
|
154
|
-
2. **For `AGENTS.md`**:
|
|
155
|
-
- **If missing** → create by cloning `CLAUDE.md` + applying CLI substitution (below).
|
|
156
|
-
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
157
|
-
3. **For `GEMINI.md`**:
|
|
158
|
-
- **If missing** → create by cloning `CLAUDE.md` + applying Antigravity substitution.
|
|
159
|
-
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
160
|
-
4. **CLI substitution for `AGENTS.md`** (Codex): `Claude Code` → `Codex` · `~/.claude/` → `~/.codex/` · `.claude/` → `.codex/` · `CLAUDE.md` → `AGENTS.md`. `CLAUDE.md` itself gets no substitution.
|
|
161
|
-
5. **CLI substitution for `GEMINI.md`** (Antigravity): `Claude Code` → `Antigravity CLI` · `~/.claude/` → `~/.gemini/` · `.claude/` → `.gemini/` · `CLAUDE.md` → `GEMINI.md`.
|
|
162
|
-
6. **Validate every touched file (whether newly created or modified)** via the `agents-md` skill — see validation block below. **Never write or save without running this step.**
|
|
163
|
-
7. Report per file: created / updated / skipped / validation warnings.
|
|
54
|
+
| `readme` | README.md | `references/readme.md` |
|
|
55
|
+
| `guide` | 사용자 가이드 | `references/guide.md` |
|
|
56
|
+
| `arch` | 아키텍처 문서 | `references/arch.md` |
|
|
57
|
+
| `agent` | CLAUDE.md / AGENTS.md | `references/agent.md` |
|
|
58
|
+
| `release` | 릴리스 노트 / CHANGELOG | `references/release.md` |
|
|
59
|
+
| `diagram` | 다이어그램 | `references/diagram.md` |
|
|
60
|
+
| `codemaps` | 코드맵 | `references/codemaps.md` |
|
|
164
61
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
**Mandatory validation (every create & every update) — Load skill `vibe.agents-md`:**
|
|
168
|
-
|
|
169
|
-
- Size target 60–150 lines (Optimal). Warn at 200+, force split/trim at 300+.
|
|
170
|
-
- 4-question check per line (outside `VIBE-BEHAVIORAL` block):
|
|
171
|
-
- Would the agent make a mistake without this? (No → delete)
|
|
172
|
-
- Needed every session? (No → move to SPEC/plan)
|
|
173
|
-
- Can a linter/hook replace it? (Yes → move)
|
|
174
|
-
- Discoverable from code? (Yes → delete)
|
|
175
|
-
- Lost-in-the-Middle: critical rules at top, frequently-violated rules at bottom.
|
|
176
|
-
- Addy Osmani test: "Can the agent discover this by reading the code?" → Yes = delete.
|
|
177
|
-
- Strip tech-stack name-drops already stated in `package.json`.
|
|
178
|
-
|
|
179
|
-
Report line ranges to trim per file. Do not auto-delete; surface findings for user approval before finalizing.
|
|
180
|
-
|
|
181
|
-
**When to run:**
|
|
182
|
-
- After `vibe init` / `vibe update` if `CLAUDE.md` or `AGENTS.md` is missing or out of sync.
|
|
183
|
-
- After upgrading `@su-record/vibe` when the behavioral template changes.
|
|
184
|
-
- Whenever the SSOT file is edited — re-sync `AGENTS.md`.
|
|
185
|
-
- User explicitly asks to refresh agent instructions.
|
|
186
|
-
|
|
187
|
-
### `/vibe.docs release` — Release Notes
|
|
188
|
-
|
|
189
|
-
Generate release notes from git history:
|
|
190
|
-
|
|
191
|
-
1. **Collect**: `git log` since last tag
|
|
192
|
-
2. **Classify**: feat/fix/refactor/docs/chore from commit messages
|
|
193
|
-
3. **Group**: By category with breaking changes highlighted
|
|
194
|
-
4. **Format**: Semantic versioning suggestion
|
|
195
|
-
|
|
196
|
-
Output: `RELEASE_NOTES.md` or append to `CHANGELOG.md`
|
|
197
|
-
|
|
198
|
-
**Output format:**
|
|
199
|
-
```markdown
|
|
200
|
-
## [x.y.z] - YYYY-MM-DD
|
|
201
|
-
|
|
202
|
-
### Breaking Changes
|
|
203
|
-
- ...
|
|
204
|
-
|
|
205
|
-
### Features
|
|
206
|
-
- feat: description (#PR)
|
|
207
|
-
|
|
208
|
-
### Bug Fixes
|
|
209
|
-
- fix: description (#PR)
|
|
210
|
-
|
|
211
|
-
### Other
|
|
212
|
-
- refactor/docs/chore items
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### `/vibe.docs diagram` — Diagram Generation
|
|
216
|
-
|
|
217
|
-
Generate Mermaid diagrams for architecture, ERD, flowchart, or sequence
|
|
218
|
-
visualization directly (native capability — no dedicated agent). Ground the
|
|
219
|
-
diagram in sources first: folder structure and imports for architecture;
|
|
220
|
-
`models/`, `migrations/`, `schema.*`, ORM definitions for ERDs; the real
|
|
221
|
-
branch/return structure of the code for flowcharts.
|
|
222
|
-
|
|
223
|
-
**Options:**
|
|
224
|
-
- `/vibe.docs diagram` (default): Architecture overview
|
|
225
|
-
- `/vibe.docs diagram --er`: Entity-Relationship Diagram
|
|
226
|
-
- `/vibe.docs diagram --flow`: Flowchart
|
|
227
|
-
- `/vibe.docs diagram --seq`: Sequence Diagram
|
|
228
|
-
|
|
229
|
-
> Read `references/diagram-spec.md` for the full output conventions (Mermaid syntax per diagram type, save location, accuracy constraints).
|
|
230
|
-
|
|
231
|
-
**Example:**
|
|
232
|
-
```
|
|
233
|
-
/vibe.docs diagram --er
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
### `/vibe.docs codemaps` — Codemaps Generation
|
|
237
|
-
|
|
238
|
-
Generate auto-documentation from codebase structure directly (native
|
|
239
|
-
capability — no dedicated agent).
|
|
240
|
-
|
|
241
|
-
**Output Location:** `docs/CODEMAPS/`
|
|
242
|
-
|
|
243
|
-
> Read `references/codemaps-output.md` for the full generated-files tree, per-file contents, and tools used.
|
|
244
|
-
|
|
245
|
-
**Example:**
|
|
246
|
-
```
|
|
247
|
-
/vibe.docs codemaps
|
|
248
|
-
```
|
|
62
|
+
서브커맨드 없이 호출되면 무엇을 생성할지 사용자에게 묻는다 — 전부 생성하지 않는다.
|
|
249
63
|
|
|
250
64
|
## Pipeline Integration
|
|
251
65
|
|
|
@@ -290,3 +104,18 @@ Before finalizing any document:
|
|
|
290
104
|
- [ ] Links and paths are valid
|
|
291
105
|
- [ ] No placeholder text remaining
|
|
292
106
|
- [ ] Consistent with project language (Korean/English)
|
|
107
|
+
|
|
108
|
+
## Done Criteria
|
|
109
|
+
|
|
110
|
+
- [ ] The requested document exists at its specified path.
|
|
111
|
+
- [ ] Example commands, paths, and identifiers match the repository.
|
|
112
|
+
- [ ] No placeholder or unverified feature claim remains.
|
|
113
|
+
- [ ] Internal links and file paths resolve to real targets.
|
|
114
|
+
- [ ] The document preserves the project's existing language.
|
|
115
|
+
|
|
116
|
+
## 체인 의존 (reference 안에서 호출되는 스킬)
|
|
117
|
+
|
|
118
|
+
reference 로 내려간 절차가 다른 스킬을 체인 호출한다. **설치 무결성 검사가 추적할 수 있도록 여기에 선언한다** —
|
|
119
|
+
선언이 없으면 그 스킬이 미설치여도 아무도 잡지 못한다.
|
|
120
|
+
|
|
121
|
+
- Load skill `vibe.agents-md` — `references/agent.md` 단계에서 호출
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# /vibe.docs agent — Agent Instruction Files (CLAUDE.md / AGENTS.md)
|
|
2
|
+
|
|
3
|
+
> vibe.docs SKILL.md 의 서브커맨드 표에서 **`agent` 가 선택됐을 때만** 로드한다.
|
|
4
|
+
|
|
5
|
+
### `/vibe.docs agent` — Agent Instruction Files (CLAUDE.md / AGENTS.md)
|
|
6
|
+
|
|
7
|
+
**CLI ↔ file mapping:**
|
|
8
|
+
|
|
9
|
+
| CLI | File | Support |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| Claude Code | `CLAUDE.md` | 100% (Primary) |
|
|
12
|
+
| Codex | `AGENTS.md` | 100% (Primary) |
|
|
13
|
+
| Antigravity CLI | `GEMINI.md` | 100% |
|
|
14
|
+
|
|
15
|
+
Cursor is not supported — do not generate or check Cursor-specific context files.
|
|
16
|
+
|
|
17
|
+
**Source of truth:**
|
|
18
|
+
- **`CLAUDE.md` is the content SSOT.** Always edit it first; `AGENTS.md` is a regenerated derivative.
|
|
19
|
+
- Behavioral block: `skills/vibe.docs/templates/behavioral-principles.md` (4 Karpathy principles, wrapped in `<!-- VIBE-BEHAVIORAL:START/END -->` markers).
|
|
20
|
+
|
|
21
|
+
**Procedure (applies to both creation and modification):**
|
|
22
|
+
|
|
23
|
+
1. **Detect state** — check which of `CLAUDE.md` / `AGENTS.md` / `GEMINI.md` exist in project root. **`CLAUDE.md` is always the SSOT**; if missing, create it first (never derive from AGENTS.md).
|
|
24
|
+
2. **For `AGENTS.md`**:
|
|
25
|
+
- **If missing** → create by cloning `CLAUDE.md` + applying CLI substitution (below).
|
|
26
|
+
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
27
|
+
3. **For `GEMINI.md`**:
|
|
28
|
+
- **If missing** → create by cloning `CLAUDE.md` + applying Antigravity substitution.
|
|
29
|
+
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
30
|
+
4. **CLI substitution for `AGENTS.md`** (Codex): `Claude Code` → `Codex` · `~/.claude/` → `~/.codex/` · `.claude/` → `.codex/` · `CLAUDE.md` → `AGENTS.md`. `CLAUDE.md` itself gets no substitution.
|
|
31
|
+
5. **CLI substitution for `GEMINI.md`** (Antigravity): `Claude Code` → `Antigravity CLI` · `~/.claude/` → `~/.gemini/` · `.claude/` → `.gemini/` · `CLAUDE.md` → `GEMINI.md`.
|
|
32
|
+
6. **Validate every touched file (whether newly created or modified)** via the `agents-md` skill — see validation block below. **Never write or save without running this step.**
|
|
33
|
+
7. Report per file: created / updated / skipped / validation warnings.
|
|
34
|
+
|
|
35
|
+
**Idempotent:** Re-running re-syncs the behavioral block and re-applies substitutions without duplication.
|
|
36
|
+
|
|
37
|
+
**Mandatory validation (every create & every update) — Load skill `vibe.agents-md`:**
|
|
38
|
+
|
|
39
|
+
- Size target 60–150 lines (Optimal). Warn at 200+, force split/trim at 300+.
|
|
40
|
+
- 4-question check per line (outside `VIBE-BEHAVIORAL` block):
|
|
41
|
+
- Would the agent make a mistake without this? (No → delete)
|
|
42
|
+
- Needed every session? (No → move to SPEC/plan)
|
|
43
|
+
- Can a linter/hook replace it? (Yes → move)
|
|
44
|
+
- Discoverable from code? (Yes → delete)
|
|
45
|
+
- Lost-in-the-Middle: critical rules at top, frequently-violated rules at bottom.
|
|
46
|
+
- Addy Osmani test: "Can the agent discover this by reading the code?" → Yes = delete.
|
|
47
|
+
- Strip tech-stack name-drops already stated in `package.json`.
|
|
48
|
+
|
|
49
|
+
Report line ranges to trim per file. Do not auto-delete; surface findings for user approval before finalizing.
|
|
50
|
+
|
|
51
|
+
**When to run:**
|
|
52
|
+
- After `vibe init` / `vibe update` if `CLAUDE.md` or `AGENTS.md` is missing or out of sync.
|
|
53
|
+
- After upgrading `@su-record/vibe` when the behavioral template changes.
|
|
54
|
+
- Whenever the SSOT file is edited — re-sync `AGENTS.md`.
|
|
55
|
+
- User explicitly asks to refresh agent instructions.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# /vibe.docs arch — Architecture Documentation
|
|
2
|
+
|
|
3
|
+
> vibe.docs SKILL.md 의 서브커맨드 표에서 **`arch` 가 선택됐을 때만** 로드한다.
|
|
4
|
+
|
|
5
|
+
### `/vibe.docs arch` — Architecture Documentation
|
|
6
|
+
|
|
7
|
+
Generate architecture overview with diagrams:
|
|
8
|
+
|
|
9
|
+
1. **Module map**: Directory structure → responsibility mapping
|
|
10
|
+
2. **Dependency graph**: Import analysis → Mermaid diagram
|
|
11
|
+
3. **Data flow**: Entry points → processing → output
|
|
12
|
+
4. **Key decisions**: Extract from CLAUDE.md and code comments
|
|
13
|
+
|
|
14
|
+
Output: `docs/ARCHITECTURE.md`
|
|
15
|
+
|
|
16
|
+
**Mermaid diagram generation:**
|
|
17
|
+
```
|
|
18
|
+
File-pattern search: src/**/ → module list
|
|
19
|
+
Text search: pattern="^import .+ from" → dependency edges
|
|
20
|
+
Full-file reading: CLAUDE.md → architecture notes
|
|
21
|
+
|
|
22
|
+
Generate:
|
|
23
|
+
graph TD
|
|
24
|
+
CLI[CLI Commands] --> Core[Core Logic]
|
|
25
|
+
Core --> Infra[Infrastructure]
|
|
26
|
+
Infra --> DB[(Database)]
|
|
27
|
+
Infra --> API[External APIs]
|
|
28
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# /vibe.docs codemaps — Codemaps Generation
|
|
2
|
+
|
|
3
|
+
> vibe.docs SKILL.md 의 서브커맨드 표에서 **`codemaps` 가 선택됐을 때만** 로드한다.
|
|
4
|
+
|
|
5
|
+
### `/vibe.docs codemaps` — Codemaps Generation
|
|
6
|
+
|
|
7
|
+
Generate auto-documentation from codebase structure directly (native
|
|
8
|
+
capability — no dedicated agent).
|
|
9
|
+
|
|
10
|
+
**Output Location:** `docs/CODEMAPS/`
|
|
11
|
+
|
|
12
|
+
> Read `references/codemaps-output.md` for the full generated-files tree, per-file contents, and tools used.
|
|
13
|
+
|
|
14
|
+
**Example:**
|
|
15
|
+
```
|
|
16
|
+
/vibe.docs codemaps
|
|
17
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# /vibe.docs diagram — Diagram Generation
|
|
2
|
+
|
|
3
|
+
> vibe.docs SKILL.md 의 서브커맨드 표에서 **`diagram` 가 선택됐을 때만** 로드한다.
|
|
4
|
+
|
|
5
|
+
### `/vibe.docs diagram` — Diagram Generation
|
|
6
|
+
|
|
7
|
+
Generate Mermaid diagrams for architecture, ERD, flowchart, or sequence
|
|
8
|
+
visualization directly (native capability — no dedicated agent). Ground the
|
|
9
|
+
diagram in sources first: folder structure and imports for architecture;
|
|
10
|
+
`models/`, `migrations/`, `schema.*`, ORM definitions for ERDs; the real
|
|
11
|
+
branch/return structure of the code for flowcharts.
|
|
12
|
+
|
|
13
|
+
**Options:**
|
|
14
|
+
- `/vibe.docs diagram` (default): Architecture overview
|
|
15
|
+
- `/vibe.docs diagram --er`: Entity-Relationship Diagram
|
|
16
|
+
- `/vibe.docs diagram --flow`: Flowchart
|
|
17
|
+
- `/vibe.docs diagram --seq`: Sequence Diagram
|
|
18
|
+
|
|
19
|
+
> Read `references/diagram-spec.md` for the full output conventions (Mermaid syntax per diagram type, save location, accuracy constraints).
|
|
20
|
+
|
|
21
|
+
**Example:**
|
|
22
|
+
```
|
|
23
|
+
/vibe.docs diagram --er
|
|
24
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# /vibe.docs guide — User Guide
|
|
2
|
+
|
|
3
|
+
> vibe.docs SKILL.md 의 서브커맨드 표에서 **`guide` 가 선택됐을 때만** 로드한다.
|
|
4
|
+
|
|
5
|
+
### `/vibe.docs guide` — User Guide
|
|
6
|
+
|
|
7
|
+
Generate a step-by-step user guide:
|
|
8
|
+
|
|
9
|
+
1. **Installation**: Detect package manager, prerequisites
|
|
10
|
+
2. **Configuration**: Find all config files, document each option
|
|
11
|
+
3. **Usage**: Extract CLI commands or API usage patterns
|
|
12
|
+
4. **FAQ**: Common issues from error handling patterns
|
|
13
|
+
5. **Troubleshooting**: Known edge cases from test files
|
|
14
|
+
|
|
15
|
+
Output: `docs/GUIDE.md`
|
|
16
|
+
|
|
17
|
+
**Analysis approach:**
|
|
18
|
+
```
|
|
19
|
+
Full-file reading: package.json → bin, scripts, peerDependencies
|
|
20
|
+
File-pattern search: src/cli/commands/*.ts → CLI command list
|
|
21
|
+
Text search: pattern="throw new|Error\(" → common error scenarios
|
|
22
|
+
Text search: pattern="(process\.env|config)\.\w+" → configuration options
|
|
23
|
+
```
|