proagents 1.0.0 → 1.0.2

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.
Files changed (149) hide show
  1. package/README.md +12 -12
  2. package/lib/commands/init.js +122 -11
  3. package/package.json +1 -1
  4. package/proagents/PROAGENTS.md +54 -0
  5. package/proagents/README.md +17 -17
  6. package/proagents/WORKFLOW.md +110 -110
  7. package/proagents/active-features/README.md +9 -9
  8. package/proagents/adr/README.md +15 -15
  9. package/proagents/api-versioning/changelog-template.md +4 -4
  10. package/proagents/api-versioning/deprecation-workflow.md +6 -6
  11. package/proagents/api-versioning/versioning-strategy.md +5 -5
  12. package/proagents/automation/ai-behavior-rules.md +1 -1
  13. package/proagents/automation/auto-decisions.md +6 -6
  14. package/proagents/cache/README.md +1 -1
  15. package/proagents/changelog/README.md +16 -16
  16. package/proagents/changelog/entry-template.md +4 -4
  17. package/proagents/cli/README.md +1 -1
  18. package/proagents/cli/slash-commands.md +202 -202
  19. package/proagents/collaboration/sessions.md +6 -6
  20. package/proagents/config/integrations/README.md +1 -1
  21. package/proagents/contract-testing/README.md +5 -5
  22. package/proagents/contract-testing/schema-validation.md +6 -6
  23. package/proagents/cost/cost-template.md +6 -6
  24. package/proagents/cost/estimation-framework.md +5 -5
  25. package/proagents/database/migration-workflow.md +6 -6
  26. package/proagents/database/rollback-scripts.md +6 -6
  27. package/proagents/database/safety-checks.md +6 -6
  28. package/proagents/examples/backend-nodejs/workflow-example.md +1 -1
  29. package/proagents/examples/web-frontend-react/workflow-example.md +1 -1
  30. package/proagents/existing-projects/README.md +3 -3
  31. package/proagents/existing-projects/challenges.md +1 -1
  32. package/proagents/existing-projects/coexistence-mode.md +8 -8
  33. package/proagents/existing-projects/compatibility-assessment.md +12 -12
  34. package/proagents/existing-projects/gradual-adoption.md +14 -14
  35. package/proagents/existing-projects/migration-strategies.md +7 -7
  36. package/proagents/existing-projects/pattern-reconciliation.md +10 -10
  37. package/proagents/existing-projects/team-onboarding.md +23 -23
  38. package/proagents/existing-projects/technical-debt-handling.md +24 -24
  39. package/proagents/getting-started/README.md +3 -3
  40. package/proagents/getting-started/ai-training-setup.md +24 -24
  41. package/proagents/getting-started/pm-integration.md +22 -22
  42. package/proagents/getting-started/prompt-engineering.md +4 -4
  43. package/proagents/getting-started/team-onboarding.md +5 -5
  44. package/proagents/git/branch-strategy.md +10 -10
  45. package/proagents/git/commit-conventions.md +5 -5
  46. package/proagents/git/pr-workflow.md +5 -5
  47. package/proagents/git/rollback-procedures.md +7 -7
  48. package/proagents/ide-integration/README.md +1 -1
  49. package/proagents/ide-integration/cline-config.md +10 -10
  50. package/proagents/ide-integration/continue-config.md +1 -1
  51. package/proagents/ide-integration/cursor-rules.md +10 -10
  52. package/proagents/ide-integration/github-copilot.md +4 -4
  53. package/proagents/ide-integration/windsurf-rules.md +9 -9
  54. package/proagents/learning/adaptation.md +10 -10
  55. package/proagents/learning/data-collection.md +9 -9
  56. package/proagents/learning/reports.md +14 -14
  57. package/proagents/metrics/README.md +6 -6
  58. package/proagents/metrics/code-quality-kpis.md +6 -6
  59. package/proagents/metrics/deployment-metrics.md +6 -6
  60. package/proagents/metrics/developer-productivity.md +5 -5
  61. package/proagents/metrics/learning-effectiveness.md +6 -6
  62. package/proagents/migrations/from-claude-projects.md +7 -6
  63. package/proagents/migrations/from-cursor-rules.md +1 -1
  64. package/proagents/notifications/templates.md +3 -3
  65. package/proagents/parallel-features/README.md +5 -5
  66. package/proagents/parallel-features/conflict-detection.md +6 -6
  67. package/proagents/parallel-features/dependency-management.md +7 -7
  68. package/proagents/parallel-features/merge-coordination.md +8 -8
  69. package/proagents/parallel-features/tracking-system.md +7 -7
  70. package/proagents/performance/bundle-analysis.md +4 -4
  71. package/proagents/performance/load-testing.md +7 -7
  72. package/proagents/performance/runtime-metrics.md +6 -6
  73. package/proagents/performance/web-vitals.md +6 -6
  74. package/proagents/plugins/README.md +1 -1
  75. package/proagents/plugins/creating-plugins.md +1 -1
  76. package/proagents/plugins/plugin-api.md +2 -2
  77. package/proagents/plugins/plugin-registry.md +3 -3
  78. package/proagents/proagents.config.yaml +32 -9
  79. package/proagents/prompts/00-init-wizard.md +18 -18
  80. package/proagents/prompts/00-init.md +93 -93
  81. package/proagents/prompts/01-analysis.md +5 -5
  82. package/proagents/prompts/02-requirements.md +8 -8
  83. package/proagents/prompts/03-ui-design.md +14 -14
  84. package/proagents/prompts/04-planning.md +10 -10
  85. package/proagents/prompts/05-implementation.md +10 -10
  86. package/proagents/prompts/06-testing.md +14 -14
  87. package/proagents/prompts/06.5-code-review.md +8 -8
  88. package/proagents/prompts/07-documentation.md +142 -20
  89. package/proagents/prompts/08-deployment.md +12 -12
  90. package/proagents/prompts/09-rollback.md +12 -12
  91. package/proagents/prompts/README.md +4 -4
  92. package/proagents/prompts/accessibility/README.md +6 -6
  93. package/proagents/prompts/accessibility/audit.md +3 -3
  94. package/proagents/prompts/accessibility/wcag.md +1 -1
  95. package/proagents/prompts/debugging/README.md +4 -4
  96. package/proagents/prompts/debugging/performance-debug.md +5 -5
  97. package/proagents/prompts/debugging/systematic.md +4 -4
  98. package/proagents/prompts/performance/README.md +4 -4
  99. package/proagents/prompts/performance/analyze.md +4 -4
  100. package/proagents/prompts/refactoring/README.md +4 -4
  101. package/proagents/prompts/refactoring/code-smells.md +9 -9
  102. package/proagents/prompts/refactoring/patterns.md +6 -6
  103. package/proagents/prompts/security-audit/README.md +6 -6
  104. package/proagents/prompts/security-audit/code-review.md +5 -5
  105. package/proagents/reverse-engineering/README.md +21 -21
  106. package/proagents/reverse-engineering/architecture-extraction.md +6 -6
  107. package/proagents/reverse-engineering/code-analysis.md +6 -6
  108. package/proagents/reverse-engineering/dependency-mapping.md +10 -10
  109. package/proagents/reverse-engineering/diagram-generation.md +9 -9
  110. package/proagents/reverse-engineering/documentation-generation.md +7 -7
  111. package/proagents/reverse-engineering/pattern-detection.md +8 -8
  112. package/proagents/reverse-engineering/quality-assessment.md +10 -10
  113. package/proagents/rules/README.md +7 -7
  114. package/proagents/rules/custom-rules.md +8 -8
  115. package/proagents/runbooks/README.md +9 -9
  116. package/proagents/runbooks/dependency-vulnerability.md +4 -4
  117. package/proagents/runbooks/incident-response.md +12 -12
  118. package/proagents/runbooks/performance-degradation.md +5 -5
  119. package/proagents/runbooks/production-debugging.md +5 -5
  120. package/proagents/scaffolding/nextjs/README.md +10 -10
  121. package/proagents/scaffolding/nodejs/README.md +10 -10
  122. package/proagents/scaffolding/project-types.md +7 -7
  123. package/proagents/scaffolding/react/README.md +6 -6
  124. package/proagents/scaffolding/react-native/README.md +10 -10
  125. package/proagents/security/owasp-checklist.md +3 -3
  126. package/proagents/security/sast-guide.md +6 -6
  127. package/proagents/security/security-report-template.md +5 -5
  128. package/proagents/security/vulnerability-scanning.md +6 -6
  129. package/proagents/slash-commands.json +50 -75
  130. package/proagents/standards/README.md +4 -4
  131. package/proagents/standards/architecture-patterns.md +10 -10
  132. package/proagents/standards/naming-conventions-template.md +4 -4
  133. package/proagents/standards/override-system.md +8 -8
  134. package/proagents/team/code-ownership.md +4 -4
  135. package/proagents/team/communication-templates.md +6 -6
  136. package/proagents/team/handoff-protocol.md +4 -4
  137. package/proagents/team/ide-setup/cursor.md +1 -1
  138. package/proagents/templates/README.md +1 -1
  139. package/proagents/templates/release-notes.md +214 -0
  140. package/proagents/ui-integration/figma-guide.md +3 -3
  141. package/proagents/ui-integration/manual-export-guide.md +2 -2
  142. package/proagents/ui-integration/sketch-interpretation.md +2 -2
  143. package/proagents/webhooks/events.md +3 -3
  144. package/proagents/workflow-modes/README.md +11 -11
  145. package/proagents/workflow-modes/deferred-tracking.md +12 -12
  146. package/proagents/workflow-modes/entry-modes.md +16 -16
  147. package/proagents/workflow-modes/guardrails.md +7 -7
  148. package/proagents/workflow-modes/mode-detection.md +7 -7
  149. package/proagents/workflow-modes/mode-switching.md +9 -9
