@su-record/vibe 2.9.16 → 2.9.17
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/CLAUDE.md +3 -4
- package/commands/vibe.docs.md +1 -1
- package/package.json +1 -1
- package/skills/vibe-docs/SKILL.md +9 -20
package/CLAUDE.md
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
# VIBE
|
|
2
2
|
|
|
3
|
-
> Source code for `@su-record/vibe` npm package. Modify files in THIS repository only — never the installed copies (`~/.claude/`, `~/.
|
|
3
|
+
> Source code for `@su-record/vibe` npm package. Modify files in THIS repository only — never the installed copies (`~/.claude/`, `~/.coco/`, `~/.vibe/`).
|
|
4
4
|
>
|
|
5
5
|
> **File-to-CLI mapping:**
|
|
6
6
|
> - `CLAUDE.md` — **Claude Code** (100% supported) · **content SSOT**
|
|
7
|
-
> - `AGENTS.md` — **coco** (100% supported
|
|
8
|
-
> - `GEMINI.md` — Gemini CLI (best-effort)
|
|
7
|
+
> - `AGENTS.md` — **coco** (100% supported)
|
|
9
8
|
>
|
|
10
|
-
> `AGENTS.md`
|
|
9
|
+
> `AGENTS.md` is regenerated from this file via `/vibe.docs agent`. Edit here first.
|
|
11
10
|
|
|
12
11
|
## Hard Rules
|
|
13
12
|
|
package/commands/vibe.docs.md
CHANGED
|
@@ -14,7 +14,7 @@ Generate or update project documentation by analyzing the actual codebase.
|
|
|
14
14
|
/vibe.docs guide # 사용자 가이드 (docs/GUIDE.md)
|
|
15
15
|
/vibe.docs arch # 아키텍처 문서 + Mermaid 다이어그램 (docs/ARCHITECTURE.md)
|
|
16
16
|
/vibe.docs release # 릴리즈 노트 (git history 기반)
|
|
17
|
-
/vibe.docs agent # CLAUDE.md / AGENTS.md
|
|
17
|
+
/vibe.docs agent # CLAUDE.md / AGENTS.md 생성·동기화 (claude-md-guide + agents-md 검증 필수)
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
## Pipeline Position
|
package/package.json
CHANGED
|
@@ -99,7 +99,7 @@ graph TD
|
|
|
99
99
|
Infra --> API[External APIs]
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
### `/vibe.docs agent` — Agent Instruction Files (CLAUDE.md / AGENTS.md
|
|
102
|
+
### `/vibe.docs agent` — Agent Instruction Files (CLAUDE.md / AGENTS.md)
|
|
103
103
|
|
|
104
104
|
**CLI ↔ file mapping:**
|
|
105
105
|
|
|
@@ -107,31 +107,20 @@ graph TD
|
|
|
107
107
|
|---|---|---|
|
|
108
108
|
| Claude Code | `CLAUDE.md` | 100% (Primary) |
|
|
109
109
|
| coco | `AGENTS.md` | 100% (Primary) |
|
|
110
|
-
| Codex CLI | `AGENTS.md` (shared with coco) | Best-effort |
|
|
111
|
-
| Gemini CLI | `GEMINI.md` | Best-effort |
|
|
112
|
-
| Cursor | (none yet) | Best-effort |
|
|
113
110
|
|
|
114
|
-
|
|
111
|
+
Gemini CLI / Codex CLI / Cursor are not supported — do not generate or check `GEMINI.md`.
|
|
115
112
|
|
|
116
113
|
**Source of truth:**
|
|
117
|
-
- **`CLAUDE.md` is the content SSOT.** Always edit it first; `AGENTS.md`
|
|
114
|
+
- **`CLAUDE.md` is the content SSOT.** Always edit it first; `AGENTS.md` is a regenerated derivative.
|
|
118
115
|
- Behavioral block: `skills/vibe-docs/templates/behavioral-principles.md` (4 Karpathy principles, wrapped in `<!-- VIBE-BEHAVIORAL:START/END -->` markers).
|
|
119
116
|
|
|
120
117
|
**Procedure (applies to both creation and modification):**
|
|
121
118
|
|
|
122
|
-
1. **Detect state** —
|
|
123
|
-
2. **
|
|
119
|
+
1. **Detect state** — check which of `CLAUDE.md` / `AGENTS.md` exist in project root. **`CLAUDE.md` is always the SSOT**; if missing, create it first (never derive from AGENTS.md).
|
|
120
|
+
2. **For `AGENTS.md`**:
|
|
124
121
|
- **If missing** → create by cloning `CLAUDE.md` + applying CLI substitution (below).
|
|
125
122
|
- **If exists** → regenerate from current `CLAUDE.md` + substitution, preserving user-specific additions outside the VIBE block.
|
|
126
|
-
|
|
127
|
-
3. **CLI substitution (apply to derived copies, not the SSOT)**:
|
|
128
|
-
|
|
129
|
-
| Target | Swap |
|
|
130
|
-
|---|---|
|
|
131
|
-
| `AGENTS.md` (Codex) | `Claude Code` → `Codex CLI` · `~/.claude/` → `~/.codex/` · `.claude/` → `.codex/` · `CLAUDE.md` → `AGENTS.md` |
|
|
132
|
-
| `GEMINI.md` (Gemini) | `Claude Code` → `Gemini CLI` · `~/.claude/` → `~/.gemini/` · `.claude/` → `.gemini/` · `CLAUDE.md` → `GEMINI.md` · `PreToolUse`→`BeforeTool` · `PostToolUse`→`AfterTool` · `UserPromptSubmit`→`BeforeAgent` |
|
|
133
|
-
| `CLAUDE.md` | no substitution |
|
|
134
|
-
|
|
123
|
+
3. **CLI substitution for `AGENTS.md`** (coco): `Claude Code` → `coco` · `~/.claude/` → `~/.coco/` · `.claude/` → `.coco/` · `CLAUDE.md` → `AGENTS.md`. `CLAUDE.md` itself gets no substitution.
|
|
135
124
|
4. **Validate every touched file (whether newly created or modified)** via the `claude-md-guide` → `agents-md` skill chain — see validation block below. **Never write or save without running this step.**
|
|
136
125
|
5. Report per file: created / updated / skipped / validation warnings.
|
|
137
126
|
|
|
@@ -154,9 +143,9 @@ Note: `AGENTS.md` is coco's **primary** file AND Codex's compat file — treat e
|
|
|
154
143
|
Report line ranges to trim per file. Do not auto-delete; surface findings for user approval before finalizing.
|
|
155
144
|
|
|
156
145
|
**When to run:**
|
|
157
|
-
- After `vibe init` / `vibe update` if
|
|
146
|
+
- After `vibe init` / `vibe update` if `CLAUDE.md` or `AGENTS.md` is missing or out of sync.
|
|
158
147
|
- After upgrading `@su-record/vibe` when the behavioral template changes.
|
|
159
|
-
- Whenever the SSOT file is edited — re-sync
|
|
148
|
+
- Whenever the SSOT file is edited — re-sync `AGENTS.md`.
|
|
160
149
|
- User explicitly asks to refresh agent instructions.
|
|
161
150
|
|
|
162
151
|
### `/vibe.docs release` — Release Notes
|
|
@@ -213,7 +202,7 @@ When `/vibe.trace` completes with all scenarios passing, suggest:
|
|
|
213
202
|
- Use changelog-writer agent for `/vibe.docs release`
|
|
214
203
|
- Use api-documenter agent for API-heavy projects
|
|
215
204
|
- Use diagrammer agent for `/vibe.docs arch` Mermaid generation
|
|
216
|
-
- Use `claude-md-guide` → `agents-md` chain for `/vibe.docs agent` — applies equally to CLAUDE.md
|
|
205
|
+
- Use `claude-md-guide` → `agents-md` chain for `/vibe.docs agent` — applies equally to CLAUDE.md and AGENTS.md
|
|
217
206
|
|
|
218
207
|
### DON'T
|
|
219
208
|
- Don't generate placeholder text ("Lorem ipsum", "TODO: fill in")
|