proagents 1.0.6 → 1.0.7
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/lib/commands/init.js +37 -0
- package/package.json +1 -1
- package/proagents/.cursorrules +33 -0
- package/proagents/AI_INSTRUCTIONS.md +71 -0
- package/proagents/CLAUDE.md +33 -0
package/lib/commands/init.js
CHANGED
|
@@ -86,6 +86,9 @@ const FRAMEWORK_FILES = [
|
|
|
86
86
|
'PROAGENTS.md',
|
|
87
87
|
'GETTING-STARTED-STORY.md',
|
|
88
88
|
'slash-commands.json',
|
|
89
|
+
'CLAUDE.md',
|
|
90
|
+
'.cursorrules',
|
|
91
|
+
'AI_INSTRUCTIONS.md',
|
|
89
92
|
];
|
|
90
93
|
|
|
91
94
|
/**
|
|
@@ -253,6 +256,21 @@ For detailed commands, see \`./proagents/PROAGENTS.md\`
|
|
|
253
256
|
console.log(chalk.green('✓ Created README.md with ProAgents commands'));
|
|
254
257
|
}
|
|
255
258
|
|
|
259
|
+
// Copy AI instruction files to project root (for AI platform recognition)
|
|
260
|
+
const claudeMdSource = join(sourceDir, 'CLAUDE.md');
|
|
261
|
+
const claudeMdTarget = join(targetDir, 'CLAUDE.md');
|
|
262
|
+
if (existsSync(claudeMdSource) && !existsSync(claudeMdTarget)) {
|
|
263
|
+
cpSync(claudeMdSource, claudeMdTarget);
|
|
264
|
+
console.log(chalk.green('✓ Created CLAUDE.md (for Claude AI recognition)'));
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
const cursorRulesSource = join(sourceDir, '.cursorrules');
|
|
268
|
+
const cursorRulesTarget = join(targetDir, '.cursorrules');
|
|
269
|
+
if (existsSync(cursorRulesSource) && !existsSync(cursorRulesTarget)) {
|
|
270
|
+
cpSync(cursorRulesSource, cursorRulesTarget);
|
|
271
|
+
console.log(chalk.green('✓ Created .cursorrules (for Cursor AI recognition)'));
|
|
272
|
+
}
|
|
273
|
+
|
|
256
274
|
// Success message
|
|
257
275
|
console.log(chalk.green('\n✓ ProAgents initialized successfully!\n'));
|
|
258
276
|
|
|
@@ -363,6 +381,25 @@ async function smartUpdate(sourceDir, targetDir) {
|
|
|
363
381
|
}
|
|
364
382
|
}
|
|
365
383
|
}
|
|
384
|
+
|
|
385
|
+
// Copy AI instruction files to project root (for AI platform recognition)
|
|
386
|
+
const projectRoot = join(targetDir, '..');
|
|
387
|
+
const aiFiles = ['CLAUDE.md', '.cursorrules', 'AI_INSTRUCTIONS.md'];
|
|
388
|
+
let aiFilesUpdated = 0;
|
|
389
|
+
|
|
390
|
+
for (const file of aiFiles) {
|
|
391
|
+
const sourcePath = join(sourceDir, file);
|
|
392
|
+
const targetPath = join(projectRoot, file);
|
|
393
|
+
|
|
394
|
+
if (existsSync(sourcePath)) {
|
|
395
|
+
cpSync(sourcePath, targetPath, { force: true });
|
|
396
|
+
aiFilesUpdated++;
|
|
397
|
+
}
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
if (aiFilesUpdated > 0) {
|
|
401
|
+
console.log(chalk.green(`✓ Updated ${aiFilesUpdated} AI instruction files (CLAUDE.md, .cursorrules)`));
|
|
402
|
+
}
|
|
366
403
|
}
|
|
367
404
|
|
|
368
405
|
/**
|
package/package.json
CHANGED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ProAgents Rules for Cursor
|
|
2
|
+
|
|
3
|
+
This project uses ProAgents workflow framework.
|
|
4
|
+
|
|
5
|
+
## Command Recognition
|
|
6
|
+
|
|
7
|
+
Recognize commands starting with `pa:` prefix:
|
|
8
|
+
|
|
9
|
+
- `pa:help` - Show all commands
|
|
10
|
+
- `pa:feature "name"` - Start feature workflow (see ./proagents/WORKFLOW.md)
|
|
11
|
+
- `pa:fix "bug"` - Bug fix mode (see ./proagents/workflow-modes/entry-modes.md)
|
|
12
|
+
- `pa:status` - Show progress
|
|
13
|
+
- `pa:doc` - Documentation options
|
|
14
|
+
- `pa:doc-full` - Generate full documentation (see ./proagents/prompts/07-documentation.md)
|
|
15
|
+
- `pa:doc-moderate` - Balanced documentation
|
|
16
|
+
- `pa:doc-lite` - Quick reference
|
|
17
|
+
- `pa:qa` - Quality checks (see ./proagents/checklists/code-quality.md)
|
|
18
|
+
- `pa:test` - Test workflow (see ./proagents/prompts/06-testing.md)
|
|
19
|
+
- `pa:deploy` - Deployment workflow (see ./proagents/prompts/08-deployment.md)
|
|
20
|
+
- `pa:release` - Generate release notes
|
|
21
|
+
|
|
22
|
+
## Workflow
|
|
23
|
+
|
|
24
|
+
When user types `pa:` command:
|
|
25
|
+
1. Read corresponding prompt from ./proagents/prompts/
|
|
26
|
+
2. Follow the defined workflow
|
|
27
|
+
3. Respect settings in ./proagents/proagents.config.yaml
|
|
28
|
+
|
|
29
|
+
## Key References
|
|
30
|
+
|
|
31
|
+
- Workflow: ./proagents/WORKFLOW.md
|
|
32
|
+
- Commands: ./proagents/PROAGENTS.md
|
|
33
|
+
- Prompts: ./proagents/prompts/
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# AI Instructions for ProAgents
|
|
2
|
+
|
|
3
|
+
This project uses ProAgents - an AI-agnostic development workflow framework.
|
|
4
|
+
|
|
5
|
+
## Command Recognition
|
|
6
|
+
|
|
7
|
+
When the user types commands starting with `pa:`, recognize and execute them:
|
|
8
|
+
|
|
9
|
+
### Core Commands
|
|
10
|
+
| Command | Action |
|
|
11
|
+
|---------|--------|
|
|
12
|
+
| `pa:help` | Show all available commands |
|
|
13
|
+
| `pa:feature "name"` | Start new feature workflow |
|
|
14
|
+
| `pa:fix "description"` | Quick bug fix mode |
|
|
15
|
+
| `pa:status` | Show current progress |
|
|
16
|
+
|
|
17
|
+
### Documentation Commands
|
|
18
|
+
| Command | Action |
|
|
19
|
+
|---------|--------|
|
|
20
|
+
| `pa:doc` | Show documentation options |
|
|
21
|
+
| `pa:doc-full` | Generate full project documentation |
|
|
22
|
+
| `pa:doc-moderate` | Generate balanced documentation |
|
|
23
|
+
| `pa:doc-lite` | Generate quick reference |
|
|
24
|
+
| `pa:doc-module [name]` | Document specific module |
|
|
25
|
+
| `pa:doc-file [path]` | Document specific file |
|
|
26
|
+
| `pa:doc-api` | Generate API documentation |
|
|
27
|
+
| `pa:readme` | Generate/update README |
|
|
28
|
+
| `pa:changelog` | Update CHANGELOG.md |
|
|
29
|
+
| `pa:release` | Generate release notes |
|
|
30
|
+
| `pa:release [version]` | Version-specific release notes |
|
|
31
|
+
|
|
32
|
+
### Quality Commands
|
|
33
|
+
| Command | Action |
|
|
34
|
+
|---------|--------|
|
|
35
|
+
| `pa:qa` | Run quality assurance checks |
|
|
36
|
+
| `pa:test` | Run test workflow |
|
|
37
|
+
| `pa:review` | Code review workflow |
|
|
38
|
+
|
|
39
|
+
### Deployment Commands
|
|
40
|
+
| Command | Action |
|
|
41
|
+
|---------|--------|
|
|
42
|
+
| `pa:deploy` | Deployment preparation |
|
|
43
|
+
| `pa:rollback` | Rollback procedures |
|
|
44
|
+
|
|
45
|
+
## How to Execute Commands
|
|
46
|
+
|
|
47
|
+
When user types a `pa:` command:
|
|
48
|
+
|
|
49
|
+
1. **Read the corresponding prompt file** from `./proagents/prompts/`
|
|
50
|
+
2. **Follow the workflow** defined in that prompt
|
|
51
|
+
3. **Use project context** from `./proagents/` folder
|
|
52
|
+
|
|
53
|
+
### Prompt File Mapping
|
|
54
|
+
- `pa:feature` → `./proagents/prompts/00-init.md` + workflow
|
|
55
|
+
- `pa:fix` → `./proagents/workflow-modes/entry-modes.md` (Bug Fix section)
|
|
56
|
+
- `pa:doc*` → `./proagents/prompts/07-documentation.md`
|
|
57
|
+
- `pa:qa` → `./proagents/checklists/code-quality.md`
|
|
58
|
+
- `pa:test` → `./proagents/prompts/06-testing.md`
|
|
59
|
+
- `pa:deploy` → `./proagents/prompts/08-deployment.md`
|
|
60
|
+
- `pa:release` → `./proagents/prompts/07-documentation.md` (Release Notes section)
|
|
61
|
+
|
|
62
|
+
## Workflow Reference
|
|
63
|
+
|
|
64
|
+
Full workflow documentation: `./proagents/WORKFLOW.md`
|
|
65
|
+
Quick command reference: `./proagents/PROAGENTS.md`
|
|
66
|
+
|
|
67
|
+
## Important
|
|
68
|
+
|
|
69
|
+
- Always check `./proagents/` folder for project-specific configurations
|
|
70
|
+
- Preserve user's `proagents.config.yaml` settings
|
|
71
|
+
- Follow existing code patterns found in the project
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ProAgents Commands for Claude
|
|
2
|
+
|
|
3
|
+
This project uses ProAgents. Recognize `pa:` commands:
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
pa:help → Show all commands
|
|
9
|
+
pa:feature "name" → Start feature (read ./proagents/WORKFLOW.md)
|
|
10
|
+
pa:fix "bug" → Bug fix mode (read ./proagents/workflow-modes/entry-modes.md)
|
|
11
|
+
pa:status → Show progress
|
|
12
|
+
pa:doc → Documentation options
|
|
13
|
+
pa:doc-full → Full docs (read ./proagents/prompts/07-documentation.md)
|
|
14
|
+
pa:doc-moderate → Balanced docs
|
|
15
|
+
pa:doc-lite → Quick reference
|
|
16
|
+
pa:qa → Quality checks (read ./proagents/checklists/code-quality.md)
|
|
17
|
+
pa:test → Test workflow (read ./proagents/prompts/06-testing.md)
|
|
18
|
+
pa:deploy → Deployment (read ./proagents/prompts/08-deployment.md)
|
|
19
|
+
pa:release → Release notes
|
|
20
|
+
pa:release [ver] → Version-specific notes
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## On `pa:` command
|
|
24
|
+
|
|
25
|
+
1. Read the corresponding file in `./proagents/prompts/` or `./proagents/workflow-modes/`
|
|
26
|
+
2. Follow the workflow instructions
|
|
27
|
+
3. Use project config from `./proagents/proagents.config.yaml`
|
|
28
|
+
|
|
29
|
+
## Key Files
|
|
30
|
+
|
|
31
|
+
- `./proagents/WORKFLOW.md` - Full 10-phase workflow
|
|
32
|
+
- `./proagents/PROAGENTS.md` - Quick command reference
|
|
33
|
+
- `./proagents/prompts/` - Phase-specific prompts
|