package/README.md CHANGED
@@ -48,7 +48,7 @@ proagents feature start "Add user authentication"
48
48
 
49
49
  **Using AI assistant (Claude, ChatGPT, etc.):**
50
50
  ```
51
- /feature-start "Add user authentication"
51
+ pa:feature "Add user authentication"
52
52
  ```
53
53
 
54
54
  ### 3. Follow the guided workflow
@@ -91,21 +91,21 @@ proagents commands # Show all commands
91
91
 
92
92
  ---
93
93
 
94
- ## Slash Commands
94
+ ## Commands
95
95
 
96
- Type `/` in your AI assistant to see available commands:
96
+ Type `pa:` in your AI assistant to use ProAgents commands:
97
97
 
98
98
  | Command | Description |
99
99
  |---------|-------------|
100
- | `/init` | Initialize ProAgents in your project |
101
- | `/feature-start` | Start a new feature |
102
- | `/fix` | Quick bug fix mode |
103
- | `/doc` | Generate documentation |
104
- | `/qa` | Quality assurance checks |
105
- | `/test` | Run test workflows |
106
- | `/deploy` | Deployment preparation |
107
- | `/status` | Check current status |
108
- | `/help` | Show all commands |
100
+ | `pa:init` | Initialize ProAgents in your project |
101
+ | `pa:feature` | Start a new feature |
102
+ | `pa:fix` | Quick bug fix mode |
103
+ | `pa:doc` | Generate documentation |
104
+ | `pa:qa` | Quality assurance checks |
105
+ | `pa:test` | Run test workflows |
106
+ | `pa:deploy` | Deployment preparation |
107
+ | `pa:status` | Check current status |
108
+ | `pa:help` | Show all commands |
109
109
 
