create-harness-vibe-coding 0.1.2 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +169 -0
  2. package/package.json +2 -3
package/README.md ADDED
@@ -0,0 +1,169 @@
1
+ <p align="center">
2
+ <img src="https://img.shields.io/npm/v/create-harness-vibe-coding?color=blue" alt="npm version">
3
+ <img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="node">
4
+ <img src="https://img.shields.io/npm/l/create-harness-vibe-coding" alt="license">
5
+ <img src="https://img.shields.io/github/stars/zingspark/create-harness-vibe-coding?style=social" alt="stars">
6
+ </p>
7
+
8
+ <h1 align="center">⚡ create-harness-vibe-coding</h1>
9
+ <p align="center">
10
+ <b>4 seconds from zero to a production-grade agentic harness.</b><br>
11
+ <sub>CLAUDE.md → docs/ → .claude/ → tests/ — ECC-ready, Superpowers-compatible.</sub>
12
+ </p>
13
+
14
+ ---
15
+
16
+ ## 🎯 One Command
17
+
18
+ ```bash
19
+ npx create-harness-vibe-coding@latest my-project
20
+ ```
21
+
22
+ | What You Get | Count |
23
+ |-------------|-------|
24
+ | Architecture docs (layers, data flow, state machines, port contracts) | 9 docs |
25
+ | Agent definitions (code-reviewer, risk-auditor, etc.) | ECC-ready skeleton |
26
+ | Workflow skills (TDD, backtest, data pipeline) | ECC-ready skeleton |
27
+ | Coding rules (universal + language-specific) | common.md included |
28
+ | Settings & hooks (permissions, automation) | pre-configured |
29
+ | **Total files provisioned** | **17 docs + configs** |
30
+
31
+ ---
32
+
33
+ ## 🚀 Why This Exists
34
+
35
+ Every Claude Code project has the same cold-start problem:
36
+
37
+ | Without Harness | With `create-harness-vibe-coding` |
38
+ |---|---|
39
+ | ❌ Agents skip docs, hallucinate behavior | ✅ CLAUDE.md routes agents to exact docs by role |
40
+ | ❌ No TDD enforcement — agents ship untested code | ✅ agent-workflow.md enforces RED-GREEN-REFACTOR |
41
+ | ❌ Architecture boundaries blur over time | ✅ domain/ports.md locks layer contracts |
42
+ | ❌ State machines live in someone's head | ✅ state-machines.md documents every transition |
43
+ | ❌ Cross-session memory lost | ✅ MEMORY.md + self-learning system |
44
+ | ❌ 2+ hours to set up project structure | ✅ **4 seconds** |
45
+
46
+ ---
47
+
48
+ ## 🧠 How It Works
49
+
50
+ ```mermaid
51
+ graph LR
52
+ A[npx scaffold] --> B[CLAUDE.md + docs/ + .claude/]
53
+ B --> C[Start Claude Code]
54
+ C --> D[Claude reads SETUP.md]
55
+ D --> E[Pulls agents/skills/rules from ECC]
56
+ E --> F[Project ready — TDD loop active]
57
+ ```
58
+
59
+ ### What happens after `npx`:
60
+
61
+ 1. **CLAUDE.md** — Agent reads this first. Role-based routing table sends each agent to the right docs.
62
+ 2. **docs/architecture.md** — Clean architecture layers. Harness runs the shell; domain defines the business.
63
+ 3. **docs/agent-workflow.md** — TDD loop, subagent roles, write set rules, conflict resolution.
64
+ 4. **docs/data-flow.md** — Every event's normal path + failure branches — the #1 doc AI fabricates without.
65
+ 5. **docs/state-machines.md** — Every stateful component. Transition table. Illegal transitions explicitly denied.
66
+ 6. **.claude/settings.json** — Permissions pre-configured (allow git/npm/pytest, deny rm/sudo/curl). Hooks ready.
67
+ 7. **SETUP.md** — Temporary guide. Claude reads it, pulls agents/skills/rules from [ECC](https://github.com/affaan-m/ECC). User deletes it after.
68
+
69
+ ---
70
+
71
+ ## 📦 What's Inside
72
+
73
+ ```
74
+ my-project/
75
+ ├── CLAUDE.md ← Role-based doc navigation + memory/self-learning
76
+ ├── AGENTS.md ← Coding agent entry
77
+ ├── MEMORY.md ← Cross-session resource index
78
+ ├── SETUP.md ← Temporary init guide (delete after setup)
79
+ ├── .gitignore
80
+ ├── docs/
81
+ │ ├── README.md ← Project doc entry point
82
+ │ ├── harness/
83
+ │ │ ├── architecture.md ← Layer rules, components, ADRs
84
+ │ │ ├── agent-workflow.md ← TDD loop, subagent roles, write sets
85
+ │ │ ├── data-flow.md ← Event lifecycle: normal + failure paths
86
+ │ │ └── state-machines.md ← State enums, transition tables, guards
87
+ │ ├── domain/
88
+ │ │ └── ports.md ← Port contracts: pre/postconditions, errors
89
+ │ ├── features/
90
+ │ │ └── _template.md ← Kiro-lite feature doc template
91
+ │ └── research/
92
+ │ ├── PRD.md ← MVP scope & acceptance template
93
+ │ └── scaffolds.md ← Tech research & decision record
94
+ ├── .claude/
95
+ │ ├── settings.json ← Permissions + hooks
96
+ │ ├── agents/ ← Pull from ECC
97
+ │ ├── skills/ ← Pull from ECC
98
+ │ ├── hooks/ ← Configure as needed
99
+ │ └── rules/ecc/
100
+ │ └── common.md ← Universal coding rules (always active)
101
+ └── tests/ ← Your test suite goes here
102
+ ```
103
+
104
+ ---
105
+
106
+ ## 🌐 Ecosystem Compatibility
107
+
108
+ | Platform | Status |
109
+ |----------|--------|
110
+ | [ECC](https://github.com/affaan-m/ECC) (206K+ ★) | ✅ Agents, skills, rules auto-pull |
111
+ | [Superpowers](https://github.com/obra/superpowers) (185K+ ★) | ✅ `/plugin install superpowers` |
112
+ | [awesome-claude-code-config](https://github.com/Mizoreww/awesome-claude-code-config) | ✅ Rules & self-learning configs |
113
+ | [claude-toolbox](https://github.com/serpro69/claude-toolbox) | ✅ Multi-language skills |
114
+ | Claude Code | ✅ Native settings.json + hooks |
115
+ | Codex / Cursor / Gemini CLI | ✅ Compatible (docs-only pattern) |
116
+
117
+ ---
118
+
119
+ ## 🔧 Usage
120
+
121
+ ```bash
122
+ # Interactive mode
123
+ npx create-harness-vibe-coding@latest
124
+
125
+ # Non-interactive (CI/CD)
126
+ npx create-harness-vibe-coding@latest my-app ./dist/my-app
127
+
128
+ # Always get the latest version
129
+ npx create-harness-vibe-coding@latest my-project
130
+ ```
131
+
132
+ ### After scaffolding, tell Claude:
133
+
134
+ ```
135
+ "Read SETUP.md. This is a Python quant project. Pull agents, skills, and rules from ECC."
136
+ "Read SETUP.md. This is a React TypeScript app. I need TDD workflow and code review."
137
+ "Read SETUP.md. This is a Go microservice. Set up matching agents and testing skills."
138
+ ```
139
+
140
+ ---
141
+
142
+ ## 📊 Performance
143
+
144
+ | Metric | Value |
145
+ |--------|-------|
146
+ | Cold install + scaffold | < 4s |
147
+ | Package size | 19.9 kB |
148
+ | Unpacked | 49.4 kB |
149
+ | Dependencies | 2 (@clack/prompts, picocolors) |
150
+ | Node requirement | ≥ 18 |
151
+ | Zero runtime deps after scaffold | ✅ |
152
+
153
+ ---
154
+
155
+ ## 👥 Contributing
156
+
157
+ PRs welcome. The template docs live in `templates/common/` — edit them to change what gets scaffolded.
158
+
159
+ ---
160
+
161
+ ## 📄 License
162
+
163
+ MIT © [zingspark](https://github.com/zingspark)
164
+
165
+ ---
166
+
167
+ <p align="center">
168
+ <sub>Built for the vibe-coding era. Scaffold fast, build faster.</sub>
169
+ </p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-harness-vibe-coding",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "description": "Scaffold a vibe-coding agentic harness — CLAUDE.md, docs/, .claude skeleton ready for ECC agents/skills/rules",
5
5
  "type": "module",
6
6
  "bin": {
@@ -23,8 +23,7 @@
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
26
- "url": "https://github.com/LiWeny16/q-profit.git",
27
- "directory": "create-harness-vibe-coding"
26
+ "url": "https://github.com/zingspark/create-harness-vibe-coding.git"
28
27
  },
29
28
  "keywords": [
30
29
  "claude-code",