proagents 1.0.18 → 1.1.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 +62 -3
- package/lib/commands/init.js +7 -2
- package/package.json +1 -1
- package/proagents/AI_INSTRUCTIONS.md +289 -0
- package/proagents/PROAGENTS.md +68 -11
- package/proagents/checkpoints.json +13 -0
- package/proagents/metrics/README.md +57 -162
- package/proagents/sprints/README.md +58 -0
package/README.md
CHANGED
|
@@ -149,15 +149,32 @@ Type these in any AI assistant (Claude, ChatGPT, Gemini, Cursor, etc.):
|
|
|
149
149
|
| `pa:d` | `pa:doc` |
|
|
150
150
|
| `pa:t` | `pa:test` |
|
|
151
151
|
| `pa:q` | `pa:qa` |
|
|
152
|
+
| `pa:a` | `pa:analyze` |
|
|
153
|
+
| `pa:r` | `pa:requirements` |
|
|
154
|
+
| `pa:p` | `pa:plan` |
|
|
155
|
+
| `pa:i` | `pa:implement` |
|
|
152
156
|
|
|
153
157
|
### Core Commands
|
|
154
158
|
| Command | Description |
|
|
155
159
|
|---------|-------------|
|
|
156
|
-
| `pa:feature "name"` | Start new feature workflow |
|
|
160
|
+
| `pa:feature "name"` | Start new feature workflow (all phases) |
|
|
157
161
|
| `pa:fix "description"` | Quick bug fix mode |
|
|
158
162
|
| `pa:status` | Show current progress |
|
|
159
163
|
| `pa:help` | Show all commands |
|
|
160
164
|
|
|
165
|
+
### Workflow Phase Commands
|
|
166
|
+
| Command | Phase | Description |
|
|
167
|
+
|---------|-------|-------------|
|
|
168
|
+
| `pa:analyze` | Analysis | Deep codebase analysis |
|
|
169
|
+
| `pa:requirements` | Requirements | Gather feature requirements |
|
|
170
|
+
| `pa:design` | Design | UI/Architecture design |
|
|
171
|
+
| `pa:plan` | Planning | Create implementation plan |
|
|
172
|
+
| `pa:implement` | Implementation | Execute code changes |
|
|
173
|
+
| `pa:test` | Testing | Create and run tests |
|
|
174
|
+
| `pa:review` | Review | Code review workflow |
|
|
175
|
+
| `pa:doc` | Documentation | Generate documentation |
|
|
176
|
+
| `pa:deploy` | Deployment | Deployment preparation |
|
|
177
|
+
|
|
161
178
|
### Documentation
|
|
162
179
|
| Command | Description |
|
|
163
180
|
|---------|-------------|
|
|
@@ -169,8 +186,7 @@ Type these in any AI assistant (Claude, ChatGPT, Gemini, Cursor, etc.):
|
|
|
169
186
|
| Command | Description |
|
|
170
187
|
|---------|-------------|
|
|
171
188
|
| `pa:qa` | Run quality assurance checks |
|
|
172
|
-
| `pa:
|
|
173
|
-
| `pa:deploy` | Deployment preparation |
|
|
189
|
+
| `pa:rollback` | Rollback procedures |
|
|
174
190
|
|
|
175
191
|
### Multi-AI Collaboration
|
|
176
192
|
| Command | Description |
|
|
@@ -198,6 +214,49 @@ Type these in any AI assistant (Claude, ChatGPT, Gemini, Cursor, etc.):
|
|
|
198
214
|
| `pa:ai-add` | Add more AI platforms |
|
|
199
215
|
| `pa:ai-sync` | Sync config with files |
|
|
200
216
|
|
|
217
|
+
### Navigation & Flow
|
|
218
|
+
| Command | Description |
|
|
219
|
+
|---------|-------------|
|
|
220
|
+
| `pa:next` | Show next step in workflow |
|
|
221
|
+
| `pa:resume` | Resume paused feature |
|
|
222
|
+
| `pa:skip` | Skip current phase |
|
|
223
|
+
| `pa:back` | Go to previous phase |
|
|
224
|
+
| `pa:progress` | Show visual progress bar |
|
|
225
|
+
|
|
226
|
+
### Context & History
|
|
227
|
+
| Command | Description |
|
|
228
|
+
|---------|-------------|
|
|
229
|
+
| `pa:context` | View project context |
|
|
230
|
+
| `pa:diff` | Show changes since last session |
|
|
231
|
+
| `pa:history` | Show command history |
|
|
232
|
+
| `pa:checkpoint` | Create restore point |
|
|
233
|
+
| `pa:undo` | Undo last action |
|
|
234
|
+
|
|
235
|
+
### Sprint & Estimation
|
|
236
|
+
| Command | Description |
|
|
237
|
+
|---------|-------------|
|
|
238
|
+
| `pa:sprint-start` | Start new sprint |
|
|
239
|
+
| `pa:sprint-end` | End sprint with summary |
|
|
240
|
+
| `pa:estimate` | Estimate task complexity |
|
|
241
|
+
| `pa:velocity` | Show velocity metrics |
|
|
242
|
+
|
|
243
|
+
### Integration
|
|
244
|
+
| Command | Description |
|
|
245
|
+
|---------|-------------|
|
|
246
|
+
| `pa:github` | GitHub integration |
|
|
247
|
+
| `pa:github-pr` | Create pull request |
|
|
248
|
+
| `pa:jira` | Sync with Jira |
|
|
249
|
+
| `pa:notify` | Send notification |
|
|
250
|
+
|
|
251
|
+
### Code Quality
|
|
252
|
+
| Command | Description |
|
|
253
|
+
|---------|-------------|
|
|
254
|
+
| `pa:metrics` | Code quality metrics |
|
|
255
|
+
| `pa:coverage` | Test coverage report |
|
|
256
|
+
| `pa:deps` | Analyze dependencies |
|
|
257
|
+
| `pa:deps-outdated` | Find outdated packages |
|
|
258
|
+
| `pa:deps-security` | Security scan |
|
|
259
|
+
|
|
201
260
|
### Custom Commands
|
|
202
261
|
| Command | Description |
|
|
203
262
|
|---------|-------------|
|
package/lib/commands/init.js
CHANGED
|
@@ -784,6 +784,11 @@ function saveProjectConfig(projectConfig, configPath) {
|
|
|
784
784
|
};
|
|
785
785
|
}
|
|
786
786
|
|
|
787
|
+
// Save platforms
|
|
788
|
+
if (projectConfig.platforms && projectConfig.platforms.length > 0) {
|
|
789
|
+
config.platforms = projectConfig.platforms;
|
|
790
|
+
}
|
|
791
|
+
|
|
787
792
|
const yamlContent = yaml.dump(config, { indent: 2, lineWidth: 120 });
|
|
788
793
|
writeFileSync(configPath, yamlContent);
|
|
789
794
|
}
|
|
@@ -997,8 +1002,8 @@ For detailed commands, see \`./proagents/PROAGENTS.md\`
|
|
|
997
1002
|
console.log(chalk.green(`✓ Merged with existing: ${aiResults.merged.join(', ')}`));
|
|
998
1003
|
}
|
|
999
1004
|
|
|
1000
|
-
// Save project and platform config
|
|
1001
|
-
const configPath = join(
|
|
1005
|
+
// Save project and platform config to ROOT config (not proagents/ folder)
|
|
1006
|
+
const configPath = join(targetDir, 'proagents.config.yaml');
|
|
1002
1007
|
saveProjectConfig(projectConfig, configPath);
|
|
1003
1008
|
savePlatformConfig(selectedPlatforms, configPath);
|
|
1004
1009
|
|
package/package.json
CHANGED
|
@@ -237,6 +237,10 @@ When the user types commands starting with `pa:`, recognize and execute them.
|
|
|
237
237
|
| `pa:d` | `pa:doc` |
|
|
238
238
|
| `pa:t` | `pa:test` |
|
|
239
239
|
| `pa:q` | `pa:qa` |
|
|
240
|
+
| `pa:a` | `pa:analyze` |
|
|
241
|
+
| `pa:r` | `pa:requirements` |
|
|
242
|
+
| `pa:p` | `pa:plan` |
|
|
243
|
+
| `pa:i` | `pa:implement` |
|
|
240
244
|
|
|
241
245
|
### Initialization
|
|
242
246
|
| Command | Action |
|
|
@@ -255,6 +259,56 @@ When the user types commands starting with `pa:`, recognize and execute them.
|
|
|
255
259
|
| `pa:feature-complete` | Mark feature complete |
|
|
256
260
|
| `pa:fix "description"` | Quick bug fix mode |
|
|
257
261
|
|
|
262
|
+
### Workflow Phase Commands
|
|
263
|
+
Run individual phases of the development workflow:
|
|
264
|
+
|
|
265
|
+
| Command | Phase | Action |
|
|
266
|
+
|---------|-------|--------|
|
|
267
|
+
| `pa:analyze` | Analysis | Deep codebase analysis - structure, patterns, dependencies |
|
|
268
|
+
| `pa:analyze-full` | Analysis | Comprehensive analysis with full depth |
|
|
269
|
+
| `pa:analyze-quick` | Analysis | Quick overview analysis |
|
|
270
|
+
| `pa:requirements` | Requirements | Gather and document feature requirements |
|
|
271
|
+
| `pa:requirements "feature"` | Requirements | Requirements for specific feature |
|
|
272
|
+
| `pa:design` | Design | UI/UX and architecture design |
|
|
273
|
+
| `pa:design-ui` | Design | Focus on UI/UX design |
|
|
274
|
+
| `pa:design-arch` | Design | Focus on architecture design |
|
|
275
|
+
| `pa:plan` | Planning | Create implementation plan |
|
|
276
|
+
| `pa:plan "feature"` | Planning | Plan specific feature implementation |
|
|
277
|
+
| `pa:implement` | Implementation | Execute implementation phase |
|
|
278
|
+
| `pa:implement-continue` | Implementation | Continue paused implementation |
|
|
279
|
+
|
|
280
|
+
**How to execute Workflow Phase commands:**
|
|
281
|
+
|
|
282
|
+
For `pa:analyze`:
|
|
283
|
+
1. Read `./proagents/prompts/01-analysis.md` for analysis workflow
|
|
284
|
+
2. Scan project structure, dependencies, patterns
|
|
285
|
+
3. Cache results in `./proagents/cache/`
|
|
286
|
+
4. Output analysis report
|
|
287
|
+
|
|
288
|
+
For `pa:requirements`:
|
|
289
|
+
1. Read `./proagents/prompts/02-requirements.md`
|
|
290
|
+
2. If feature name provided, create `./proagents/active-features/feature-{name}/requirements.md`
|
|
291
|
+
3. Gather user stories, acceptance criteria, constraints
|
|
292
|
+
4. Output requirements document
|
|
293
|
+
|
|
294
|
+
For `pa:design`:
|
|
295
|
+
1. Read `./proagents/prompts/03-ui-design.md`
|
|
296
|
+
2. Check for design inputs (Figma, sketches, exports)
|
|
297
|
+
3. Create component specifications
|
|
298
|
+
4. Output design document
|
|
299
|
+
|
|
300
|
+
For `pa:plan`:
|
|
301
|
+
1. Read `./proagents/prompts/04-planning.md`
|
|
302
|
+
2. Create implementation plan with task breakdown
|
|
303
|
+
3. Identify dependencies and risks
|
|
304
|
+
4. Save to `./proagents/active-features/feature-{name}/implementation-plan.md`
|
|
305
|
+
|
|
306
|
+
For `pa:implement`:
|
|
307
|
+
1. Read `./proagents/prompts/05-implementation.md`
|
|
308
|
+
2. Follow existing project patterns
|
|
309
|
+
3. Implement code changes
|
|
310
|
+
4. Log progress to activity.log
|
|
311
|
+
|
|
258
312
|
### Documentation Commands
|
|
259
313
|
| Command | Action |
|
|
260
314
|
|---------|--------|
|
|
@@ -283,6 +337,241 @@ When the user types commands starting with `pa:`, recognize and execute them.
|
|
|
283
337
|
| `pa:deploy` | Deployment preparation |
|
|
284
338
|
| `pa:rollback` | Rollback procedures |
|
|
285
339
|
|
|
340
|
+
### Navigation & Flow
|
|
341
|
+
| Command | Action |
|
|
342
|
+
|---------|--------|
|
|
343
|
+
| `pa:next` | Show next step in current workflow |
|
|
344
|
+
| `pa:resume` | Resume paused feature from where left off |
|
|
345
|
+
| `pa:skip` | Skip current phase, move to next |
|
|
346
|
+
| `pa:back` | Go back to previous phase |
|
|
347
|
+
| `pa:progress` | Show visual progress bar for current feature |
|
|
348
|
+
|
|
349
|
+
**How to execute Navigation commands:**
|
|
350
|
+
|
|
351
|
+
For `pa:next`:
|
|
352
|
+
1. Read `./proagents/active-features/*/status.json` to find current feature
|
|
353
|
+
2. Identify current phase from status
|
|
354
|
+
3. Show what the next step/phase is
|
|
355
|
+
4. Provide guidance for the next action
|
|
356
|
+
|
|
357
|
+
For `pa:resume`:
|
|
358
|
+
1. Read `./proagents/active-features/` to find paused features
|
|
359
|
+
2. Read feature's `status.json` for last phase and progress
|
|
360
|
+
3. Read `./proagents/handoff.md` for context
|
|
361
|
+
4. Continue from where it was left off
|
|
362
|
+
|
|
363
|
+
For `pa:skip`:
|
|
364
|
+
1. Read current feature status
|
|
365
|
+
2. Mark current phase as "skipped" in status.json
|
|
366
|
+
3. Move to next phase
|
|
367
|
+
4. Log skip reason to activity.log
|
|
368
|
+
5. Warn if skipping critical phase (testing, review)
|
|
369
|
+
|
|
370
|
+
For `pa:back`:
|
|
371
|
+
1. Read current feature status
|
|
372
|
+
2. Move to previous phase
|
|
373
|
+
3. Update status.json
|
|
374
|
+
4. Reload context from previous phase
|
|
375
|
+
|
|
376
|
+
For `pa:progress`:
|
|
377
|
+
1. Read `./proagents/active-features/*/status.json`
|
|
378
|
+
2. Calculate percentage complete (current_phase / total_phases)
|
|
379
|
+
3. Display visual progress bar:
|
|
380
|
+
```
|
|
381
|
+
Feature: user-auth
|
|
382
|
+
Phase: 5/10 (Implementation)
|
|
383
|
+
Progress: [████████░░░░░░░░░░░░] 50%
|
|
384
|
+
|
|
385
|
+
✓ Init → ✓ Analysis → ✓ Requirements → ✓ Design → ● Implementation → ○ Testing → ○ Review → ○ Docs → ○ Deploy
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
### Context & History
|
|
389
|
+
| Command | Action |
|
|
390
|
+
|---------|--------|
|
|
391
|
+
| `pa:context` | Quick view/edit project context |
|
|
392
|
+
| `pa:context-edit` | Edit project context interactively |
|
|
393
|
+
| `pa:diff` | Show what changed since last session |
|
|
394
|
+
| `pa:history` | Show command history with results |
|
|
395
|
+
| `pa:checkpoint` | Create a snapshot/restore point |
|
|
396
|
+
| `pa:checkpoint-restore` | Restore from a checkpoint |
|
|
397
|
+
| `pa:undo` | Undo last AI action using git |
|
|
398
|
+
|
|
399
|
+
**How to execute Context & History commands:**
|
|
400
|
+
|
|
401
|
+
For `pa:context`:
|
|
402
|
+
1. Read `./proagents/context.md`
|
|
403
|
+
2. Display current project context summary
|
|
404
|
+
3. Show last updated timestamp
|
|
405
|
+
|
|
406
|
+
For `pa:diff`:
|
|
407
|
+
1. Read `./proagents/activity.log` for last session timestamp
|
|
408
|
+
2. Run `git diff` from that point
|
|
409
|
+
3. Summarize changes by file/module
|
|
410
|
+
4. Highlight significant changes
|
|
411
|
+
|
|
412
|
+
For `pa:history`:
|
|
413
|
+
1. Read `./proagents/history.log`
|
|
414
|
+
2. Show recent commands with their results
|
|
415
|
+
3. Format: `[timestamp] command → result`
|
|
416
|
+
|
|
417
|
+
For `pa:checkpoint`:
|
|
418
|
+
1. Create git commit with message "checkpoint: [description]"
|
|
419
|
+
2. Save checkpoint info to `./proagents/checkpoints.json`:
|
|
420
|
+
```json
|
|
421
|
+
{
|
|
422
|
+
"checkpoints": [
|
|
423
|
+
{
|
|
424
|
+
"id": "cp-001",
|
|
425
|
+
"timestamp": "2024-03-06T15:00:00Z",
|
|
426
|
+
"commit": "abc123",
|
|
427
|
+
"description": "Before auth refactor",
|
|
428
|
+
"feature": "user-auth",
|
|
429
|
+
"phase": "implementation"
|
|
430
|
+
}
|
|
431
|
+
]
|
|
432
|
+
}
|
|
433
|
+
```
|
|
434
|
+
3. Log to activity.log
|
|
435
|
+
|
|
436
|
+
For `pa:undo`:
|
|
437
|
+
1. Read last action from `./proagents/activity.log`
|
|
438
|
+
2. If file changes, run `git checkout` to revert
|
|
439
|
+
3. If multiple files, offer selective undo
|
|
440
|
+
4. Update activity.log with undo entry
|
|
441
|
+
|
|
442
|
+
### Sprint & Project Management
|
|
443
|
+
| Command | Action |
|
|
444
|
+
|---------|--------|
|
|
445
|
+
| `pa:sprint-start` | Start a new sprint |
|
|
446
|
+
| `pa:sprint-end` | End sprint with summary |
|
|
447
|
+
| `pa:sprint-status` | Show current sprint status |
|
|
448
|
+
| `pa:estimate` | Estimate task complexity |
|
|
449
|
+
| `pa:estimate "task"` | Estimate specific task |
|
|
450
|
+
| `pa:velocity` | Show team velocity metrics |
|
|
451
|
+
|
|
452
|
+
**How to execute Sprint commands:**
|
|
453
|
+
|
|
454
|
+
For `pa:sprint-start`:
|
|
455
|
+
1. Create `./proagents/sprints/sprint-{number}.json`:
|
|
456
|
+
```json
|
|
457
|
+
{
|
|
458
|
+
"sprint_number": 1,
|
|
459
|
+
"start_date": "2024-03-06",
|
|
460
|
+
"end_date": "2024-03-20",
|
|
461
|
+
"goals": [],
|
|
462
|
+
"features": [],
|
|
463
|
+
"status": "active"
|
|
464
|
+
}
|
|
465
|
+
```
|
|
466
|
+
2. Ask for sprint goals
|
|
467
|
+
3. Link active features to sprint
|
|
468
|
+
|
|
469
|
+
For `pa:sprint-end`:
|
|
470
|
+
1. Read current sprint file
|
|
471
|
+
2. Calculate metrics (completed features, velocity)
|
|
472
|
+
3. Generate sprint summary → `./proagents/sprints/sprint-{n}-summary.md`
|
|
473
|
+
4. Archive sprint
|
|
474
|
+
|
|
475
|
+
For `pa:estimate`:
|
|
476
|
+
1. Analyze task/feature complexity
|
|
477
|
+
2. Consider: code changes, files affected, dependencies, testing needs
|
|
478
|
+
3. Provide estimate in story points or T-shirt sizes (S/M/L/XL)
|
|
479
|
+
4. Save estimate to feature status.json
|
|
480
|
+
|
|
481
|
+
For `pa:velocity`:
|
|
482
|
+
1. Read completed sprints from `./proagents/sprints/`
|
|
483
|
+
2. Calculate average story points per sprint
|
|
484
|
+
3. Show velocity chart/trend
|
|
485
|
+
|
|
486
|
+
### Integration Commands
|
|
487
|
+
| Command | Action |
|
|
488
|
+
|---------|--------|
|
|
489
|
+
| `pa:github` | GitHub integration commands |
|
|
490
|
+
| `pa:github-issue` | Create GitHub issue from current work |
|
|
491
|
+
| `pa:github-pr` | Create pull request |
|
|
492
|
+
| `pa:jira` | Jira integration commands |
|
|
493
|
+
| `pa:jira-sync` | Sync with Jira ticket |
|
|
494
|
+
| `pa:notify` | Send notification |
|
|
495
|
+
| `pa:notify-slack` | Send Slack notification |
|
|
496
|
+
| `pa:notify-email` | Send email notification |
|
|
497
|
+
|
|
498
|
+
**How to execute Integration commands:**
|
|
499
|
+
|
|
500
|
+
For `pa:github-issue`:
|
|
501
|
+
1. Read current feature/bug context
|
|
502
|
+
2. Generate issue title and body
|
|
503
|
+
3. Show preview and ask for confirmation
|
|
504
|
+
4. Provide `gh issue create` command or API call
|
|
505
|
+
|
|
506
|
+
For `pa:github-pr`:
|
|
507
|
+
1. Read current feature context
|
|
508
|
+
2. Generate PR title and description
|
|
509
|
+
3. Include: summary, changes, test plan
|
|
510
|
+
4. Provide `gh pr create` command
|
|
511
|
+
|
|
512
|
+
For `pa:jira-sync`:
|
|
513
|
+
1. Read Jira config from `proagents.config.yaml`
|
|
514
|
+
2. Find linked ticket (from feature name or config)
|
|
515
|
+
3. Update ticket status based on feature phase
|
|
516
|
+
4. Add comment with progress
|
|
517
|
+
|
|
518
|
+
For `pa:notify`:
|
|
519
|
+
1. Read notification config from `proagents.config.yaml`
|
|
520
|
+
2. Generate notification message based on context
|
|
521
|
+
3. Send via configured channel (Slack webhook, email, etc.)
|
|
522
|
+
|
|
523
|
+
### Code Quality Commands
|
|
524
|
+
| Command | Action |
|
|
525
|
+
|---------|--------|
|
|
526
|
+
| `pa:metrics` | Show code quality metrics |
|
|
527
|
+
| `pa:metrics-history` | Show metrics over time |
|
|
528
|
+
| `pa:coverage` | Show test coverage report |
|
|
529
|
+
| `pa:coverage-diff` | Show coverage changes |
|
|
530
|
+
| `pa:deps` | Analyze dependencies |
|
|
531
|
+
| `pa:deps-outdated` | Find outdated dependencies |
|
|
532
|
+
| `pa:deps-security` | Security scan dependencies |
|
|
533
|
+
|
|
534
|
+
**How to execute Code Quality commands:**
|
|
535
|
+
|
|
536
|
+
For `pa:metrics`:
|
|
537
|
+
1. Analyze codebase for:
|
|
538
|
+
- Lines of code (by language)
|
|
539
|
+
- Cyclomatic complexity
|
|
540
|
+
- Code duplication
|
|
541
|
+
- Function/file sizes
|
|
542
|
+
2. Save to `./proagents/metrics/latest.json`
|
|
543
|
+
3. Display summary with warnings for issues
|
|
544
|
+
|
|
545
|
+
For `pa:coverage`:
|
|
546
|
+
1. Check for coverage reports (coverage/, .nyc_output/, etc.)
|
|
547
|
+
2. Parse coverage data
|
|
548
|
+
3. Display summary:
|
|
549
|
+
```
|
|
550
|
+
Test Coverage Report
|
|
551
|
+
═══════════════════
|
|
552
|
+
Overall: 82% ✓
|
|
553
|
+
|
|
554
|
+
By Module:
|
|
555
|
+
• src/auth/ 95% ████████████████████ ✓
|
|
556
|
+
• src/api/ 78% ███████████████░░░░░
|
|
557
|
+
• src/utils/ 65% █████████████░░░░░░░ ⚠
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
For `pa:deps`:
|
|
561
|
+
1. Read package.json / requirements.txt
|
|
562
|
+
2. Analyze dependency tree
|
|
563
|
+
3. Identify:
|
|
564
|
+
- Direct vs transitive deps
|
|
565
|
+
- Duplicate packages
|
|
566
|
+
- Large dependencies
|
|
567
|
+
- Outdated versions
|
|
568
|
+
|
|
569
|
+
For `pa:deps-security`:
|
|
570
|
+
1. Run `npm audit` or equivalent
|
|
571
|
+
2. Parse security advisories
|
|
572
|
+
3. Categorize by severity
|
|
573
|
+
4. Suggest fixes
|
|
574
|
+
|
|
286
575
|
### AI Platform Management
|
|
287
576
|
| Command | Action |
|
|
288
577
|
|---------|--------|
|
package/proagents/PROAGENTS.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Execute these commands when user types them (prefix: `pa:`):
|
|
4
4
|
|
|
5
5
|
## Quick Aliases
|
|
6
|
-
`pa:f` → feature | `pa:s` → status | `pa:h` → help | `pa:d` → doc | `pa:t` → test | `pa:q` → qa
|
|
6
|
+
`pa:f` → feature | `pa:s` → status | `pa:h` → help | `pa:d` → doc | `pa:t` → test | `pa:q` → qa | `pa:a` → analyze | `pa:r` → requirements | `pa:p` → plan | `pa:i` → implement
|
|
7
7
|
|
|
8
8
|
> **Multi-AI Note:** Multiple AIs may work on this project. Always read `./proagents/activity.log` before executing commands, and log your actions after completing them.
|
|
9
9
|
|
|
@@ -14,6 +14,11 @@ Execute these commands when user types them (prefix: `pa:`):
|
|
|
14
14
|
| `pa:help` | Show this command table |
|
|
15
15
|
| `pa:feature "name"` | Create `./proagents/active-features/feature-[name]/`, analyze codebase, implement feature |
|
|
16
16
|
| `pa:fix "description"` | Find bug, fix it, update `./CHANGELOG.md` |
|
|
17
|
+
| `pa:analyze` | Deep codebase analysis → `./proagents/cache/` |
|
|
18
|
+
| `pa:requirements` | Gather requirements → `./proagents/active-features/` |
|
|
19
|
+
| `pa:design` | UI/Architecture design phase |
|
|
20
|
+
| `pa:plan` | Create implementation plan |
|
|
21
|
+
| `pa:implement` | Execute implementation phase |
|
|
17
22
|
| `pa:status` | Read `./proagents/active-features/*/status.json`, show progress |
|
|
18
23
|
| `pa:qa` | Check code quality, run tests, report issues |
|
|
19
24
|
| `pa:test` | Create/run tests for current work |
|
|
@@ -36,6 +41,54 @@ Execute these commands when user types them (prefix: `pa:`):
|
|
|
36
41
|
| `pa:standup` | Generate daily standup summary |
|
|
37
42
|
| `pa:tech-debt` | Scan for technical debt |
|
|
38
43
|
|
|
44
|
+
## Navigation & Flow
|
|
45
|
+
|
|
46
|
+
| Command | What to Do |
|
|
47
|
+
|---------|------------|
|
|
48
|
+
| `pa:next` | Show next step in current workflow |
|
|
49
|
+
| `pa:resume` | Resume paused feature from last checkpoint |
|
|
50
|
+
| `pa:skip` | Skip current phase, move to next |
|
|
51
|
+
| `pa:back` | Go back to previous phase |
|
|
52
|
+
| `pa:progress` | Show visual progress bar |
|
|
53
|
+
|
|
54
|
+
## Context & History
|
|
55
|
+
|
|
56
|
+
| Command | What to Do |
|
|
57
|
+
|---------|------------|
|
|
58
|
+
| `pa:context` | View project context |
|
|
59
|
+
| `pa:diff` | Show changes since last session |
|
|
60
|
+
| `pa:history` | Show command history with results |
|
|
61
|
+
| `pa:checkpoint` | Create snapshot/restore point |
|
|
62
|
+
| `pa:undo` | Undo last AI action (git revert) |
|
|
63
|
+
|
|
64
|
+
## Sprint & Estimation
|
|
65
|
+
|
|
66
|
+
| Command | What to Do |
|
|
67
|
+
|---------|------------|
|
|
68
|
+
| `pa:sprint-start` | Start new sprint → `./proagents/sprints/` |
|
|
69
|
+
| `pa:sprint-end` | End sprint with summary |
|
|
70
|
+
| `pa:estimate` | Estimate task complexity (S/M/L/XL) |
|
|
71
|
+
| `pa:velocity` | Show velocity metrics |
|
|
72
|
+
|
|
73
|
+
## Integration
|
|
74
|
+
|
|
75
|
+
| Command | What to Do |
|
|
76
|
+
|---------|------------|
|
|
77
|
+
| `pa:github` | GitHub commands (issue, PR) |
|
|
78
|
+
| `pa:github-pr` | Create pull request |
|
|
79
|
+
| `pa:jira` | Sync with Jira ticket |
|
|
80
|
+
| `pa:notify` | Send notification (Slack/email) |
|
|
81
|
+
|
|
82
|
+
## Code Quality
|
|
83
|
+
|
|
84
|
+
| Command | What to Do |
|
|
85
|
+
|---------|------------|
|
|
86
|
+
| `pa:metrics` | Show code quality metrics |
|
|
87
|
+
| `pa:coverage` | Show test coverage report |
|
|
88
|
+
| `pa:deps` | Analyze dependencies |
|
|
89
|
+
| `pa:deps-outdated` | Find outdated packages |
|
|
90
|
+
| `pa:deps-security` | Security scan dependencies |
|
|
91
|
+
|
|
39
92
|
## Key Files to Read
|
|
40
93
|
|
|
41
94
|
| File | Purpose |
|
|
@@ -48,16 +101,20 @@ Execute these commands when user types them (prefix: `pa:`):
|
|
|
48
101
|
|
|
49
102
|
## Feature Workflow
|
|
50
103
|
|
|
51
|
-
`pa:feature`
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
104
|
+
`pa:feature` runs all phases, or run individually:
|
|
105
|
+
|
|
106
|
+
| Phase | Command | Action |
|
|
107
|
+
|-------|---------|--------|
|
|
108
|
+
| 1. Init | `pa:feature "name"` | Create tracking files |
|
|
109
|
+
| 2. Analysis | `pa:analyze` | Understand existing code |
|
|
110
|
+
| 3. Requirements | `pa:requirements` | Define what to build |
|
|
111
|
+
| 4. Design | `pa:design` | Plan UI/architecture |
|
|
112
|
+
| 5. Planning | `pa:plan` | Create implementation plan |
|
|
113
|
+
| 6. Implementation | `pa:implement` | Write code |
|
|
114
|
+
| 7. Testing | `pa:test` | Create/run tests |
|
|
115
|
+
| 8. Review | `pa:review` | Quality check |
|
|
116
|
+
| 9. Documentation | `pa:doc` | Update docs |
|
|
117
|
+
| 10. Deployment | `pa:deploy` | Prepare release |
|
|
61
118
|
|
|
62
119
|
## Save Locations
|
|
63
120
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"checkpoints": [],
|
|
3
|
+
"_comment": "Checkpoints are created with pa:checkpoint command",
|
|
4
|
+
"_format": {
|
|
5
|
+
"id": "cp-001",
|
|
6
|
+
"timestamp": "2024-03-06T15:00:00Z",
|
|
7
|
+
"commit": "abc123def",
|
|
8
|
+
"description": "Before major refactor",
|
|
9
|
+
"feature": "feature-name",
|
|
10
|
+
"phase": "implementation",
|
|
11
|
+
"created_by": "Claude:opus-4"
|
|
12
|
+
}
|
|
13
|
+
}
|
|
@@ -1,174 +1,69 @@
|
|
|
1
|
-
# Metrics
|
|
1
|
+
# Code Metrics
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This folder contains code quality metrics and reports.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Commands
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- `pa:metrics` - Show current code quality metrics
|
|
8
|
+
- `pa:metrics-history` - Show metrics over time
|
|
9
|
+
- `pa:coverage` - Show test coverage report
|
|
10
|
+
- `pa:coverage-diff` - Show coverage changes
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
## Files
|
|
10
13
|
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Available Metrics
|
|
14
|
-
|
|
15
|
-
| Category | Document | Description |
|
|
16
|
-
|----------|----------|-------------|
|
|
17
|
-
| [Developer Productivity](./developer-productivity.md) | Velocity, cycle time, throughput | Track team and individual efficiency |
|
|
18
|
-
| [Code Quality KPIs](./code-quality-kpis.md) | Coverage, complexity, debt | Measure code health over time |
|
|
19
|
-
| [Deployment Metrics](./deployment-metrics.md) | DORA, frequency, stability | Track delivery performance |
|
|
20
|
-
| [Learning Effectiveness](./learning-effectiveness.md) | Adoption, improvement rates | Measure workflow optimization |
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Quick Start
|
|
25
|
-
|
|
26
|
-
### Enable Metrics Collection
|
|
27
|
-
|
|
28
|
-
```yaml
|
|
29
|
-
# proagents.config.yaml
|
|
30
|
-
metrics:
|
|
31
|
-
enabled: true
|
|
32
|
-
|
|
33
|
-
collection:
|
|
34
|
-
developer_productivity: true
|
|
35
|
-
code_quality: true
|
|
36
|
-
deployment: true
|
|
37
|
-
learning: true
|
|
38
|
-
|
|
39
|
-
storage:
|
|
40
|
-
type: "local" # local, database, api
|
|
41
|
-
path: ".proagents/metrics/"
|
|
42
|
-
retention_days: 90
|
|
43
|
-
|
|
44
|
-
reporting:
|
|
45
|
-
schedule: "weekly" # daily, weekly, monthly
|
|
46
|
-
format: "markdown" # markdown, json, html
|
|
47
|
-
output: "./reports/"
|
|
48
14
|
```
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
# View current metrics dashboard
|
|
56
|
-
pa:metrics dashboard
|
|
57
|
-
|
|
58
|
-
# Generate weekly report
|
|
59
|
-
pa:metrics report --period weekly
|
|
60
|
-
|
|
61
|
-
# View specific category
|
|
62
|
-
pa:metrics productivity
|
|
63
|
-
pa:metrics quality
|
|
64
|
-
pa:metrics deployment
|
|
65
|
-
|
|
66
|
-
# Export metrics
|
|
67
|
-
pa:metrics export --format json --output ./metrics.json
|
|
15
|
+
metrics/
|
|
16
|
+
├── latest.json # Most recent metrics snapshot
|
|
17
|
+
├── history/ # Historical metrics
|
|
18
|
+
│ ├── 2024-03-01.json
|
|
19
|
+
│ └── 2024-03-15.json
|
|
20
|
+
└── README.md
|
|
68
21
|
```
|
|
69
22
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
### With CI/CD
|
|
106
|
-
|
|
107
|
-
```yaml
|
|
108
|
-
# .github/workflows/metrics.yml
|
|
109
|
-
- name: Collect ProAgents Metrics
|
|
110
|
-
run: |
|
|
111
|
-
proagents metrics collect \
|
|
112
|
-
--coverage ./coverage/lcov.info \
|
|
113
|
-
--tests ./test-results.xml \
|
|
114
|
-
--commit ${{ github.sha }}
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
### With Dashboards
|
|
118
|
-
|
|
119
|
-
```yaml
|
|
120
|
-
# Export to external dashboards
|
|
121
|
-
metrics:
|
|
122
|
-
export:
|
|
123
|
-
grafana:
|
|
124
|
-
enabled: true
|
|
125
|
-
endpoint: "${GRAFANA_URL}"
|
|
126
|
-
datadog:
|
|
127
|
-
enabled: true
|
|
128
|
-
api_key: "${DD_API_KEY}"
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
## Reports
|
|
134
|
-
|
|
135
|
-
### Weekly Summary Template
|
|
136
|
-
|
|
137
|
-
```markdown
|
|
138
|
-
## Development Metrics - Week {{week}}
|
|
139
|
-
|
|
140
|
-
### Productivity
|
|
141
|
-
- Features Completed: {{features_completed}}
|
|
142
|
-
- Average Cycle Time: {{avg_cycle_time}}
|
|
143
|
-
- Throughput Trend: {{throughput_trend}}
|
|
144
|
-
|
|
145
|
-
### Code Quality
|
|
146
|
-
- Test Coverage: {{coverage}}% ({{coverage_trend}})
|
|
147
|
-
- New Technical Debt: {{new_debt}}
|
|
148
|
-
- Debt Resolved: {{resolved_debt}}
|
|
149
|
-
|
|
150
|
-
### Deployment
|
|
151
|
-
- Deployments: {{deployment_count}}
|
|
152
|
-
- Success Rate: {{success_rate}}%
|
|
153
|
-
- Average Lead Time: {{avg_lead_time}}
|
|
154
|
-
|
|
155
|
-
### Highlights
|
|
156
|
-
{{#each highlights}}
|
|
157
|
-
- {{this}}
|
|
158
|
-
{{/each}}
|
|
159
|
-
|
|
160
|
-
### Action Items
|
|
161
|
-
{{#each actions}}
|
|
162
|
-
- [ ] {{this}}
|
|
163
|
-
{{/each}}
|
|
23
|
+
## Metrics Format
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"timestamp": "2024-03-06T15:00:00Z",
|
|
28
|
+
"generated_by": "Claude:opus-4",
|
|
29
|
+
"summary": {
|
|
30
|
+
"total_files": 45,
|
|
31
|
+
"total_lines": 12500,
|
|
32
|
+
"languages": {
|
|
33
|
+
"typescript": 10200,
|
|
34
|
+
"javascript": 1500,
|
|
35
|
+
"css": 800
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"quality": {
|
|
39
|
+
"complexity": {
|
|
40
|
+
"average": 4.2,
|
|
41
|
+
"max": 15,
|
|
42
|
+
"high_complexity_files": ["src/utils/parser.ts"]
|
|
43
|
+
},
|
|
44
|
+
"duplication": {
|
|
45
|
+
"percentage": 3.5,
|
|
46
|
+
"duplicated_blocks": 12
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"coverage": {
|
|
50
|
+
"overall": 82,
|
|
51
|
+
"by_module": {
|
|
52
|
+
"src/auth": 95,
|
|
53
|
+
"src/api": 78,
|
|
54
|
+
"src/utils": 65
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
164
58
|
```
|
|
165
59
|
|
|
166
|
-
|
|
60
|
+
## Thresholds
|
|
167
61
|
|
|
168
|
-
|
|
62
|
+
Default thresholds (customize in proagents.config.yaml):
|
|
169
63
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
64
|
+
| Metric | Warning | Error |
|
|
65
|
+
|--------|---------|-------|
|
|
66
|
+
| Coverage | < 70% | < 50% |
|
|
67
|
+
| Complexity | > 10 | > 20 |
|
|
68
|
+
| File size | > 300 lines | > 500 lines |
|
|
69
|
+
| Duplication | > 5% | > 10% |
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Sprints
|
|
2
|
+
|
|
3
|
+
This folder contains sprint tracking files.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
- `pa:sprint-start` - Start a new sprint
|
|
8
|
+
- `pa:sprint-end` - End sprint with summary
|
|
9
|
+
- `pa:sprint-status` - Show current sprint status
|
|
10
|
+
- `pa:velocity` - Show velocity metrics
|
|
11
|
+
|
|
12
|
+
## File Structure
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
sprints/
|
|
16
|
+
├── sprint-1.json # Sprint data
|
|
17
|
+
├── sprint-1-summary.md # Sprint summary (generated on end)
|
|
18
|
+
├── sprint-2.json
|
|
19
|
+
└── sprint-2-summary.md
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Sprint File Format
|
|
23
|
+
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"sprint_number": 1,
|
|
27
|
+
"name": "Sprint 1",
|
|
28
|
+
"start_date": "2024-03-01",
|
|
29
|
+
"end_date": "2024-03-15",
|
|
30
|
+
"status": "active",
|
|
31
|
+
"goals": [
|
|
32
|
+
"Complete user authentication",
|
|
33
|
+
"Add dashboard UI"
|
|
34
|
+
],
|
|
35
|
+
"features": [
|
|
36
|
+
{
|
|
37
|
+
"name": "user-auth",
|
|
38
|
+
"status": "completed",
|
|
39
|
+
"points": 8
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "dashboard",
|
|
43
|
+
"status": "in_progress",
|
|
44
|
+
"points": 5
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"metrics": {
|
|
48
|
+
"planned_points": 13,
|
|
49
|
+
"completed_points": 8,
|
|
50
|
+
"velocity": 8
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Velocity Tracking
|
|
56
|
+
|
|
57
|
+
Velocity is calculated as the average story points completed per sprint.
|
|
58
|
+
Use `pa:velocity` to see trends over time.
|