110
110
  ---
111
111
 
@@ -1,4 +1,4 @@
1
- import { existsSync, mkdirSync, cpSync } from 'fs';
1
+ import { existsSync, mkdirSync, cpSync, writeFileSync, readFileSync } from 'fs';
2
2
  import { join, dirname } from 'path';
3
3
  import { fileURLToPath } from 'url';
4
4
  import chalk from 'chalk';
@@ -42,19 +42,130 @@ export async function initCommand(options = {}) {
42
42
  }
43
43
  }
44
44
 
45
+ // Create docs folder structure for client-facing documentation
46
+ const docsDir = join(targetDir, 'docs');
47
+ const releasesDir = join(docsDir, 'releases');
48
+ const apiDocsDir = join(docsDir, 'api');
49
+
50
+ if (!existsSync(docsDir)) {
51
+ mkdirSync(docsDir, { recursive: true });
52
+ }
53
+ if (!existsSync(releasesDir)) {
54
+ mkdirSync(releasesDir, { recursive: true });
55
+ // Create releases index
56
+ writeFileSync(join(releasesDir, 'README.md'),
57
+ `# Release History
58
+
59
+ This folder contains version-specific release notes.
60
+
61
+ | Version | Date | Description |
62
+ |---------|------|-------------|
63
+ | v1.0.0 | TBD | Initial release |
64
+
65
+ ---
66
+
67
+ Generated by [ProAgents](https://github.com/prakashpro3/proAgents)
68
+ `);
69
+ }
70
+ if (!existsSync(apiDocsDir)) {
71
+ mkdirSync(apiDocsDir, { recursive: true });
72
+ }
73
+ console.log(chalk.green('✓ Created docs/ folder structure'));
74
+
75
+ // Create placeholder CHANGELOG.md if not exists
76
+ const changelogPath = join(targetDir, 'CHANGELOG.md');
77
+ if (!existsSync(changelogPath)) {
78
+ writeFileSync(changelogPath,
79
+ `# Changelog
80
+
81
+ All notable changes to this project will be documented in this file.
82
+
83
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
84
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
85
+
86
+ ## [Unreleased]
87
+
88
+ ### Added
89
+ - Initial project setup
90
+
91
+ ---
92
+
93
+ *Generated by [ProAgents](https://github.com/prakashpro3/proAgents)*
94
+ `);
95
+ console.log(chalk.green('✓ Created CHANGELOG.md'));
96
+ }
97
+
98
+ // Create placeholder RELEASE_NOTES.md if not exists
99
+ const releaseNotesPath = join(targetDir, 'RELEASE_NOTES.md');
100
+ if (!existsSync(releaseNotesPath)) {
101
+ writeFileSync(releaseNotesPath,
102
+ `# Release Notes
103
+
104
+ **Current Version:** Unreleased
105
+ **Last Updated:** ${new Date().toISOString().split('T')[0]}
106
+
107
+ ## Overview
108
+
109
+ This document contains release notes for client and stakeholder communication.
110
+
111
+ ## Latest Release
112
+
113
+ No releases yet. Use \`pa:release\` to generate release notes.
114
+
115
+ ---
116
+
117
+ *Generated by [ProAgents](https://github.com/prakashpro3/proAgents)*
118
+ `);
119
+ console.log(chalk.green('✓ Created RELEASE_NOTES.md'));
120
+ }
121
+
122
+ // Add ProAgents section to README.md (AI tools auto-read this)
123
+ const readmePath = join(targetDir, 'README.md');
124
+ const proagentsSection = `
125
+ <!-- PROAGENTS:START - AI Development Commands -->
126
+ ## AI Commands (ProAgents)
127
+
128
+ This project uses [ProAgents](https://github.com/prakashpro3/proAgents). Commands use \`pa:\` prefix:
129
+
130
+ | Command | Description |
131
+ |---------|-------------|
132
+ | \`pa:help\` | Show all commands |
133
+ | \`pa:feature "name"\` | Start new feature |
134
+ | \`pa:fix "bug"\` | Quick bug fix |
135
+ | \`pa:status\` | Show progress |
136
+ | \`pa:release\` | Generate release notes |
137
+
138
+ For detailed commands, see \`./proagents/PROAGENTS.md\`
139
+ <!-- PROAGENTS:END -->
140
+
141
+ `;
142
+
143
+ if (existsSync(readmePath)) {
144
+ const readmeContent = readFileSync(readmePath, 'utf-8');
145
+ if (!readmeContent.includes('PROAGENTS:START')) {
146
+ // Prepend to existing README
147
+ writeFileSync(readmePath, proagentsSection + readmeContent);
148
+ console.log(chalk.green('✓ Added ProAgents commands to README.md'));
149
+ }
150
+ } else {
151
+ // Create new README with ProAgents section
152
+ writeFileSync(readmePath, proagentsSection + `# Project Name\n\nProject description.\n`);
153
+ console.log(chalk.green('✓ Created README.md with ProAgents commands'));
154
+ }
155
+
45
156
  // Success message
