@itz4blitz/agentful 0.1.0 → 0.1.4

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.
@@ -0,0 +1,329 @@
1
+ ---
2
+ name: agentful
3
+ description: Quick reference for agentful autonomous development kit
4
+ ---
5
+
6
+ # agentful
7
+
8
+ Autonomous product development with Claude Code.
9
+
10
+ ## What It Does
11
+
12
+ agentful transforms product specifications into working software by:
13
+
14
+ 1. **Understanding your stack** - Auto-detects languages, frameworks, patterns
15
+ 2. **Planning the work** - Organizes features into domains and priorities
16
+ 3. **Building autonomously** - Specialized agents implement, test, validate
17
+ 4. **Ensuring quality** - Automatic code review, testing, security checks
18
+ 5. **Tracking progress** - Real-time completion metrics and state
19
+
20
+ **Result**: Ship features faster with consistent quality.
21
+
22
+ ## Quick Start
23
+
24
+ ```bash
25
+ # Install in your project
26
+ npx @itz4blitz/agentful init
27
+
28
+ # Start autonomous development
29
+ /agentful-start
30
+
31
+ # Monitor progress
32
+ /agentful-status
33
+ ```
34
+
35
+ ## Commands
36
+
37
+ | Command | What It Does |
38
+ |---------|--------------|
39
+ | `/agentful-start` | Start autonomous development loop |
40
+ | `/agentful-status` | Show completion percentage, current work |
41
+ | `/agentful-validate` | Run quality gates (tests, lint, security) |
42
+ | `/agentful-decide` | Answer blocking decisions |
43
+ | `/agentful` | Show this reference |
44
+
45
+ ## How It Works
46
+
47
+ ### 1. Define Your Product
48
+
49
+ Create a product specification (choose one):
50
+
51
+ **Flat structure** (simple projects):
52
+ ```markdown
53
+ # PRODUCT.md
54
+
55
+ ## Features
56
+
57
+ - [CRITICAL] User authentication (login, register, password reset)
58
+ - [HIGH] User profiles (edit, avatar, preferences)
59
+ - [MEDIUM] Dashboard (analytics, activity feed)
60
+ ```
61
+
62
+ **Hierarchical structure** (complex projects):
63
+ ```
64
+ .claude/product/
65
+ ├── index.md # Product overview
66
+ └── domains/
67
+ ├── authentication/ # Auth domain
68
+ │ ├── index.md # Domain overview
69
+ │ └── features/
70
+ │ ├── login.md
71
+ │ ├── register.md
72
+ │ └── password-reset.md
73
+ ├── user-management/ # User domain
74
+ │ ├── index.md
75
+ │ └── features/
76
+ │ ├── profile.md
77
+ │ └── settings.md
78
+ └── dashboard/ # Dashboard domain
79
+ └── features/
80
+ ├── analytics.md
81
+ └── reports.md
82
+ ```
83
+
84
+ ### 2. Start Development
85
+
86
+ ```
87
+ /agentful-start
88
+ ```
89
+
90
+ **What happens:**
91
+ - Orchestrator reads product spec
92
+ - Detects your tech stack (language, framework, patterns)
93
+ - Generates specialized agents matching your conventions
94
+ - Picks highest-priority incomplete feature
95
+ - Delegates to appropriate specialist agents
96
+ - Validates quality gates
97
+ - Updates completion status
98
+ - Repeats until 100% complete
99
+
100
+ ### 3. Monitor Progress
101
+
102
+ ```
103
+ /agentful-status
104
+ ```
105
+
106
+ **Example output:**
107
+ ```
108
+ Overall Progress: 47% (6/13 features complete)
109
+
110
+ ┌─ Authentication Domain ──────────────────── 100% ✓
111
+ │ ✓ Login feature
112
+ │ ✓ Register feature
113
+ │ ✓ Password reset feature
114
+
115
+ ├─ User Management Domain ─────────────────── 60% │
116
+ │ ✓ Profile feature
117
+ │ ⟳ Settings feature (backend complete, frontend pending)
118
+
119
+ └─ Dashboard Domain ───────────────────────── 0% ○
120
+ ○ Analytics feature (not started)
121
+ ○ Reports feature (not started)
122
+
123
+ Quality Gates:
124
+ ✅ Tests passing (47/47)
125
+ ✅ No type errors
126
+ ⚠️ Coverage at 78% (need 80%)
127
+ ✅ No security issues
128
+ ```
129
+
130
+ ## Agent System
131
+
132
+ ### Orchestrator
133
+ **Role**: Coordinates all development work
134
+ - Classifies work type (feature, bugfix, refactor, maintenance)
135
+ - Routes to appropriate workflow
136
+ - Delegates to specialist agents
137
+ - Tracks progress and blocks on decisions
138
+ - Never writes code directly
139
+
140
+ ### Specialist Agents
141
+
142
+ | Agent | Responsibility |
143
+ |-------|----------------|
144
+ | **@architect** | Analyzes project patterns, generates specialized agents |
145
+ | **@backend** | APIs, database schemas, services, repositories, auth |
146
+ | **@frontend** | UI components, pages, state management, forms, styling |
147
+ | **@tester** | Unit tests, integration tests, E2E tests, 80% coverage |
148
+ | **@reviewer** | Code quality, dead code detection, security, lint |
149
+ | **@fixer** | Fixes validation failures, removes dead code, adds tests |
150
+
151
+ ### How Delegation Works
152
+
153
+ ```
154
+ User: "Build authentication system"
155
+
156
+ Orchestrator:
157
+ → Classifies as FEATURE_DEVELOPMENT
158
+ → Delegates to @backend: "Implement JWT login API"
159
+ → Delegates to @frontend: "Create login form UI"
160
+ → Delegates to @tester: "Write auth tests"
161
+ → Delegates to @reviewer: "Review auth implementation"
162
+ → Updates completion.json: auth = 100%
163
+ → Continues to next feature
164
+ ```
165
+
166
+ ## Quality Gates
167
+
168
+ Every change automatically passes through:
169
+
170
+ - **Type checking** - No type errors
171
+ - **Linting** - Consistent code style
172
+ - **Tests** - All tests passing
173
+ - **Coverage** - Minimum 80% code coverage
174
+ - **Security** - No vulnerabilities, hardcoded secrets
175
+ - **Dead code** - No unused exports, imports, files
176
+ - **Performance** - Benchmarks (if configured)
177
+
178
+ **If gates fail** → @fixer automatically resolves issues → re-validates
179
+
180
+ ## State Tracking
181
+
182
+ Progress lives in `.agentful/`:
183
+
184
+ ```
185
+ .agentful/
186
+ ├── state.json # Current work, phase, iterations
187
+ ├── completion.json # Feature completion (domains → features)
188
+ ├── decisions.json # Pending user decisions
189
+ └── architecture.json # Detected tech stack, patterns
190
+ ```
191
+
192
+ **Example completion.json:**
193
+ ```json
194
+ {
195
+ "domains": {
196
+ "authentication": {
197
+ "status": "complete",
198
+ "score": 100,
199
+ "features": {
200
+ "login": { "status": "complete", "score": 100 },
201
+ "register": { "status": "complete", "score": 100 }
202
+ }
203
+ }
204
+ },
205
+ "gates": {
206
+ "tests_passing": true,
207
+ "no_type_errors": true,
208
+ "coverage_80": false
209
+ },
210
+ "overall": 65
211
+ }
212
+ ```
213
+
214
+ ## Decision Handling
215
+
216
+ When agentful needs input:
217
+
218
+ 1. **Pauses development** on blocked features
219
+ 2. **Adds decision** to `decisions.json`
220
+ 3. **Continues** with unblocked work
221
+ 4. **Notifies you** to run `/agentful-decide`
222
+
223
+ **Example decision:**
224
+ ```json
225
+ {
226
+ "id": "decision-001",
227
+ "question": "Should auth use JWT or session cookies?",
228
+ "options": [
229
+ "JWT (stateless, scalable)",
230
+ "Sessions (simpler, built-in)",
231
+ "Clerk (managed service)"
232
+ ],
233
+ "blocking": ["authentication/login", "authentication/register"]
234
+ }
235
+ ```
236
+
237
+ ## Work Types
238
+
239
+ | Type | Trigger | Workflow |
240
+ |------|---------|----------|
241
+ | **Feature** | "Build X", "Add Y feature" | Autonomous loop until complete |
242
+ | **Bugfix** | "Fix X bug", "Y is broken" | Quick fix → test → validate → stop |
243
+ | **Enhancement** | "Add X to Y", "Enhance Z" | Enhance → test → validate → stop |
244
+ | **Refactor** | "Refactor X", "Improve Y code" | Refactor → test → validate → stop |
245
+ | **Maintenance** | "Update deps", "Security scan" | Update → test → validate → stop |
246
+
247
+ ## Continuous Development
248
+
249
+ For 24/7 autonomous development:
250
+
251
+ ```bash
252
+ /ralph-loop "/agentful-start" \
253
+ --max-iterations 50 \
254
+ --completion-promise "AGENTFUL_COMPLETE"
255
+ ```
256
+
257
+ Stops when:
258
+ - All features complete (100%)
259
+ - Decision needed (pauses for input)
260
+ - Quality gates fail (pauses for review)
261
+
262
+ ## Best Practices
263
+
264
+ **1. Write Clear Specifications**
265
+ - Define features with acceptance criteria
266
+ - Set priority levels (CRITICAL, HIGH, MEDIUM, LOW)
267
+ - Group related features into domains (for complex projects)
268
+
269
+ **2. Answer Decisions Promptly**
270
+ - Decisions block the autonomous loop
271
+ - Use `/agentful-decide` to resolve multiple at once
272
+
273
+ **3. Review Commits**
274
+ - agentful creates commits after each validated change
275
+ - Review before pushing to main
276
+
277
+ **4. Run Validation Often**
278
+ - `/agentful-validate` catches issues early
279
+ - Fix small problems before they compound
280
+
281
+ **5. Check Status Before Merging**
282
+ - `/agentful-status` shows true completion
283
+ - Ensure all gates passing before deploying
284
+
285
+ ## Technology Detection
286
+
287
+ agentful works with **any** tech stack:
288
+
289
+ - **Languages**: TypeScript, JavaScript, Python, Go, Rust, Java, C#, PHP, Ruby, Elixir, etc.
290
+ - **Frameworks**: React, Vue, Angular, Svelte, Next.js, Django, Flask, ASP.NET, Spring, Express, Fastify, etc.
291
+ - **Databases**: PostgreSQL, MySQL, MongoDB, Redis, etc.
292
+ - **Testing**: Jest, Vitest, Pytest, JUnit, Go test, etc.
293
+
294
+ It learns **your project's patterns** and generates agents that match your conventions.
295
+
296
+ ## Architecture
297
+
298
+ ```
299
+ ┌─────────────────────────────────────────────┐
300
+ │ agentful Framework │
301
+ ├─────────────────────────────────────────────┤
302
+ │ CLI Tool (npx @itz4blitz/agentful init) │
303
+ │ ├─ Project initialization │
304
+ │ ├─ Tech stack detection │
305
+ │ └─ Template creation │
306
+ ├─────────────────────────────────────────────┤
307
+ │ Slash Commands (Claude Code) │
308
+ │ ├─ /agentful-start (orchestrator) │
309
+ │ ├─ /agentful-status (progress) │
310
+ │ ├─ /agentful-validate (quality gates) │
311
+ │ └─ /agentful-decide (decisions) │
312
+ ├─────────────────────────────────────────────┤
313
+ │ Agent System │
314
+ │ ├─ Orchestrator (coordination) │
315
+ │ ├─ Architect (pattern detection) │
316
+ │ ├─ Backend (APIs, database) │
317
+ │ ├─ Frontend (UI, components) │
318
+ │ ├─ Tester (tests, coverage) │
319
+ │ ├─ Reviewer (quality, security) │
320
+ │ └─ Fixer (validation failures) │
321
+ └─────────────────────────────────────────────┘
322
+ ```
323
+
324
+ ## Get Help
325
+
326
+ - **Documentation**: https://agentful.app
327
+ - **GitHub**: https://github.com/itz4blitz/agentful
328
+ - **Issues**: https://github.com/itz4blitz/agentful/issues
329
+ - **Version**: 0.1.1 (check updates: `npm outdated @itz4blitz/agentful`)
@@ -1,6 +1,6 @@
1
1
  # Product Structure Guide
