@itz4blitz/agentful 0.5.1 → 1.0.0
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 +21 -34
- package/lib/init.js +20 -12
- package/package.json +1 -1
- package/version.json +1 -1
package/README.md
CHANGED
|
@@ -4,29 +4,24 @@ A carrot on a stick for Claude Code
|
|
|
4
4
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
[](https://www.npmjs.com/package/@itz4blitz/agentful)
|
|
7
|
-
[](https://github.com/itz4blitz/agentful)
|
|
7
|
+
[](https://github.com/itz4blitz/agentful/actions)
|
|
9
8
|
|
|
10
9
|
## Overview
|
|
11
10
|
|
|
12
|
-
agentful is a
|
|
13
|
-
|
|
14
|
-
**Production Quality**: Enterprise-grade testing (370 tests), 98.26% code coverage, comprehensive error handling, and lifecycle hooks for validation and metrics.
|
|
11
|
+
agentful is a Claude Code configuration that provides structured development through specialized AI agents. It coordinates multiple agents to implement features, write tests, and validate code quality according to a defined product specification.
|
|
15
12
|
|
|
16
13
|
## Web Configurator
|
|
17
14
|
|
|
18
15
|
Configure your agentful installation with an interactive web interface:
|
|
19
16
|
|
|
20
|
-
**[agentful.app
|
|
17
|
+
**[agentful.app](https://agentful.app)**
|
|
21
18
|
|
|
22
19
|
- Visual component selection
|
|
23
|
-
-
|
|
20
|
+
- 2 optimized presets
|
|
24
21
|
- Custom configurations
|
|
25
22
|
- Shareable setup URLs
|
|
26
23
|
- No CLI required
|
|
27
24
|
|
|
28
|
-
See the [Web Configurator Guide](https://agentful.app/getting-started/configurator) for details.
|
|
29
|
-
|
|
30
25
|
## Installation
|
|
31
26
|
|
|
32
27
|
### Default Installation (Recommended)
|
|
@@ -40,7 +35,6 @@ npx @itz4blitz/agentful init
|
|
|
40
35
|
This installs:
|
|
41
36
|
- **8 agents**: orchestrator, architect, backend, frontend, tester, reviewer, fixer, product-analyzer
|
|
42
37
|
- **6 skills**: product-tracking, validation, testing, conversation, product-planning, deployment
|
|
43
|
-
- **Hooks**: health-check (configurable)
|
|
44
38
|
- **Quality gates**: types, tests, coverage, lint, security, dead-code
|
|
45
39
|
|
|
46
40
|
**Tech stack is auto-detected** on first run (TypeScript, Python, React, etc.) - no need to specify.
|
|
@@ -71,17 +65,16 @@ npx @itz4blitz/agentful presets
|
|
|
71
65
|
|
|
72
66
|
### Shareable Configurations
|
|
73
67
|
|
|
74
|
-
Use a configuration from
|
|
68
|
+
Use a configuration from the web configurator:
|
|
75
69
|
|
|
76
70
|
```bash
|
|
77
|
-
npx @itz4blitz/agentful init --config
|
|
71
|
+
npx @itz4blitz/agentful init --config=<shareable-url>
|
|
78
72
|
```
|
|
79
73
|
|
|
80
74
|
**Available Flags:**
|
|
81
75
|
- `--preset=<name>` - Use a preset configuration
|
|
82
76
|
- `--agents=<list>` - Comma-separated list of agents (orchestrator, backend, frontend, tester, reviewer, fixer, architect, product-analyzer)
|
|
83
77
|
- `--skills=<list>` - Comma-separated list of skills (validation, testing, product-tracking, conversation, product-planning, deployment)
|
|
84
|
-
- `--hooks=<list>` - Comma-separated list of hooks (health-check, typescript-validation, notifications, format-on-save)
|
|
85
78
|
- `--gates=<list>` - Comma-separated list of quality gates (types, tests, coverage, lint, security, dead-code)
|
|
86
79
|
|
|
87
80
|
Flags override preset values when both are specified.
|
|
@@ -196,7 +189,7 @@ For projects with existing code:
|
|
|
196
189
|
|
|
197
190
|
### Agent System
|
|
198
191
|
|
|
199
|
-
agentful uses
|
|
192
|
+
agentful uses eight specialized agents:
|
|
200
193
|
|
|
201
194
|
| Agent | Responsibility |
|
|
202
195
|
|-------|---------------|
|
|
@@ -207,15 +200,16 @@ agentful uses seven specialized agents:
|
|
|
207
200
|
| tester | Writes unit, integration, and end-to-end tests |
|
|
208
201
|
| reviewer | Validates code quality, security, and standards |
|
|
209
202
|
| fixer | Resolves validation failures and test errors |
|
|
203
|
+
| product-analyzer | Analyzes product specs for gaps, ambiguities, and readiness scoring |
|
|
210
204
|
|
|
211
205
|
### Quality Gates
|
|
212
206
|
|
|
213
|
-
Code changes are validated against 6
|
|
207
|
+
Code changes are validated against 6 automated quality gates:
|
|
214
208
|
|
|
215
209
|
- Type checking (TypeScript, Flow, etc.)
|
|
216
210
|
- Linting (ESLint, Biome, etc.)
|
|
217
|
-
- Test execution
|
|
218
|
-
- Code coverage
|
|
211
|
+
- Test execution
|
|
212
|
+
- Code coverage
|
|
219
213
|
- Security scanning
|
|
220
214
|
- Dead code detection
|
|
221
215
|
|
|
@@ -230,13 +224,11 @@ Runtime state is stored in `.agentful/` (gitignored, managed by npm package):
|
|
|
230
224
|
- New projects: Starts with declared stack (`confidence: 0.4`)
|
|
231
225
|
- Existing projects: Detected from code (`confidence: 0.8-1.0`)
|
|
232
226
|
- Re-analyzed after first implementation in new projects
|
|
233
|
-
- `last-validation.json` - Latest test/lint results
|
|
234
227
|
- `conversation-history.json` - Session tracking
|
|
235
|
-
- `product-analysis.json` - Readiness analysis (generated by `/agentful-product`)
|
|
236
228
|
|
|
237
229
|
User configuration is stored in `.claude/` (version controlled):
|
|
238
230
|
|
|
239
|
-
- `agents/` - Agent definitions
|
|
231
|
+
- `agents/` - Agent definitions
|
|
240
232
|
- `commands/` - Slash commands
|
|
241
233
|
- `product/` - Product specifications
|
|
242
234
|
- `index.md` - Main product spec (user editable)
|
|
@@ -246,20 +238,23 @@ User configuration is stored in `.claude/` (version controlled):
|
|
|
246
238
|
- `product-tracking/` - Progress calculation and state tracking
|
|
247
239
|
- `product-planning/` - Product specification guidance
|
|
248
240
|
- `validation/` - Quality gate checks and tool detection
|
|
241
|
+
- `testing/` - Test strategy and coverage
|
|
242
|
+
- `deployment/` - Deployment preparation and validation
|
|
249
243
|
- `settings.json` - Project configuration
|
|
250
244
|
|
|
251
|
-
**See [ARCHITECTURE.md](./ARCHITECTURE.md) for detailed explanation of file organization.**
|
|
252
|
-
|
|
253
245
|
## Commands
|
|
254
246
|
|
|
255
247
|
| Command | Description |
|
|
256
248
|
|---------|-------------|
|
|
249
|
+
| `/agentful` | Main agentful command - shows help and available commands |
|
|
257
250
|
| `/agentful-product` | Smart product planning: create, analyze, and refine requirements |
|
|
258
251
|
| `/agentful-start` | Start or resume structured development |
|
|
259
252
|
| `/agentful-status` | Display progress and current state |
|
|
260
253
|
| `/agentful-validate` | Run all quality checks |
|
|
261
254
|
| `/agentful-decide` | Answer pending decisions |
|
|
262
255
|
| `/agentful-update` | Smart update mechanism - fetches latest templates and gracefully migrates changes |
|
|
256
|
+
| `/agentful-analyze` | Analyze architecture and generate specialized agents for your tech stack |
|
|
257
|
+
| `/agentful-generate` | Generate specialized agents from architecture analysis |
|
|
263
258
|
|
|
264
259
|
## CI/CD Integration
|
|
265
260
|
|
|
@@ -273,7 +268,7 @@ agentful ci --generate-workflow
|
|
|
273
268
|
agentful ci
|
|
274
269
|
```
|
|
275
270
|
|
|
276
|
-
See `examples/` for sample workflow configurations ([GitHub Actions](examples/github-actions.yml), [GitLab CI](examples/gitlab-ci.yml)
|
|
271
|
+
See `examples/` for sample workflow configurations ([GitHub Actions](examples/github-actions-pipeline.yml), [GitLab CI](examples/gitlab-ci-cd.yml)).
|
|
277
272
|
|
|
278
273
|
## Remote Execution
|
|
279
274
|
|
|
@@ -290,7 +285,7 @@ agentful serve --auth=hmac --secret=$SECRET --https --cert=cert.pem --key=key.pe
|
|
|
290
285
|
agentful serve --auth=none
|
|
291
286
|
```
|
|
292
287
|
|
|
293
|
-
Three authentication modes: **Tailscale** (WireGuard encryption), **HMAC** (signature-based with replay protection), **SSH tunnel** (localhost-only).
|
|
288
|
+
Three authentication modes: **Tailscale** (WireGuard encryption), **HMAC** (signature-based with replay protection), **SSH tunnel** (localhost-only).
|
|
294
289
|
|
|
295
290
|
## Technology Support
|
|
296
291
|
|
|
@@ -311,13 +306,7 @@ agentful detects and adapts to your technology stack automatically:
|
|
|
311
306
|
|
|
312
307
|
## Documentation
|
|
313
308
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
Key guides:
|
|
317
|
-
- [CI/CD Integration](https://agentful.app/ci-integration) - Deploy agents to production
|
|
318
|
-
- [Quick Start](https://agentful.app/getting-started/quick-start) - Get started in 5 minutes
|
|
319
|
-
- [Agent Architecture](https://agentful.app/concepts/architecture) - How agents work
|
|
320
|
-
- [Commands Reference](https://agentful.app/commands) - All available commands
|
|
309
|
+
Documentation: [agentful.app](https://agentful.app)
|
|
321
310
|
|
|
322
311
|
## Project Structure
|
|
323
312
|
|
|
@@ -337,7 +326,6 @@ your-project/
|
|
|
337
326
|
│ ├── completion.json
|
|
338
327
|
│ ├── decisions.json
|
|
339
328
|
│ ├── architecture.json
|
|
340
|
-
│ ├── last-validation.json
|
|
341
329
|
│ └── conversation-history.json
|
|
342
330
|
└── src/ # Source code
|
|
343
331
|
```
|
|
@@ -350,5 +338,4 @@ MIT
|
|
|
350
338
|
|
|
351
339
|
- GitHub: [github.com/itz4blitz/agentful](https://github.com/itz4blitz/agentful)
|
|
352
340
|
- Issues: [github.com/itz4blitz/agentful/issues](https://github.com/itz4blitz/agentful/issues)
|
|
353
|
-
-
|
|
354
|
-
- NPM: [npmjs.com/@itz4blitz/agentful](https://www.npmjs.com/package/@itz4blitz/agentful)
|
|
341
|
+
- NPM: [npmjs.com/package/@itz4blitz/agentful](https://www.npmjs.com/package/@itz4blitz/agentful)
|
package/lib/init.js
CHANGED
|
@@ -91,32 +91,40 @@ export async function initProject(targetDir, config = null) {
|
|
|
91
91
|
await fs.mkdir(agentfulDir, { recursive: true });
|
|
92
92
|
createdFiles.push('.agentful/');
|
|
93
93
|
|
|
94
|
-
// Create state.json
|
|
94
|
+
// Create state.json (runtime state for orchestrator)
|
|
95
95
|
const stateFile = path.join(agentfulDir, 'state.json');
|
|
96
96
|
const initialState = {
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
97
|
+
version: '1.0',
|
|
98
|
+
current_task: null,
|
|
99
|
+
current_phase: 'idle',
|
|
100
|
+
iterations: 0,
|
|
101
|
+
last_updated: new Date().toISOString(),
|
|
102
|
+
blocked_on: []
|
|
101
103
|
};
|
|
102
104
|
await fs.writeFile(stateFile, JSON.stringify(initialState, null, 2));
|
|
103
105
|
createdFiles.push('.agentful/state.json');
|
|
104
106
|
|
|
105
|
-
// Create completion.json
|
|
107
|
+
// Create completion.json (feature progress tracking)
|
|
106
108
|
const completionFile = path.join(agentfulDir, 'completion.json');
|
|
107
109
|
const initialCompletion = {
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
110
|
+
features: {},
|
|
111
|
+
gates: {
|
|
112
|
+
tests_passing: false,
|
|
113
|
+
no_type_errors: false,
|
|
114
|
+
no_dead_code: false,
|
|
115
|
+
coverage_80: false,
|
|
116
|
+
security_clean: false
|
|
117
|
+
},
|
|
118
|
+
overall_progress: 0
|
|
111
119
|
};
|
|
112
120
|
await fs.writeFile(completionFile, JSON.stringify(initialCompletion, null, 2));
|
|
113
121
|
createdFiles.push('.agentful/completion.json');
|
|
114
122
|
|
|
115
|
-
// Create decisions.json
|
|
123
|
+
// Create decisions.json (pending and resolved decisions)
|
|
116
124
|
const decisionsFile = path.join(agentfulDir, 'decisions.json');
|
|
117
125
|
const initialDecisions = {
|
|
118
|
-
|
|
119
|
-
|
|
126
|
+
pending: [],
|
|
127
|
+
resolved: []
|
|
120
128
|
};
|
|
121
129
|
await fs.writeFile(decisionsFile, JSON.stringify(initialDecisions, null, 2));
|
|
122
130
|
createdFiles.push('.agentful/decisions.json');
|
package/package.json
CHANGED
package/version.json
CHANGED