46
157
  console.log(chalk.green('\n✓ ProAgents initialized successfully!\n'));
47
158
 
48
- // Next steps
49
- console.log(chalk.bold('Next Steps:'));
50
- console.log(chalk.white('───────────'));
51
- console.log('1. Open your AI assistant (Claude, ChatGPT, Cursor, etc.)');
52
- console.log('2. Start a feature:');
53
- console.log(chalk.cyan(' /feature-start "your feature name"'));
54
- console.log('3. Or use the CLI:');
55
- console.log(chalk.cyan(' proagents feature start "your feature name"'));
56
- console.log('\n' + chalk.gray('Documentation: ./proagents/README.md'));
57
- console.log(chalk.gray('Full Workflow: ./proagents/WORKFLOW.md\n'));
159
+ // Simple next steps
160
+ console.log(chalk.bold('Usage:'));
161
+ console.log(chalk.white('──────'));
162
+ console.log('Type commands in any AI (prefix: pa:)');
163
+ console.log(chalk.cyan(' pa:help ') + chalk.gray('Show all commands'));
164
+ console.log(chalk.cyan(' pa:feature "name" ') + chalk.gray('Start new feature'));
165
+ console.log(chalk.cyan(' pa:fix "bug" ') + chalk.gray('Quick bug fix'));
166
+ console.log(chalk.cyan(' pa:status ') + chalk.gray('Show progress'));
167
+ console.log(chalk.cyan(' pa:release ') + chalk.gray('Generate release notes'));
168
+ console.log('\n' + chalk.gray('Commands added to README.md - AI tools will see them automatically.\n'));
58
169
 