2
2
 
3
- Agentful supports **both** flat and hierarchical product structures with automatic detection. This guide explains how to use each format.
3
+ agentful supports **both** flat and hierarchical product structures with automatic detection. This guide explains how to use each format.
4
4
 
5
5
  ## Quick Start
6
6
 
@@ -145,7 +145,7 @@ The product is complete when:
145
145
 
146
146
  ---
147
147
 
148
- **Tip**: The more detailed your product specification, the better Agentful can understand what to build. Include:
148
+ **Tip**: The more detailed your product specification, the better agentful can understand what to build. Include:
149
149
  - Clear acceptance criteria
150
150
  - User stories for context
151
151
  - Technical constraints
@@ -1,4 +1,5 @@
1
1
  {
2
+ "includeCoAuthoredBy": false,
2
3
  "hooks": {
3
4
  "PreToolUse": [
4
5
  {
@@ -6,7 +7,7 @@
6
7
  "hooks": [
7
8
  {
8
9
  "type": "command",
9
- "command": "if [ \"$FILE\"\" = \"*.md\" ] && grep -q 'Deployment Guide\\|Publishing Guide\\|Setup Guide' \"$FILE\" 2>/dev/null; then echo \"WARNING: Similar documentation may exist. Check for: docs/pages/deployment.mdx, PUBLISHING.md\"; fi"
10
+ "command": "if [ \"$FILE\" = \"*.md\" ] && grep -q 'Deployment Guide\\|Publishing Guide\\|Setup Guide' \"$FILE\" 2>/dev/null; then echo \"WARNING: Similar documentation may exist. Check for: docs/pages/deployment.mdx, PUBLISHING.md\"; fi"
10
11
  }
11
12
  ]
12
13
  }
@@ -26,7 +27,7 @@
26
27
  "hooks": [
27
28
  {
28
29
  "type": "command",
29
- "command": "if [ \"$FILE\"\" = \"*.md\" ]; then existing=$(find . -name '*.md' -not -path './node_modules/*' -not -path './.git/*' | xargs grep -l \"$(basename '$FILE' | sed 's/_/ /g' | sed 's/.md$//' | head -c 30)\" 2>/dev/null | grep -v \"$FILE\" | head -1); if [ -n \"$existing\"\" ]; then echo \"⚠️ Similar doc exists: $existing - consider updating instead\"; fi; fi || true"
30
+ "command": "if [ \"$FILE\" = \"*.md\" ]; then existing=$(find . -name '*.md' -not -path './node_modules/*' -not -path './.git/*' | xargs grep -l \"$(basename '$FILE' | sed 's/_/ /g' | sed 's/.md$//' | head -c 30)\" 2>/dev/null | grep -v \"$FILE\" | head -1); if [ -n \"$existing\" ]; then echo \"\u26a0\ufe0f Similar doc exists: $existing - consider updating instead\"; fi; fi || true"
30
31
  }
31
32
  ]
32
33
  }
@@ -60,4 +61,4 @@
60
61
  "Bash(mkfs:*)"
61
62
  ]
62
63
  }
63
- }
64
+ }