proagents 1.6.15 → 1.6.16
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 +51 -498
- package/bin/proagents.js +9 -1
- package/lib/commands/version.js +25 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,15 @@ A portable, universal development workflow framework that works with **any AI pl
|
|
|
9
9
|
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
+
## Why ProAgents?
|
|
13
|
+
|
|
14
|
+
- **AI-Agnostic**: Works with Claude, ChatGPT, Gemini, Cursor, Copilot - switch AI tools anytime without losing context
|
|
15
|
+
- **Multi-AI Collaboration**: Multiple AIs can work on the same project with shared context and conflict detection
|
|
16
|
+
- **Guided Workflow**: 10-phase development process from Analysis to Deployment with quality gates
|
|
17
|
+
- **Learning System**: AI learns from your corrections and never repeats the same mistakes
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
12
21
|
## Installation
|
|
13
22
|
|
|
14
23
|
No install required. Just run:
|
|
@@ -23,20 +32,6 @@ Or with a template:
|
|
|
23
32
|
npx proagents init --template nextjs-saas
|
|
24
33
|
```
|
|
25
34
|
|
|
26
|
-
### Upgrading from v1.5.x
|
|
27
|
-
|
|
28
|
-
Version 1.6.0 renamed `proagents/` to `.proagents/` (following `.github`, `.vscode` convention).
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
cd your-project
|
|
32
|
-
npx proagents migrate
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
**What migration does:**
|
|
36
|
-
- Renames `proagents/` → `.proagents/`
|
|
37
|
-
- Updates paths in `README.md`, `CLAUDE.md`, `.cursorrules`
|
|
38
|
-
- Preserves all your existing configurations
|
|
39
|
-
|
|
40
35
|
---
|
|
41
36
|
|
|
42
37
|
## Quick Start
|
|
@@ -48,26 +43,37 @@ cd your-project
|
|
|
48
43
|
npx proagents init
|
|
49
44
|
```
|
|
50
45
|
|
|
51
|
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
46
|
+
**What happens:**
|
|
47
|
+
- Creates `./.proagents/` folder with workflow files
|
|
48
|
+
- Prompts for project name and type (auto-detected)
|
|
49
|
+
- Prompts for tech stack (API style, database, styling, auth)
|
|
50
|
+
- Creates AI instruction files (CLAUDE.md, .cursorrules, etc.)
|
|
55
51
|
|
|
56
52
|
### 2. Use Commands in Any AI
|
|
57
53
|
|
|
58
|
-
|
|
54
|
+
Open your AI assistant (Claude, ChatGPT, Cursor, etc.) and type:
|
|
59
55
|
|
|
60
56
|
```
|
|
61
57
|
pa:feature "Add user authentication"
|
|
62
|
-
pa:fix "Login button not working"
|
|
63
|
-
pa:status
|
|
64
58
|
```
|
|
65
59
|
|
|
66
|
-
|
|
60
|
+
**What happens:**
|
|
61
|
+
- AI loads project context automatically
|
|
62
|
+
- Guides you through 10-phase workflow
|
|
63
|
+
- Logs all changes for other AIs to see
|
|
64
|
+
|
|
65
|
+
### 3. See Progress
|
|
67
66
|
|
|
68
67
|
```
|
|
69
|
-
|
|
70
|
-
|
|
68
|
+
pa:status
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
**Example output:**
|
|
72
|
+
```
|
|
73
|
+
Feature: Add user authentication
|
|
74
|
+
Phase: Implementation (5/10)
|
|
75
|
+
Progress: ████████░░░░ 50%
|
|
76
|
+
Next: pa:test
|
|
71
77
|
```
|
|
72
78
|
|
|
73
79
|
---
|
|
@@ -155,426 +161,48 @@ ProAgents follows **"ALWAYS DO, NEVER JUST TELL"** principle:
|
|
|
155
161
|
## CLI Commands
|
|
156
162
|
|
|
157
163
|
```bash
|
|
158
|
-
#
|
|
159
|
-
npx proagents init # Initialize
|
|
164
|
+
# Initialize
|
|
165
|
+
npx proagents init # Initialize or update ProAgents
|
|
160
166
|
npx proagents init --template <name> # Use a project template
|
|
161
|
-
npx proagents init --list-templates # List available templates
|
|
162
|
-
|
|
163
|
-
# Features & Fixes
|
|
164
|
-
proagents feature start "name" # Start a new feature
|
|
165
|
-
proagents feature status # Check feature status
|
|
166
|
-
proagents fix "bug description" # Quick bug fix mode
|
|
167
167
|
|
|
168
|
-
#
|
|
169
|
-
proagents doctor # Health check installation
|
|
170
|
-
proagents doctor --full # Extended checks (branches, logs, features)
|
|
168
|
+
# Daily Use
|
|
171
169
|
proagents status # Show ProAgents status
|
|
172
|
-
proagents
|
|
173
|
-
|
|
174
|
-
# Release Notes
|
|
175
|
-
proagents release # Interactive release note generator
|
|
176
|
-
proagents release -t detailed # Full comprehensive notes
|
|
177
|
-
proagents release -t short # Quick summary
|
|
178
|
-
proagents release -t client # Business-focused, non-technical
|
|
179
|
-
proagents release -t developer # Technical details for devs
|
|
180
|
-
proagents release -t hotfix # Urgent patch notes
|
|
181
|
-
proagents release -t prerelease # Beta/RC notes
|
|
182
|
-
proagents release --include fixes # Only include bug fixes
|
|
183
|
-
proagents release --include features # Only include features
|
|
184
|
-
proagents release --append -o FILE # Append to existing notes
|
|
185
|
-
proagents release --bump # Suggest version bump
|
|
186
|
-
proagents release --module auth # Filter by module name
|
|
187
|
-
proagents release --changelog # Update CHANGELOG.md
|
|
188
|
-
proagents release --tag # Create git tag
|
|
189
|
-
proagents release --json # JSON output for CI/CD
|
|
190
|
-
|
|
191
|
-
# Updating ProAgents
|
|
192
|
-
npx proagents init # Smart update (recommended)
|
|
193
|
-
proagents upgrade # Full replace (use with caution)
|
|
170
|
+
proagents doctor # Health check installation
|
|
171
|
+
proagents stats # Show project & AI usage stats
|
|
194
172
|
|
|
195
173
|
# AI Platforms
|
|
196
174
|
proagents ai list # List installed AI platforms
|
|
197
175
|
proagents ai add # Add more platforms
|
|
198
|
-
proagents ai remove # Remove platforms
|
|
199
176
|
|
|
200
|
-
#
|
|
201
|
-
proagents
|
|
202
|
-
proagents
|
|
203
|
-
proagents config export # Export config for sharing
|
|
204
|
-
proagents config import <file> # Import config from file
|
|
205
|
-
|
|
206
|
-
# Statistics & Monitoring
|
|
207
|
-
proagents stats # Show project & AI usage stats
|
|
208
|
-
proagents stats --json # JSON output for scripting
|
|
209
|
-
|
|
210
|
-
# Changelog Management
|
|
211
|
-
proagents changelog view # View recent changelog entries
|
|
212
|
-
proagents changelog add "entry" # Add new changelog entry
|
|
213
|
-
proagents changelog list # List available changelogs
|
|
214
|
-
proagents changelog export # Export to CHANGELOG.md
|
|
215
|
-
proagents changelog git # View git history as changelog
|
|
216
|
-
|
|
217
|
-
# Backup & Restore
|
|
218
|
-
proagents restore <backup.json> # Restore from uninstall backup
|
|
219
|
-
|
|
220
|
-
# Shell Completions
|
|
221
|
-
proagents completion bash # Generate bash completions
|
|
222
|
-
proagents completion zsh # Generate zsh completions
|
|
223
|
-
proagents completion fish # Generate fish completions
|
|
224
|
-
|
|
225
|
-
# Quick File Access
|
|
226
|
-
proagents open # Show available shortcuts
|
|
227
|
-
proagents open config # Open proagents.config.yaml
|
|
228
|
-
proagents open changelog # Open recent changelog
|
|
229
|
-
proagents open activity # Open activity log
|
|
230
|
-
proagents open context # Open worklog context
|
|
231
|
-
|
|
232
|
-
# Other
|
|
233
|
-
proagents docs # Open documentation
|
|
234
|
-
proagents commands # Show all commands
|
|
235
|
-
proagents uninstall # Remove ProAgents
|
|
177
|
+
# Release
|
|
178
|
+
proagents release # Generate release notes
|
|
179
|
+
proagents release --changelog # Update CHANGELOG.md
|
|
236
180
|
```
|
|
237
181
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
| Command | What It Does | When to Use |
|
|
241
|
-
|---------|--------------|-------------|
|
|
242
|
-
| `npx proagents init` | **Smart update** - Updates 60 framework folders, merges config, preserves your work | **Recommended** for regular updates |
|
|
243
|
-
| `proagents upgrade` | **Full replace** - Removes everything, installs fresh, restores backups | Only when you need a complete reset |
|
|
244
|
-
|
|
245
|
-
**What's preserved with `init` (smart update):**
|
|
246
|
-
- `active-features/` - Your work in progress
|
|
247
|
-
- `changelog/` - Your change history (_recent.md, modules/, features/)
|
|
248
|
-
- `worklog/` - Your work context (_context.md, ai-stats.json)
|
|
249
|
-
- `.learning/` - Learned patterns
|
|
250
|
-
- `cache/` - Analysis cache
|
|
251
|
-
- `proagents.config.yaml` - Your values kept, new options merged
|
|
252
|
-
|
|
253
|
-
**What's preserved with `upgrade` (full replace):**
|
|
254
|
-
- `proagents.config.yaml`, `activity.log`, `handoff.md`, `.lock`
|
|
255
|
-
- `active-features/` - All files
|
|
256
|
-
- `changelog/` - _recent.md, modules/, features/, yearly folders
|
|
257
|
-
- `worklog/` - _context.md, ai-stats.json
|
|
182
|
+
Run `proagents commands` for the full list of CLI commands.
|
|
258
183
|
|
|
259
184
|
---
|
|
260
185
|
|
|
261
|
-
## AI Commands (pa:)
|
|
186
|
+
## Essential AI Commands (pa:)
|
|
262
187
|
|
|
263
188
|
Type these in any AI assistant (Claude, ChatGPT, Gemini, Cursor, etc.):
|
|
264
189
|
|
|
265
|
-
### Quick Aliases
|
|
266
|
-
| Alias | Expands To |
|
|
267
|
-
|-------|------------|
|
|
268
|
-
| `pa:f` | `pa:feature` |
|
|
269
|
-
| `pa:s` | `pa:status` |
|
|
270
|
-
| `pa:h` | `pa:help` |
|
|
271
|
-
| `pa:d` | `pa:doc` |
|
|
272
|
-
| `pa:t` | `pa:test` |
|
|
273
|
-
| `pa:q` | `pa:qa` |
|
|
274
|
-
| `pa:a` | `pa:analyze` |
|
|
275
|
-
| `pa:r` | `pa:requirements` |
|
|
276
|
-
| `pa:p` | `pa:plan` |
|
|
277
|
-
| `pa:i` | `pa:implement` |
|
|
278
|
-
| `pa:rev` | `pa:review` |
|
|
279
|
-
| `pa:dbg` | `pa:debug` |
|
|
280
|
-
| `pa:l` | `pa:logs` |
|
|
281
|
-
|
|
282
|
-
### Core Commands
|
|
283
190
|
| Command | Description |
|
|
284
191
|
|---------|-------------|
|
|
285
192
|
| `pa:feature "name"` | Start new feature workflow (all phases) |
|
|
286
193
|
| `pa:fix "description"` | Quick bug fix mode |
|
|
287
194
|
| `pa:status` | Show current progress |
|
|
195
|
+
| `pa:sync` | Load project context (usually auto) |
|
|
196
|
+
| `pa:test` | Run tests |
|
|
197
|
+
| `pa:review` | Code review workflow |
|
|
198
|
+
| `pa:deploy` | Deployment preparation |
|
|
288
199
|
| `pa:help` | Show all commands |
|
|
200
|
+
| `pa:undo-last` | Revert last AI's changes |
|
|
201
|
+
| `pa:handoff` | Create notes for another AI |
|
|
289
202
|
|
|
290
|
-
|
|
291
|
-
| Command | Phase | Description |
|
|
292
|
-
|---------|-------|-------------|
|
|
293
|
-
| `pa:analyze` | Analysis | Deep codebase analysis |
|
|
294
|
-
| `pa:requirements` | Requirements | Gather feature requirements |
|
|
295
|
-
| `pa:design` | Design | UI/Architecture design |
|
|
296
|
-
| `pa:plan` | Planning | Create implementation plan |
|
|
297
|
-
| `pa:implement` | Implementation | Execute code changes |
|
|
298
|
-
| `pa:test` | Testing | Create and run tests |
|
|
299
|
-
| `pa:review` | Review | Code review workflow |
|
|
300
|
-
| `pa:doc` | Documentation | Generate documentation |
|
|
301
|
-
| `pa:deploy` | Deployment | Deployment preparation |
|
|
302
|
-
|
|
303
|
-
### Documentation
|
|
304
|
-
| Command | Description |
|
|
305
|
-
|---------|-------------|
|
|
306
|
-
| `pa:doc` | Generate documentation |
|
|
307
|
-
| `pa:changelog` | Update CHANGELOG.md |
|
|
308
|
-
| `pa:release` | Generate release notes |
|
|
203
|
+
**Quick aliases:** `pa:f` (feature), `pa:s` (status), `pa:t` (test), `pa:h` (help)
|
|
309
204
|
|
|
310
|
-
|
|
311
|
-
| Command | Description |
|
|
312
|
-
|---------|-------------|
|
|
313
|
-
| `pa:qa` | Run quality assurance checks |
|
|
314
|
-
| `pa:rollback` | Rollback procedures |
|
|
315
|
-
|
|
316
|
-
### Cross-AI Continuity
|
|
317
|
-
| Command | Description |
|
|
318
|
-
|---------|-------------|
|
|
319
|
-
| `pa:sync` | **Run first** - Load project context |
|
|
320
|
-
| `pa:resume` | Quick resume - shows last session + next action |
|
|
321
|
-
| `pa:session-start` | Begin new work session |
|
|
322
|
-
| `pa:session-end` | Finalize session, update logs |
|
|
323
|
-
| `pa:conflict-check` | Check if files modified by other AI |
|
|
324
|
-
| `pa:undo-last` | Undo last AI's entire session (revert all changes) |
|
|
325
|
-
| `pa:undo-file "path"` | Undo changes to specific file |
|
|
326
|
-
| `pa:changelog` | Update all changelogs |
|
|
327
|
-
| `pa:changelog --from-git` | Auto-populate from git commits |
|
|
328
|
-
| `pa:changelog-feature X` | View feature changelog |
|
|
329
|
-
| `pa:changelog-module X` | View module changelog |
|
|
330
|
-
| `pa:history` | View command history |
|
|
331
|
-
| `pa:activity` | Show recent AI activity |
|
|
332
|
-
| `pa:handoff` | Create handoff notes |
|
|
333
|
-
|
|
334
|
-
### Learning & Tracking
|
|
335
|
-
| Command | Description |
|
|
336
|
-
|---------|-------------|
|
|
337
|
-
| `pa:decision "title"` | Log architectural decision |
|
|
338
|
-
| `pa:decisions` | Show all decisions |
|
|
339
|
-
| `pa:error "description"` | Log error and solution |
|
|
340
|
-
| `pa:errors` | Search past errors |
|
|
341
|
-
| `pa:feedback "description"` | Log feedback for AI learning |
|
|
342
|
-
|
|
343
|
-
### AI Platform Management
|
|
344
|
-
| Command | Description |
|
|
345
|
-
|---------|-------------|
|
|
346
|
-
| `pa:ai-list` | List installed AI platforms |
|
|
347
|
-
| `pa:ai-add` | Add more AI platforms |
|
|
348
|
-
| `pa:ai-sync` | Sync config with files |
|
|
349
|
-
|
|
350
|
-
### Navigation & Flow
|
|
351
|
-
| Command | Description |
|
|
352
|
-
|---------|-------------|
|
|
353
|
-
| `pa:next` | Show next step in workflow |
|
|
354
|
-
| `pa:resume` | Resume paused feature |
|
|
355
|
-
| `pa:skip` | Skip current phase |
|
|
356
|
-
| `pa:back` | Go to previous phase |
|
|
357
|
-
| `pa:progress` | Show visual progress bar |
|
|
358
|
-
|
|
359
|
-
### Context & History
|
|
360
|
-
| Command | Description |
|
|
361
|
-
|---------|-------------|
|
|
362
|
-
| `pa:context` | View project context |
|
|
363
|
-
| `pa:diff` | Show changes since last session |
|
|
364
|
-
| `pa:history` | Show command history |
|
|
365
|
-
| `pa:checkpoint` | Create restore point |
|
|
366
|
-
| `pa:undo` | Undo last action |
|
|
367
|
-
|
|
368
|
-
### Sprint & Estimation
|
|
369
|
-
| Command | Description |
|
|
370
|
-
|---------|-------------|
|
|
371
|
-
| `pa:sprint-start` | Start new sprint |
|
|
372
|
-
| `pa:sprint-end` | End sprint with summary |
|
|
373
|
-
| `pa:estimate` | Estimate task complexity |
|
|
374
|
-
| `pa:velocity` | Show velocity metrics |
|
|
375
|
-
|
|
376
|
-
### Integration
|
|
377
|
-
| Command | Description |
|
|
378
|
-
|---------|-------------|
|
|
379
|
-
| `pa:github` | GitHub integration |
|
|
380
|
-
| `pa:github-pr` | Create pull request |
|
|
381
|
-
| `pa:jira` | Sync with Jira |
|
|
382
|
-
| `pa:notify` | Send notification |
|
|
383
|
-
|
|
384
|
-
### Code Quality
|
|
385
|
-
| Command | Description |
|
|
386
|
-
|---------|-------------|
|
|
387
|
-
| `pa:metrics` | Code quality metrics |
|
|
388
|
-
| `pa:coverage` | Test coverage report |
|
|
389
|
-
| `pa:deps` | Analyze dependencies |
|
|
390
|
-
| `pa:deps-outdated` | Find outdated packages |
|
|
391
|
-
| `pa:deps-security` | Security scan |
|
|
392
|
-
|
|
393
|
-
### Code Generation
|
|
394
|
-
| Command | Description |
|
|
395
|
-
|---------|-------------|
|
|
396
|
-
| `pa:generate` | Show generation options |
|
|
397
|
-
| `pa:generate-component` | Generate component |
|
|
398
|
-
| `pa:generate-api` | Generate API endpoint |
|
|
399
|
-
| `pa:generate-test` | Generate test file |
|
|
400
|
-
|
|
401
|
-
### Refactoring
|
|
402
|
-
| Command | Description |
|
|
403
|
-
|---------|-------------|
|
|
404
|
-
| `pa:refactor` | Suggest refactoring |
|
|
405
|
-
| `pa:rename` | Rename across codebase |
|
|
406
|
-
| `pa:extract` | Extract function/component |
|
|
407
|
-
| `pa:cleanup` | Remove dead code |
|
|
408
|
-
|
|
409
|
-
### Time Tracking
|
|
410
|
-
| Command | Description |
|
|
411
|
-
|---------|-------------|
|
|
412
|
-
| `pa:time-start` | Start time tracking |
|
|
413
|
-
| `pa:time-stop` | Stop tracking |
|
|
414
|
-
| `pa:time-report` | Show time report |
|
|
415
|
-
|
|
416
|
-
### Environment & Database
|
|
417
|
-
| Command | Description |
|
|
418
|
-
|---------|-------------|
|
|
419
|
-
| `pa:env-check` | Verify environment |
|
|
420
|
-
| `pa:secrets-scan` | Scan for secrets |
|
|
421
|
-
| `pa:db-migrate` | Run migrations |
|
|
422
|
-
| `pa:db-seed` | Seed database |
|
|
423
|
-
|
|
424
|
-
### Accessibility & Performance
|
|
425
|
-
| Command | Description |
|
|
426
|
-
|---------|-------------|
|
|
427
|
-
| `pa:a11y` | Accessibility audit |
|
|
428
|
-
| `pa:lighthouse` | Lighthouse audit |
|
|
429
|
-
| `pa:perf` | Performance analysis |
|
|
430
|
-
|
|
431
|
-
### Export & Learning
|
|
432
|
-
| Command | Description |
|
|
433
|
-
|---------|-------------|
|
|
434
|
-
| `pa:export` | Export config/data |
|
|
435
|
-
| `pa:import` | Import data |
|
|
436
|
-
| `pa:backup` | Backup proagents |
|
|
437
|
-
| `pa:learn` | Teach AI a pattern |
|
|
438
|
-
| `pa:suggestions` | Show AI suggestions |
|
|
439
|
-
|
|
440
|
-
### API & Documentation
|
|
441
|
-
| Command | Description |
|
|
442
|
-
|---------|-------------|
|
|
443
|
-
| `pa:api-docs` | Generate OpenAPI/Swagger docs |
|
|
444
|
-
| `pa:storybook` | Generate Storybook stories |
|
|
445
|
-
| `pa:readme` | Auto-generate/update README |
|
|
446
|
-
| `pa:types` | Generate TypeScript types |
|
|
447
|
-
|
|
448
|
-
### Git Advanced
|
|
449
|
-
| Command | Description |
|
|
450
|
-
|---------|-------------|
|
|
451
|
-
| `pa:branch` | Branch management |
|
|
452
|
-
| `pa:merge` | Smart merge with conflict preview |
|
|
453
|
-
| `pa:conflict` | Resolve merge conflicts with AI |
|
|
454
|
-
| `pa:changelog-gen` | Auto-generate changelog |
|
|
455
|
-
|
|
456
|
-
### Search & Code Navigation
|
|
457
|
-
| Command | Description |
|
|
458
|
-
|---------|-------------|
|
|
459
|
-
| `pa:find` | Find code patterns/usage |
|
|
460
|
-
| `pa:todo` | Find all TODOs in code |
|
|
461
|
-
| `pa:fixme` | Find FIXMEs and critical issues |
|
|
462
|
-
| `pa:unused` | Find unused code/exports |
|
|
463
|
-
|
|
464
|
-
### Code Analysis
|
|
465
|
-
| Command | Description |
|
|
466
|
-
|---------|-------------|
|
|
467
|
-
| `pa:complexity` | Cyclomatic complexity analysis |
|
|
468
|
-
| `pa:duplication` | Find duplicate code blocks |
|
|
469
|
-
| `pa:hotspots` | Find frequently changed files |
|
|
470
|
-
|
|
471
|
-
### Debug & Logs
|
|
472
|
-
| Command | Description |
|
|
473
|
-
|---------|-------------|
|
|
474
|
-
| `pa:debug` | Start debug session |
|
|
475
|
-
| `pa:debug-add` | Add debug logs to code |
|
|
476
|
-
| `pa:debug-add "file"` | Add logs to specific file |
|
|
477
|
-
| `pa:debug-trace "func"` | Add entry/exit logs to function |
|
|
478
|
-
| `pa:debug-var "var"` | Track variable changes |
|
|
479
|
-
| `pa:debug-api` | Add API request/response logging |
|
|
480
|
-
| `pa:debug-state` | Add state change logging |
|
|
481
|
-
| `pa:debug-error` | Add error boundary logging |
|
|
482
|
-
| `pa:debug-web` | Web console debugging |
|
|
483
|
-
| `pa:debug-rn` | React Native debugging |
|
|
484
|
-
| `pa:debug-android` | Android native (logcat) |
|
|
485
|
-
| `pa:debug-ios` | iOS native debugging |
|
|
486
|
-
| `pa:logs` | View recent logs |
|
|
487
|
-
| `pa:logs-filter "term"` | Filter logs by term |
|
|
488
|
-
| `pa:debug-clean` | Remove all debug statements |
|
|
489
|
-
|
|
490
|
-
### Testing Advanced
|
|
491
|
-
| Command | Description |
|
|
492
|
-
|---------|-------------|
|
|
493
|
-
| `pa:test-e2e` | Create/run E2E tests |
|
|
494
|
-
| `pa:test-unit` | Generate unit tests |
|
|
495
|
-
| `pa:mock` | Generate mocks/stubs |
|
|
496
|
-
| `pa:snapshot` | Snapshot testing management |
|
|
497
|
-
|
|
498
|
-
### DevOps & Infrastructure
|
|
499
|
-
| Command | Description |
|
|
500
|
-
|---------|-------------|
|
|
501
|
-
| `pa:docker` | Docker commands |
|
|
502
|
-
| `pa:ci` | CI/CD pipeline management |
|
|
503
|
-
| `pa:deploy-preview` | Deploy preview environment |
|
|
504
|
-
|
|
505
|
-
### Release Management
|
|
506
|
-
| Command | Description |
|
|
507
|
-
|---------|-------------|
|
|
508
|
-
| `pa:version` | Show/bump version |
|
|
509
|
-
| `pa:tag` | Create git tag |
|
|
510
|
-
| `pa:publish` | Publish package to registry |
|
|
511
|
-
|
|
512
|
-
### Code Review & PR
|
|
513
|
-
| Command | Description |
|
|
514
|
-
|---------|-------------|
|
|
515
|
-
| `pa:review-request` | Request code review from team |
|
|
516
|
-
| `pa:review-comments` | Show PR review comments |
|
|
517
|
-
| `pa:review-approve` | Approve current PR |
|
|
518
|
-
|
|
519
|
-
### Architecture
|
|
520
|
-
| Command | Description |
|
|
521
|
-
|---------|-------------|
|
|
522
|
-
| `pa:architecture` | Show architecture overview |
|
|
523
|
-
| `pa:architecture-diagram` | Generate diagram (Mermaid) |
|
|
524
|
-
| `pa:architecture-export` | Export diagram (SVG/PNG) |
|
|
525
|
-
|
|
526
|
-
### API Testing
|
|
527
|
-
| Command | Description |
|
|
528
|
-
|---------|-------------|
|
|
529
|
-
| `pa:api-test` | Test API endpoints |
|
|
530
|
-
| `pa:curl` | Generate curl commands |
|
|
531
|
-
| `pa:postman` | Generate Postman collection |
|
|
532
|
-
|
|
533
|
-
### Health & Monitoring
|
|
534
|
-
| Command | Description |
|
|
535
|
-
|---------|-------------|
|
|
536
|
-
| `pa:health` | Project health check |
|
|
537
|
-
| `pa:monitor` | Show monitoring status |
|
|
538
|
-
| `pa:uptime` | Service uptime check |
|
|
539
|
-
|
|
540
|
-
### Quick Actions
|
|
541
|
-
| Command | Description |
|
|
542
|
-
|---------|-------------|
|
|
543
|
-
| `pa:quick` | Show quick actions menu |
|
|
544
|
-
| `pa:alias` | Manage command aliases |
|
|
545
|
-
| `pa:alias-add` | Add custom alias |
|
|
546
|
-
| `pa:alias-remove` | Remove custom alias |
|
|
547
|
-
|
|
548
|
-
### Platform-Specific Test Suites
|
|
549
|
-
|
|
550
|
-
**Fully automated**: Auto-install tools, run tests, auto-fix failures, loop until all pass.
|
|
551
|
-
|
|
552
|
-
| Command | Description |
|
|
553
|
-
|---------|-------------|
|
|
554
|
-
| `pa:test-mobile` | Full mobile test suite (React Native, Android, iOS, Flutter) |
|
|
555
|
-
| `pa:test-web` | Full web test suite (React/Next.js/Vue) |
|
|
556
|
-
| `pa:test-api` | Full API test suite (Node.js/Python) |
|
|
557
|
-
| `pa:test-visual` | Visual/design comparison testing |
|
|
558
|
-
| `pa:test-auto-fix` | Auto-fix failing tests |
|
|
559
|
-
| `pa:test-loop` | Test → Fix → Retest until all pass |
|
|
560
|
-
| `pa:compare-figma` | Compare UI against Figma design |
|
|
561
|
-
| `pa:compare-image` | Compare UI against image/sketch |
|
|
562
|
-
| `pa:screenshot` | Capture app screenshots |
|
|
563
|
-
|
|
564
|
-
**What these commands do:**
|
|
565
|
-
- Check required tools → Auto-install if missing
|
|
566
|
-
- Run all tests (unit, integration, e2e)
|
|
567
|
-
- Auto-fix failures (no confirmation needed)
|
|
568
|
-
- Loop until all pass or fix is impossible
|
|
569
|
-
|
|
570
|
-
### Custom Commands
|
|
571
|
-
| Command | Description |
|
|
572
|
-
|---------|-------------|
|
|
573
|
-
| `pa:standup` | Generate daily standup |
|
|
574
|
-
| `pa:tech-debt` | Scan for technical debt |
|
|
575
|
-
| `pa:security-scan` | Run security checklist |
|
|
576
|
-
|
|
577
|
-
Define your own in `./.proagents/custom-commands.yaml`
|
|
205
|
+
For the complete command reference (100+ commands), see **[COMMANDS.md](COMMANDS.md)**.
|
|
578
206
|
|
|
579
207
|
---
|
|
580
208
|
|
|
@@ -594,75 +222,10 @@ After initialization, these files help AI understand your project:
|
|
|
594
222
|
|
|
595
223
|
---
|
|
596
224
|
|
|
597
|
-
## Project Structure
|
|
598
|
-
|
|
599
|
-
```
|
|
600
|
-
your-project/
|
|
601
|
-
├── .proagents/
|
|
602
|
-
│ ├── proagents.config.yaml # Project configuration
|
|
603
|
-
│ ├── AI_INSTRUCTIONS.md # Instructions for all AIs
|
|
604
|
-
│ ├── PROAGENTS.md # Quick command reference
|
|
605
|
-
│ ├── context.md # Persistent project context
|
|
606
|
-
│ ├── feedback.md # AI learning from corrections
|
|
607
|
-
│ ├── watchlist.yaml # Protected files
|
|
608
|
-
│ ├── activity.log # AI activity log
|
|
609
|
-
│ ├── decisions.md # Decision log
|
|
610
|
-
│ ├── errors.md # Error tracker
|
|
611
|
-
│ ├── handoff.md # Handoff notes
|
|
612
|
-
│ ├── custom-commands.yaml # Custom pa: commands
|
|
613
|
-
│ ├── worklog/ # Cross-AI session tracking
|
|
614
|
-
│ │ ├── _context.md # Quick context for any AI
|
|
615
|
-
│ │ ├── ai-stats.json # AI performance stats
|
|
616
|
-
│ │ └── YYYY-MM-DD-ai-*.md # Session logs
|
|
617
|
-
│ ├── changelog/ # Detailed changelogs
|
|
618
|
-
│ │ ├── _recent.md # Last 10 changes
|
|
619
|
-
│ │ ├── features/ # Per-feature changelogs
|
|
620
|
-
│ │ └── modules/ # Per-module changelogs
|
|
621
|
-
│ ├── active-features/ # Feature tracking
|
|
622
|
-
│ ├── prompts/ # Workflow prompts
|
|
623
|
-
│ ├── templates/ # Document templates
|
|
624
|
-
│ ├── checklists/ # Quality checklists
|
|
625
|
-
│ └── ...
|
|
626
|
-
├── CLAUDE.md # Claude-specific instructions
|
|
627
|
-
├── .cursorrules # Cursor-specific instructions
|
|
628
|
-
├── GEMINI.md # Gemini-specific instructions
|
|
629
|
-
└── proagents.config.yaml # Main config (project root)
|
|
630
|
-
```
|
|
631
|
-
|
|
632
|
-
---
|
|
633
|
-
|
|
634
|
-
## Configuration
|
|
635
|
-
|
|
636
|
-
`proagents.config.yaml` stores your project settings:
|
|
637
|
-
|
|
638
|
-
```yaml
|
|
639
|
-
project:
|
|
640
|
-
name: my-app
|
|
641
|
-
type: nextjs
|
|
642
|
-
|
|
643
|
-
automation:
|
|
644
|
-
decisions:
|
|
645
|
-
architecture:
|
|
646
|
-
api_style: rest
|
|
647
|
-
state_management: zustand
|
|
648
|
-
styling: tailwind
|
|
649
|
-
database: postgresql
|
|
650
|
-
orm: prisma
|
|
651
|
-
auth_method: jwt
|
|
652
|
-
testing:
|
|
653
|
-
framework: vitest
|
|
654
|
-
coverage_target: 80
|
|
655
|
-
|
|
656
|
-
platforms:
|
|
657
|
-
- claude
|
|
658
|
-
- cursor
|
|
659
|
-
- copilot
|
|
660
|
-
```
|
|
661
|
-
|
|
662
|
-
---
|
|
663
|
-
|
|
664
225
|
## Supported AI Platforms
|
|
665
226
|
|
|
227
|
+
ProAgents works with **any AI that has agentic capability** (can read files and execute commands). Pre-configured instruction files are available for:
|
|
228
|
+
|
|
666
229
|
| Platform | Instruction File |
|
|
667
230
|
|----------|-----------------|
|
|
668
231
|
| Claude Code | `CLAUDE.md` |
|
|
@@ -677,17 +240,7 @@ platforms:
|
|
|
677
240
|
| Kiro | `KIRO.md` |
|
|
678
241
|
| Groq | `GROQ.md` |
|
|
679
242
|
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
## Integrations
|
|
683
|
-
|
|
684
|
-
**Project Management:** Jira, Linear, GitHub Issues, GitLab Issues, Asana, Trello, Notion
|
|
685
|
-
|
|
686
|
-
**Version Control:** GitHub, GitLab
|
|
687
|
-
|
|
688
|
-
**Communication:** Slack
|
|
689
|
-
|
|
690
|
-
**CI/CD:** GitHub Actions, GitLab CI, Jenkins, Azure DevOps
|
|
243
|
+
**Using a different AI?** Point it to `.proagents/AI_INSTRUCTIONS.md` - it contains everything needed to work with ProAgents.
|
|
691
244
|
|
|
692
245
|
---
|
|
693
246
|
|
package/bin/proagents.js
CHANGED
|
@@ -12,7 +12,7 @@ import { configListCommand, configShowCommand, configEditCommand, configSetComma
|
|
|
12
12
|
import { doctorCommand } from '../lib/commands/doctor.js';
|
|
13
13
|
import { upgradeCommand } from '../lib/commands/upgrade.js';
|
|
14
14
|
import { migrateCommand } from '../lib/commands/migrate.js';
|
|
15
|
-
import { versionCommand } from '../lib/commands/version.js';
|
|
15
|
+
import { versionCommand, checkForUpdates } from '../lib/commands/version.js';
|
|
16
16
|
import { releaseCommand } from '../lib/commands/release.js';
|
|
17
17
|
import { statsCommand } from '../lib/commands/stats.js';
|
|
18
18
|
import { restoreCommand } from '../lib/commands/restore.js';
|
|
@@ -314,3 +314,11 @@ program
|
|
|
314
314
|
.action(openCommand);
|
|
315
315
|
|
|
316
316
|
program.parse();
|
|
317
|
+
|
|
318
|
+
// Check for updates after command completes (non-blocking)
|
|
319
|
+
// Skip for version command (it already shows version info)
|
|
320
|
+
const commandName = program.args[0];
|
|
321
|
+
if (commandName !== 'version' && commandName !== '--version' && commandName !== '-V') {
|
|
322
|
+
// Run update check in background without blocking
|
|
323
|
+
checkForUpdates().catch(() => {});
|
|
324
|
+
}
|
package/lib/commands/version.js
CHANGED
|
@@ -9,7 +9,7 @@ const __dirname = dirname(__filename);
|
|
|
9
9
|
/**
|
|
10
10
|
* Get CLI version from package.json
|
|
11
11
|
*/
|
|
12
|
-
function getCliVersion() {
|
|
12
|
+
export function getCliVersion() {
|
|
13
13
|
try {
|
|
14
14
|
const packagePath = join(__dirname, '..', '..', 'package.json');
|
|
15
15
|
const packageJson = JSON.parse(readFileSync(packagePath, 'utf-8'));
|
|
@@ -41,7 +41,7 @@ function getProjectVersion(targetDir) {
|
|
|
41
41
|
/**
|
|
42
42
|
* Fetch latest version from npm
|
|
43
43
|
*/
|
|
44
|
-
async function getLatestVersion() {
|
|
44
|
+
export async function getLatestVersion() {
|
|
45
45
|
try {
|
|
46
46
|
const controller = new AbortController();
|
|
47
47
|
const timeout = setTimeout(() => controller.abort(), 5000);
|
|
@@ -66,7 +66,7 @@ async function getLatestVersion() {
|
|
|
66
66
|
* Compare semantic versions
|
|
67
67
|
* Returns: -1 if v1 < v2, 0 if equal, 1 if v1 > v2
|
|
68
68
|
*/
|
|
69
|
-
function compareVersions(v1, v2) {
|
|
69
|
+
export function compareVersions(v1, v2) {
|
|
70
70
|
const parts1 = v1.split('.').map(Number);
|
|
71
71
|
const parts2 = v2.split('.').map(Number);
|
|
72
72
|
|
|
@@ -79,6 +79,27 @@ function compareVersions(v1, v2) {
|
|
|
79
79
|
return 0;
|
|
80
80
|
}
|
|
81
81
|
|
|
82
|
+
/**
|
|
83
|
+
* Check for updates and display notification if available
|
|
84
|
+
* Non-blocking - runs asynchronously
|
|
85
|
+
*/
|
|
86
|
+
export async function checkForUpdates() {
|
|
87
|
+
try {
|
|
88
|
+
const cliVersion = getCliVersion();
|
|
89
|
+
const latestVersion = await getLatestVersion();
|
|
90
|
+
|
|
91
|
+
if (latestVersion && compareVersions(cliVersion, latestVersion) < 0) {
|
|
92
|
+
console.log('');
|
|
93
|
+
console.log(chalk.yellow(` ╭───────────────────────────────────────────────╮`));
|
|
94
|
+
console.log(chalk.yellow(` │ Update available: ${chalk.gray('v' + cliVersion)} → ${chalk.green('v' + latestVersion)} │`));
|
|
95
|
+
console.log(chalk.yellow(` │ Run: ${chalk.cyan('npx proagents init')} to update │`));
|
|
96
|
+
console.log(chalk.yellow(` ╰───────────────────────────────────────────────╯`));
|
|
97
|
+
}
|
|
98
|
+
} catch (error) {
|
|
99
|
+
// Silently ignore update check errors
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
|
|
82
103
|
/**
|
|
83
104
|
* Version command - show detailed version information
|
|
84
105
|
*/
|
|
@@ -118,7 +139,7 @@ export async function versionCommand(options = {}) {
|
|
|
118
139
|
console.log(chalk.green('v' + latestVersion + ' (up to date)'));
|
|
119
140
|
} else {
|
|
120
141
|
console.log(chalk.yellow('v' + latestVersion + ' (update available)'));
|
|
121
|
-
console.log(chalk.yellow(` ↳ Run '
|
|
142
|
+
console.log(chalk.yellow(` ↳ Run 'npx proagents init' to update`));
|
|
122
143
|
}
|
|
123
144
|
} else {
|
|
124
145
|
console.log(chalk.gray('Could not fetch (offline or npm unavailable)'));
|