59
170
  } catch (error) {
60
171
  console.error(chalk.red('\n✗ Error initializing ProAgents:'));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "proagents",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "AI-agnostic development workflow framework that automates the full software development lifecycle",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -0,0 +1,54 @@
1
+ # ProAgents Commands
2
+
3
+ Execute these commands when user types them (prefix: `pa:`):
4
+
5
+ ## Commands
6
+
7
+ | Command | What to Do |
8
+ |---------|------------|
9
+ | `pa:help` | Show this command table |
10
+ | `pa:feature "name"` | Create `./proagents/active-features/feature-[name]/`, analyze codebase, implement feature |
11
+ | `pa:fix "description"` | Find bug, fix it, update `./CHANGELOG.md` |
12
+ | `pa:status` | Read `./proagents/active-features/*/status.json`, show progress |
13
+ | `pa:qa` | Check code quality, run tests, report issues |
14
+ | `pa:test` | Create/run tests for current work |
15
+ | `pa:doc` | Generate documentation |
16
+ | `pa:release` | Generate release notes → `./RELEASE_NOTES.md` |
17
+ | `pa:changelog` | Update `./CHANGELOG.md` |
18
+
19
+ ## Feature Workflow
20
+
21
+ `pa:feature` follows these phases:
22
+ 1. **Init** → Create tracking files
23
+ 2. **Analysis** → Understand existing code
24
+ 3. **Requirements** → Define what to build
25
+ 4. **Design** → Plan architecture
26
+ 5. **Implementation** → Write code
27
+ 6. **Testing** → Create tests
28
+ 7. **Review** → Quality check
29
+ 8. **Documentation** → Update docs
30
+ 9. **Deploy** → Prepare release
31
+
32
+ ## Save Locations
33
+
34
+ | Document | Location |
35
+ |----------|----------|
36
+ | Changelog | `./CHANGELOG.md` |
37
+ | Release Notes | `./RELEASE_NOTES.md` |
38
+ | Feature Status | `./proagents/active-features/` |
39
+
40
+ ## Examples
41
+
42
+ ```
43
+ User: pa:feature "add user login"
44
+ → Create feature, analyze codebase, guide implementation
45
+
46
+ User: pa:fix "submit button not working"
47
+ → Find issue, fix it, update changelog
48
+
49
+ User: pa:status
50
+ → Show active features and progress
51
+
52
+ User: pa:help
53
+ → Show all available commands
54
+ ```
@@ -9,8 +9,8 @@ A portable, AI-agnostic development workflow framework that automates the full s
9
9
  ### 1. Initialize in Your Project
10
10
 
11
11
  ```bash
12
- # Using slash command (any AI)
13
- /init
12
+ # Using pa: command (any AI)
13
+ pa:init
14
14
 
15
15
  # Or CLI
16
16
  npx proagents init
@@ -19,8 +19,8 @@ npx proagents init
19
19
  ### 2. Start Your First Feature
20
20
 
21
21
  ```bash
22
- # Using slash command
23
- /feature-start "Add user authentication"
22
+ # Using pa: command
23
+ pa:feature "Add user authentication"
24
24
 
25
25
  # Or CLI
26
26
  proagents feature start "Add user authentication"
@@ -48,23 +48,23 @@ The AI will guide you through:
48
48
  | **IDE Agnostic** | VS Code, JetBrains, Vim, any editor |
49
49
  | **Self-Learning** | Learns from your usage and adapts |
50
50
  | **Flexible Entry** | Full workflow, Bug Fix, or Quick Change modes |
51
- | **Slash Commands** | `/doc`, `/qa`, `/test`, `/deploy` with hints |
51
+ | **Commands** | `pa:doc`, `pa:qa`, `pa:test`, `pa:deploy` with hints |
52
52
 
53
- ## Slash Commands
53
+ ## Commands
54
54
 
55
- Type `/` to see available commands:
55
+ Type `pa:` followed by a command:
56
56
 
57
57
  | Command | Description |
58
58
  |---------|-------------|
59
- | `/init` | Initialize ProAgents |
60
- | `/feature-start` | Start new feature |
61
- | `/fix-quick` | Quick bug fix |
62
- | `/doc` | Generate documentation |
63
- | `/qa` | Quality assurance |
64
- | `/test` | Run tests |
65
- | `/deploy` | Deploy workflow |
66
- | `/status` | Check status |
67
- | `/help` | Show all commands |
59
+ | `pa:init` | Initialize ProAgents |
60
+ | `pa:feature` | Start new feature |
61
+ | `pa:fix-quick` | Quick bug fix |
62
+ | `pa:doc` | Generate documentation |
63
+ | `pa:qa` | Quality assurance |
64
+ | `pa:test` | Run tests |
65
+ | `pa:deploy` | Deploy workflow |
66
+ | `pa:status` | Check status |
67
+ | `pa:help` | Show all commands |
68
68
 
69
69
  ## Configuration
70
70
 
@@ -85,7 +85,7 @@ git:
85
85
 
86
86
  - [Complete Workflow Guide](./WORKFLOW.md)
87
87
  - [Configuration Reference](./proagents.config.yaml)
88
- - [Slash Commands](./prompts/00-init.md)
88
+ - [Commands](./prompts/00-init.md)
89
89
  - [UI Integration](./ui-integration/)
90
90
  - [Examples](./examples/)
91
91