proagents 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +170 -0
- package/bin/proagents.js +90 -0
- package/lib/commands/feature.js +125 -0
- package/lib/commands/fix.js +60 -0
- package/lib/commands/help.js +76 -0
- package/lib/commands/init.js +64 -0
- package/lib/commands/status.js +91 -0
- package/lib/index.js +28 -0
- package/package.json +52 -0
- package/proagents/.learning/global/common-patterns.json +77 -0
- package/proagents/.learning/global/user-preferences.json +76 -0
- package/proagents/.learning/projects/example-project/corrections.json +99 -0
- package/proagents/.learning/projects/example-project/feedback.json +109 -0
- package/proagents/.learning/projects/example-project/metrics.json +101 -0
- package/proagents/.learning/projects/example-project/patterns.json +102 -0
- package/proagents/.learning/schemas/README.md +48 -0
- package/proagents/.learning/schemas/corrections-schema.json +100 -0
- package/proagents/.learning/schemas/feedback-schema.json +144 -0
- package/proagents/.learning/schemas/metrics-schema.json +96 -0
- package/proagents/.learning/schemas/patterns-schema.json +82 -0
- package/proagents/.learning/schemas/project-patterns-schema.json +125 -0
- package/proagents/.learning/schemas/user-preferences-schema.json +136 -0
- package/proagents/GETTING-STARTED-STORY.md +708 -0
- package/proagents/README.md +99 -0
- package/proagents/WORKFLOW.md +1234 -0
- package/proagents/active-features/.gitkeep +0 -0
- package/proagents/active-features/README.md +176 -0
- package/proagents/active-features/_index.json +74 -0
- package/proagents/active-features/feature-user-auth/dependencies.json +81 -0
- package/proagents/active-features/feature-user-auth/files-modified.json +126 -0
- package/proagents/active-features/feature-user-auth/status.json +122 -0
- package/proagents/active-features/schemas/dependencies-schema.json +119 -0
- package/proagents/active-features/schemas/feature-schema.json +132 -0
- package/proagents/active-features/schemas/files-schema.json +100 -0
- package/proagents/active-features/schemas/index-schema.json +95 -0
- package/proagents/adr/README.md +302 -0
- package/proagents/adr/examples/api-versioning.md +297 -0
- package/proagents/adr/examples/database-choice.md +264 -0
- package/proagents/adr/template.md +273 -0
- package/proagents/ai-models/README.md +141 -0
- package/proagents/ai-models/cost-management.md +362 -0
- package/proagents/ai-models/fallbacks.md +342 -0
- package/proagents/ai-models/model-config.md +318 -0
- package/proagents/ai-models/task-routing.md +503 -0
- package/proagents/ai-training/README.md +155 -0
- package/proagents/ai-training/continuous-learning.md +413 -0
- package/proagents/ai-training/domain-knowledge.md +378 -0
- package/proagents/ai-training/pattern-learning.md +455 -0
- package/proagents/ai-training/training-data.md +337 -0
- package/proagents/ai-training/user-preferences.md +346 -0
- package/proagents/api-versioning/README.md +257 -0
- package/proagents/api-versioning/changelog-template.md +225 -0
- package/proagents/api-versioning/deprecation-workflow.md +470 -0
- package/proagents/api-versioning/versioning-strategy.md +291 -0
- package/proagents/approval-workflows/README.md +146 -0
- package/proagents/approval-workflows/approval-config.md +332 -0
- package/proagents/approval-workflows/approval-stages.md +503 -0
- package/proagents/approval-workflows/emergency-bypass.md +351 -0
- package/proagents/approval-workflows/examples.md +859 -0
- package/proagents/approval-workflows/notifications.md +320 -0
- package/proagents/automation/README.md +38 -0
- package/proagents/automation/ai-behavior-rules.md +339 -0
- package/proagents/automation/ai-prompt-injection.md +331 -0
- package/proagents/automation/auto-decisions.md +535 -0
- package/proagents/automation/decision-defaults.yaml +317 -0
- package/proagents/cache/README.md +110 -0
- package/proagents/cache/analysis-metadata.json +76 -0
- package/proagents/cache/conventions.json +125 -0
- package/proagents/cache/dependencies.json +85 -0
- package/proagents/cache/features.json +115 -0
- package/proagents/cache/patterns.json +105 -0
- package/proagents/cache/schemas/conventions-schema.json +138 -0
- package/proagents/cache/schemas/dependencies-schema.json +95 -0
- package/proagents/cache/schemas/features-schema.json +104 -0
- package/proagents/cache/schemas/metadata-schema.json +83 -0
- package/proagents/cache/schemas/patterns-schema.json +136 -0
- package/proagents/cache/schemas/structure-schema.json +72 -0
- package/proagents/cache/structure.json +109 -0
- package/proagents/changelog/2024/01/2024-01-10-api-url-config.md +41 -0
- package/proagents/changelog/2024/01/2024-01-12-login-bug-fix.md +69 -0
- package/proagents/changelog/2024/01/2024-01-15-user-auth-feature.md +99 -0
- package/proagents/changelog/CHANGELOG.md +82 -0
- package/proagents/changelog/README.md +327 -0
- package/proagents/changelog/entry-template.md +283 -0
- package/proagents/checklists/README.md +261 -0
- package/proagents/checklists/code-quality.md +137 -0
- package/proagents/checklists/code-review.md +148 -0
- package/proagents/checklists/pr-checklist.md +78 -0
- package/proagents/checklists/pre-deployment.md +132 -0
- package/proagents/checklists/pre-implementation.md +80 -0
- package/proagents/checklists/testing.md +120 -0
- package/proagents/cicd/README.md +338 -0
- package/proagents/cicd/azure-devops.md +267 -0
- package/proagents/cicd/github-actions.md +375 -0
- package/proagents/cicd/gitlab-ci.md +278 -0
- package/proagents/cicd/jenkins.md +317 -0
- package/proagents/cli/README.md +392 -0
- package/proagents/cli/commands-reference.md +893 -0
- package/proagents/cli/ide-integration.md +584 -0
- package/proagents/cli/shortcuts.md +394 -0
- package/proagents/cli/slash-commands.md +507 -0
- package/proagents/collaboration/README.md +143 -0
- package/proagents/collaboration/roles.md +248 -0
- package/proagents/collaboration/sessions.md +390 -0
- package/proagents/collaboration/sync.md +358 -0
- package/proagents/compliance/README.md +206 -0
- package/proagents/compliance/access-control.md +310 -0
- package/proagents/compliance/audit-logging.md +444 -0
- package/proagents/compliance/compliance-frameworks.md +429 -0
- package/proagents/compliance/reports.md +491 -0
- package/proagents/compliance/retention-policies.md +454 -0
- package/proagents/config/README.md +181 -0
- package/proagents/config/integrations/README.md +68 -0
- package/proagents/config/integrations/github.yaml +211 -0
- package/proagents/config/integrations/jira.yaml +144 -0
- package/proagents/config/integrations/linear.yaml +157 -0
- package/proagents/config/integrations/notion.yaml +203 -0
- package/proagents/config/integrations/slack.yaml +230 -0
- package/proagents/config/rules/README.md +73 -0
- package/proagents/config/rules/custom-rules.template.yaml +188 -0
- package/proagents/config/rules/validation-rules.template.yaml +177 -0
- package/proagents/config/standards/README.md +58 -0
- package/proagents/config/standards/architecture-rules.template.md +124 -0
- package/proagents/config/standards/coding-standards.template.md +107 -0
- package/proagents/config/standards/naming-conventions.template.md +114 -0
- package/proagents/config/standards/testing-standards.template.md +213 -0
- package/proagents/config/templates/README.md +74 -0
- package/proagents/config/templates/api-route.template.ts +142 -0
- package/proagents/config/templates/component.template.tsx +55 -0
- package/proagents/config/templates/hook.template.ts +93 -0
- package/proagents/config/templates/test.template.ts +171 -0
- package/proagents/config-versioning/README.md +120 -0
- package/proagents/config-versioning/changelog.md +300 -0
- package/proagents/config-versioning/rollback.md +283 -0
- package/proagents/config-versioning/versioning.md +330 -0
- package/proagents/contract-testing/README.md +223 -0
- package/proagents/contract-testing/contract-testing.md +614 -0
- package/proagents/contract-testing/pact-integration.md +507 -0
- package/proagents/contract-testing/schema-validation.md +565 -0
- package/proagents/cost/README.md +48 -0
- package/proagents/cost/cost-template.md +283 -0
- package/proagents/cost/estimation-framework.md +287 -0
- package/proagents/database/README.md +72 -0
- package/proagents/database/examples/001-create-users.sql +129 -0
- package/proagents/database/examples/002-add-preferences.sql +94 -0
- package/proagents/database/examples/003-add-index.sql +105 -0
- package/proagents/database/examples/004-rename-column.sql +122 -0
- package/proagents/database/examples/005-add-foreign-key.sql +142 -0
- package/proagents/database/examples/006-data-migration.sql +196 -0
- package/proagents/database/examples/007-drop-column.sql +163 -0
- package/proagents/database/examples/README.md +89 -0
- package/proagents/database/migration-workflow.md +478 -0
- package/proagents/database/rollback-scripts.md +487 -0
- package/proagents/database/safety-checks.md +447 -0
- package/proagents/dependency-management/README.md +140 -0
- package/proagents/dependency-management/automation.md +363 -0
- package/proagents/dependency-management/compatibility.md +319 -0
- package/proagents/dependency-management/security-scanning.md +413 -0
- package/proagents/dependency-management/update-policies.md +374 -0
- package/proagents/disaster-recovery/README.md +247 -0
- package/proagents/disaster-recovery/automation.md +366 -0
- package/proagents/disaster-recovery/backup-recovery.md +571 -0
- package/proagents/disaster-recovery/incident-response.md +565 -0
- package/proagents/disaster-recovery/rollback-procedures.md +499 -0
- package/proagents/disaster-recovery/runbooks.md +603 -0
- package/proagents/disaster-recovery/scenarios.md +892 -0
- package/proagents/disaster-recovery/testing.md +438 -0
- package/proagents/environments/README.md +244 -0
- package/proagents/environments/configuration.md +437 -0
- package/proagents/environments/promotion.md +434 -0
- package/proagents/environments/setup.md +420 -0
- package/proagents/examples/README.md +55 -0
- package/proagents/examples/backend-nodejs/README.md +188 -0
- package/proagents/examples/backend-nodejs/complete-conversation.md +601 -0
- package/proagents/examples/backend-nodejs/proagents.config.yaml +415 -0
- package/proagents/examples/backend-nodejs/workflow-example.md +909 -0
- package/proagents/examples/fullstack-nextjs/README.md +155 -0
- package/proagents/examples/fullstack-nextjs/complete-conversation.md +604 -0
- package/proagents/examples/fullstack-nextjs/proagents.config.yaml +287 -0
- package/proagents/examples/fullstack-nextjs/workflow-example.md +553 -0
- package/proagents/examples/mobile-react-native/README.md +171 -0
- package/proagents/examples/mobile-react-native/complete-conversation.md +825 -0
- package/proagents/examples/mobile-react-native/proagents.config.yaml +330 -0
- package/proagents/examples/mobile-react-native/workflow-example.md +723 -0
- package/proagents/examples/web-frontend-react/README.md +125 -0
- package/proagents/examples/web-frontend-react/complete-conversation.md +556 -0
- package/proagents/examples/web-frontend-react/proagents.config.yaml +183 -0
- package/proagents/examples/web-frontend-react/workflow-example.md +603 -0
- package/proagents/existing-projects/README.md +65 -0
- package/proagents/existing-projects/challenges.md +861 -0
- package/proagents/existing-projects/coexistence-mode.md +483 -0
- package/proagents/existing-projects/compatibility-assessment.md +541 -0
- package/proagents/existing-projects/gradual-adoption.md +515 -0
- package/proagents/existing-projects/migration-strategies.md +788 -0
- package/proagents/existing-projects/pattern-reconciliation.md +489 -0
- package/proagents/existing-projects/team-onboarding.md +617 -0
- package/proagents/existing-projects/technical-debt-handling.md +644 -0
- package/proagents/feature-flags/README.md +263 -0
- package/proagents/feature-flags/ab-testing.md +413 -0
- package/proagents/feature-flags/configuration.md +420 -0
- package/proagents/feature-flags/kill-switches.md +444 -0
- package/proagents/feature-flags/rollout-strategies.md +392 -0
- package/proagents/getting-started/README.md +60 -0
- package/proagents/getting-started/ai-training-setup.md +380 -0
- package/proagents/getting-started/ide-setup.md +195 -0
- package/proagents/getting-started/mcp-setup.md +239 -0
- package/proagents/getting-started/pm-integration.md +336 -0
- package/proagents/getting-started/prompt-engineering.md +478 -0
- package/proagents/getting-started/team-onboarding.md +236 -0
- package/proagents/git/README.md +68 -0
- package/proagents/git/branch-strategy.md +164 -0
- package/proagents/git/commit-conventions.md +241 -0
- package/proagents/git/pr-workflow.md +286 -0
- package/proagents/git/rollback-procedures.md +416 -0
- package/proagents/i18n/README.md +133 -0
- package/proagents/i18n/extraction.md +433 -0
- package/proagents/i18n/tms-integration.md +332 -0
- package/proagents/i18n/translation-workflow.md +413 -0
- package/proagents/i18n/validation.md +355 -0
- package/proagents/ide-integration/README.md +124 -0
- package/proagents/ide-integration/cline-config.md +429 -0
- package/proagents/ide-integration/continue-config.md +380 -0
- package/proagents/ide-integration/cursor-rules.md +280 -0
- package/proagents/ide-integration/github-copilot.md +384 -0
- package/proagents/ide-integration/windsurf-rules.md +314 -0
- package/proagents/integrations/README.md +97 -0
- package/proagents/integrations/pm/README.md +344 -0
- package/proagents/learning/README.md +136 -0
- package/proagents/learning/adaptation.md +305 -0
- package/proagents/learning/data-collection.md +283 -0
- package/proagents/learning/implementation-guide.md +865 -0
- package/proagents/learning/reports.md +306 -0
- package/proagents/logging/README.md +276 -0
- package/proagents/logging/aggregation.md +475 -0
- package/proagents/logging/log-levels.md +376 -0
- package/proagents/logging/sensitive-data.md +423 -0
- package/proagents/logging/structured-logging.md +406 -0
- package/proagents/mcp/README.md +133 -0
- package/proagents/mcp/context-providers.md +442 -0
- package/proagents/mcp/server-config.md +306 -0
- package/proagents/mcp/tools-definition.md +513 -0
- package/proagents/metrics/README.md +174 -0
- package/proagents/metrics/code-quality-kpis.md +461 -0
- package/proagents/metrics/deployment-metrics.md +517 -0
- package/proagents/metrics/developer-productivity.md +368 -0
- package/proagents/metrics/learning-effectiveness.md +478 -0
- package/proagents/migrations/README.md +77 -0
- package/proagents/migrations/from-claude-projects.md +312 -0
- package/proagents/migrations/from-cursor-rules.md +345 -0
- package/proagents/migrations/from-custom-workflows.md +410 -0
- package/proagents/monitoring/README.md +308 -0
- package/proagents/monitoring/alerting.md +449 -0
- package/proagents/monitoring/dashboards.md +454 -0
- package/proagents/monitoring/health-checks.md +436 -0
- package/proagents/monitoring/metrics.md +434 -0
- package/proagents/multi-project/README.md +170 -0
- package/proagents/multi-project/coordinated-deploy.md +510 -0
- package/proagents/multi-project/cross-project-deps.md +395 -0
- package/proagents/multi-project/unified-changelog.md +477 -0
- package/proagents/multi-project/walkthroughs/monorepo-setup.md +787 -0
- package/proagents/multi-project/workspace-config.md +408 -0
- package/proagents/notifications/README.md +151 -0
- package/proagents/notifications/channels.md +457 -0
- package/proagents/notifications/preferences.md +415 -0
- package/proagents/notifications/routing.md +449 -0
- package/proagents/notifications/scheduling.md +425 -0
- package/proagents/notifications/templates.md +446 -0
- package/proagents/offline-mode/README.md +145 -0
- package/proagents/offline-mode/caching.md +344 -0
- package/proagents/offline-mode/offline-operations.md +312 -0
- package/proagents/offline-mode/queue-specifications.md +679 -0
- package/proagents/offline-mode/sync.md +475 -0
- package/proagents/parallel-features/README.md +85 -0
- package/proagents/parallel-features/conflict-detection.md +226 -0
- package/proagents/parallel-features/dependency-management.md +392 -0
- package/proagents/parallel-features/merge-coordination.md +506 -0
- package/proagents/parallel-features/tracking-system.md +416 -0
- package/proagents/patterns/README.md +305 -0
- package/proagents/patterns/api-errors.md +453 -0
- package/proagents/patterns/async-errors.md +521 -0
- package/proagents/patterns/error-types.md +437 -0
- package/proagents/patterns/ui-errors.md +595 -0
- package/proagents/performance/README.md +59 -0
- package/proagents/performance/bundle-analysis.md +375 -0
- package/proagents/performance/load-testing.md +563 -0
- package/proagents/performance/runtime-metrics.md +489 -0
- package/proagents/performance/web-vitals.md +425 -0
- package/proagents/plugins/README.md +139 -0
- package/proagents/plugins/creating-plugins.md +504 -0
- package/proagents/plugins/plugin-api.md +467 -0
- package/proagents/plugins/plugin-registry.md +276 -0
- package/proagents/pm-integration/README.md +151 -0
- package/proagents/pm-integration/asana.md +346 -0
- package/proagents/pm-integration/github-issues.md +308 -0
- package/proagents/pm-integration/gitlab-issues.md +482 -0
- package/proagents/pm-integration/jira.md +364 -0
- package/proagents/pm-integration/linear.md +409 -0
- package/proagents/pm-integration/notion.md +275 -0
- package/proagents/pm-integration/sync-config.md +533 -0
- package/proagents/pm-integration/trello.md +159 -0
- package/proagents/proagents.config.yaml +213 -0
- package/proagents/prompts/00-init-wizard.md +426 -0
- package/proagents/prompts/00-init.md +219 -0
- package/proagents/prompts/01-analysis.md +244 -0
- package/proagents/prompts/02-requirements.md +399 -0
- package/proagents/prompts/03-ui-design.md +493 -0
- package/proagents/prompts/04-planning.md +505 -0
- package/proagents/prompts/05-implementation.md +518 -0
- package/proagents/prompts/06-testing.md +620 -0
- package/proagents/prompts/06.5-code-review.md +512 -0
- package/proagents/prompts/07-documentation.md +673 -0
- package/proagents/prompts/08-deployment.md +539 -0
- package/proagents/prompts/09-rollback.md +554 -0
- package/proagents/prompts/README.md +51 -0
- package/proagents/prompts/accessibility/README.md +146 -0
- package/proagents/prompts/accessibility/aria.md +276 -0
- package/proagents/prompts/accessibility/audit.md +233 -0
- package/proagents/prompts/accessibility/keyboard.md +392 -0
- package/proagents/prompts/accessibility/wcag.md +189 -0
- package/proagents/prompts/debugging/README.md +51 -0
- package/proagents/prompts/debugging/error-analysis.md +385 -0
- package/proagents/prompts/debugging/performance-debug.md +381 -0
- package/proagents/prompts/debugging/systematic.md +270 -0
- package/proagents/prompts/performance/README.md +47 -0
- package/proagents/prompts/performance/analyze.md +265 -0
- package/proagents/prompts/performance/optimize.md +347 -0
- package/proagents/prompts/refactoring/README.md +51 -0
- package/proagents/prompts/refactoring/architecture.md +531 -0
- package/proagents/prompts/refactoring/code-smells.md +174 -0
- package/proagents/prompts/refactoring/patterns.md +516 -0
- package/proagents/prompts/security-audit/README.md +197 -0
- package/proagents/prompts/security-audit/code-review.md +260 -0
- package/proagents/prompts/security-audit/vulnerability-scan.md +288 -0
- package/proagents/reporting/README.md +158 -0
- package/proagents/reporting/dashboards.md +366 -0
- package/proagents/reporting/exports.md +524 -0
- package/proagents/reporting/quality-metrics.md +385 -0
- package/proagents/reporting/templates/README.md +56 -0
- package/proagents/reporting/templates/dashboard-config.json +187 -0
- package/proagents/reporting/templates/metrics-queries.md +427 -0
- package/proagents/reporting/templates/react-dashboard.tsx +544 -0
- package/proagents/reporting/templates/widgets.md +451 -0
- package/proagents/reporting/velocity-metrics.md +340 -0
- package/proagents/reverse-engineering/README.md +151 -0
- package/proagents/reverse-engineering/architecture-extraction.md +325 -0
- package/proagents/reverse-engineering/code-analysis.md +377 -0
- package/proagents/reverse-engineering/dependency-mapping.md +567 -0
- package/proagents/reverse-engineering/diagram-generation.md +586 -0
- package/proagents/reverse-engineering/documentation-generation.md +468 -0
- package/proagents/reverse-engineering/pattern-detection.md +569 -0
- package/proagents/reverse-engineering/quality-assessment.md +733 -0
- package/proagents/rules/README.md +179 -0
- package/proagents/rules/custom-rules-template.yaml +286 -0
- package/proagents/rules/custom-rules.md +754 -0
- package/proagents/rules/validation-rules-template.yaml +517 -0
- package/proagents/runbooks/README.md +219 -0
- package/proagents/runbooks/dependency-vulnerability.md +505 -0
- package/proagents/runbooks/incident-response.md +451 -0
- package/proagents/runbooks/performance-degradation.md +584 -0
- package/proagents/runbooks/production-debugging.md +489 -0
- package/proagents/scaffolding/README.md +64 -0
- package/proagents/scaffolding/nextjs/README.md +578 -0
- package/proagents/scaffolding/nextjs/templates/api-route.ts.template +185 -0
- package/proagents/scaffolding/nextjs/templates/page.tsx.template +109 -0
- package/proagents/scaffolding/nextjs/templates/server-action.ts.template +204 -0
- package/proagents/scaffolding/nodejs/README.md +558 -0
- package/proagents/scaffolding/nodejs/templates/controller.ts.template +167 -0
- package/proagents/scaffolding/nodejs/templates/repository.ts.template +155 -0
- package/proagents/scaffolding/nodejs/templates/service.ts.template +207 -0
- package/proagents/scaffolding/project-types.md +401 -0
- package/proagents/scaffolding/react/README.md +399 -0
- package/proagents/scaffolding/react/templates/component.tsx.template +88 -0
- package/proagents/scaffolding/react/templates/hook.ts.template +127 -0
- package/proagents/scaffolding/react/templates/service.ts.template +155 -0
- package/proagents/scaffolding/react/templates/test.tsx.template +149 -0
- package/proagents/scaffolding/react-native/README.md +476 -0
- package/proagents/scaffolding/react-native/templates/hook.ts.template +226 -0
- package/proagents/scaffolding/react-native/templates/screen.tsx.template +247 -0
- package/proagents/secrets/README.md +278 -0
- package/proagents/secrets/access-control.md +443 -0
- package/proagents/secrets/rotation.md +403 -0
- package/proagents/secrets/scanning.md +487 -0
- package/proagents/secrets/storage.md +394 -0
- package/proagents/security/README.md +71 -0
- package/proagents/security/owasp-checklist.md +390 -0
- package/proagents/security/sast-guide.md +473 -0
- package/proagents/security/security-report-template.md +343 -0
- package/proagents/security/vulnerability-scanning.md +329 -0
- package/proagents/slash-commands.json +161 -0
- package/proagents/standards/README.md +120 -0
- package/proagents/standards/architecture-patterns.md +728 -0
- package/proagents/standards/architecture-rules-template.md +489 -0
- package/proagents/standards/coding-standards-template.md +489 -0
- package/proagents/standards/examples/README.md +61 -0
- package/proagents/standards/examples/nodejs-api.md +560 -0
- package/proagents/standards/examples/react-nextjs.md +428 -0
- package/proagents/standards/naming-conventions-template.md +526 -0
- package/proagents/standards/override-system.md +717 -0
- package/proagents/standards/testing-standards-template.md +220 -0
- package/proagents/team/README.md +256 -0
- package/proagents/team/code-ownership.md +306 -0
- package/proagents/team/communication-templates.md +441 -0
- package/proagents/team/handoff-protocol.md +380 -0
- package/proagents/team/ide-setup/README.md +103 -0
- package/proagents/team/ide-setup/cursor.md +276 -0
- package/proagents/team/ide-setup/jetbrains.md +330 -0
- package/proagents/team/ide-setup/neovim.md +640 -0
- package/proagents/team/ide-setup/vscode.md +348 -0
- package/proagents/team/onboarding.md +278 -0
- package/proagents/templates/README.md +57 -0
- package/proagents/templates/code-review-report.md +255 -0
- package/proagents/templates/codebase-analysis-report.md +315 -0
- package/proagents/templates/deployment-checklist.md +277 -0
- package/proagents/templates/feature-requirements.md +142 -0
- package/proagents/templates/feature-status.md +231 -0
- package/proagents/templates/implementation-plan.md +373 -0
- package/proagents/templates/rollback-plan.md +331 -0
- package/proagents/templates/test-plan.md +336 -0
- package/proagents/templates/ui-specification.md +431 -0
- package/proagents/testing-standards/README.md +229 -0
- package/proagents/testing-standards/coverage-requirements.md +198 -0
- package/proagents/testing-standards/mocking-guidelines.md +478 -0
- package/proagents/testing-standards/test-naming.md +485 -0
- package/proagents/testing-standards/test-patterns.md +488 -0
- package/proagents/troubleshooting/README.md +730 -0
- package/proagents/troubleshooting/ai-issues.md +601 -0
- package/proagents/troubleshooting/workflow-issues.md +571 -0
- package/proagents/ui-integration/README.md +77 -0
- package/proagents/ui-integration/figma-guide.md +217 -0
- package/proagents/ui-integration/manual-export-guide.md +358 -0
- package/proagents/ui-integration/sketch-interpretation.md +471 -0
- package/proagents/webhooks/README.md +126 -0
- package/proagents/webhooks/endpoints.md +298 -0
- package/proagents/webhooks/events.md +316 -0
- package/proagents/webhooks/payloads.md +325 -0
- package/proagents/webhooks/reliability.md +363 -0
- package/proagents/webhooks/security.md +380 -0
- package/proagents/workflow-modes/README.md +136 -0
- package/proagents/workflow-modes/deferred-tracking.md +405 -0
- package/proagents/workflow-modes/entry-modes.md +397 -0
- package/proagents/workflow-modes/guardrails.md +405 -0
- package/proagents/workflow-modes/mode-detection.md +358 -0
- package/proagents/workflow-modes/mode-switching.md +372 -0
|
@@ -0,0 +1,489 @@
|
|
|
1
|
+
# Production Debugging Runbook
|
|
2
|
+
|
|
3
|
+
Systematic approach to debugging issues in production environments.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
This runbook provides techniques for safely debugging production systems while minimizing risk and impact to users.
|
|
10
|
+
|
|
11
|
+
**When to use:**
|
|
12
|
+
- Investigating production bugs
|
|
13
|
+
- Performance issues in production
|
|
14
|
+
- Intermittent failures
|
|
15
|
+
- Data inconsistencies
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Prerequisites
|
|
20
|
+
|
|
21
|
+
- [ ] Read-only production access
|
|
22
|
+
- [ ] Access to logging systems
|
|
23
|
+
- [ ] Access to APM/tracing tools
|
|
24
|
+
- [ ] Understanding of system architecture
|
|
25
|
+
- [ ] Incident channel for communication
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Safety First
|
|
30
|
+
|
|
31
|
+
### Production Debugging Rules
|
|
32
|
+
|
|
33
|
+
1. **Never modify production data directly**
|
|
34
|
+
2. **Use read-only queries when possible**
|
|
35
|
+
3. **Always have a rollback plan**
|
|
36
|
+
4. **Document all actions**
|
|
37
|
+
5. **Communicate with the team**
|
|
38
|
+
6. **Consider user impact**
|
|
39
|
+
|
|
40
|
+
### Before You Start
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Ensure you're in read-only mode if possible
|
|
44
|
+
export READONLY_MODE=true
|
|
45
|
+
|
|
46
|
+
# Verify which environment you're connected to
|
|
47
|
+
echo $ENVIRONMENT # Should show "production"
|
|
48
|
+
|
|
49
|
+
# Alert the team
|
|
50
|
+
/debug start --reason "Investigating ticket #1234"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Step 1: Gather Context
|
|
56
|
+
|
|
57
|
+
### 1.1 Understand the Issue
|
|
58
|
+
|
|
59
|
+
```markdown
|
|
60
|
+
**Issue Context**
|
|
61
|
+
- **Reported by**: [User/Alert/Team]
|
|
62
|
+
- **First occurrence**: [DateTime]
|
|
63
|
+
- **Frequency**: [Constant/Intermittent/Periodic]
|
|
64
|
+
- **Affected users**: [Specific users/All users/Percentage]
|
|
65
|
+
- **Affected feature**: [Feature name]
|
|
66
|
+
- **Error message**: [Exact error if available]
|
|
67
|
+
- **Steps to reproduce**: [If known]
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 1.2 Check Recent Changes
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
# Recent deployments
|
|
74
|
+
kubectl rollout history deployment/<service> -n production
|
|
75
|
+
|
|
76
|
+
# Git log for the service
|
|
77
|
+
git log --oneline --since="7 days ago" -- src/<service>
|
|
78
|
+
|
|
79
|
+
# Config changes
|
|
80
|
+
kubectl diff -f production-config.yaml
|
|
81
|
+
|
|
82
|
+
# Feature flag changes
|
|
83
|
+
curl -s https://flags.example.com/api/changes?since=7d | jq
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 1.3 Check System Health
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Service health
|
|
90
|
+
curl -s https://api.example.com/health | jq
|
|
91
|
+
|
|
92
|
+
# Resource usage
|
|
93
|
+
kubectl top pods -n production -l app=<service>
|
|
94
|
+
|
|
95
|
+
# Recent events
|
|
96
|
+
kubectl get events -n production --sort-by='.lastTimestamp'
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Step 2: Log Analysis
|
|
102
|
+
|
|
103
|
+
### 2.1 Find Relevant Logs
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# Application logs - recent errors
|
|
107
|
+
kubectl logs -n production -l app=<service> --tail=1000 | grep -i error
|
|
108
|
+
|
|
109
|
+
# Specific time window
|
|
110
|
+
kubectl logs -n production <pod> --since-time="2024-01-15T14:00:00Z"
|
|
111
|
+
|
|
112
|
+
# Using log aggregation (Datadog example)
|
|
113
|
+
# Query: service:<service> status:error @http.status_code:>499
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 2.2 Log Search Patterns
|
|
117
|
+
|
|
118
|
+
**Common Error Patterns:**
|
|
119
|
+
```bash
|
|
120
|
+
# Connection errors
|
|
121
|
+
grep -E "(connection refused|timeout|ECONNRESET)" logs.txt
|
|
122
|
+
|
|
123
|
+
# Authentication errors
|
|
124
|
+
grep -E "(unauthorized|forbidden|401|403)" logs.txt
|
|
125
|
+
|
|
126
|
+
# Database errors
|
|
127
|
+
grep -E "(deadlock|constraint violation|duplicate key)" logs.txt
|
|
128
|
+
|
|
129
|
+
# Memory issues
|
|
130
|
+
grep -E "(out of memory|heap|OOM)" logs.txt
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### 2.3 Correlate Logs
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# Find request ID/trace ID in error
|
|
137
|
+
grep "error" logs.txt | grep -oE "trace_id=\w+"
|
|
138
|
+
|
|
139
|
+
# Follow the trace across services
|
|
140
|
+
# In Datadog: @trace_id:<trace_id>
|
|
141
|
+
# In Jaeger: Search by trace ID
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### 2.4 Log Analysis Template
|
|
145
|
+
|
|
146
|
+
```markdown
|
|
147
|
+
**Log Analysis Findings**
|
|
148
|
+
|
|
149
|
+
**Error Pattern**: Database connection timeout
|
|
150
|
+
**First Seen**: 2024-01-15 14:32:15 UTC
|
|
151
|
+
**Frequency**: ~50/minute
|
|
152
|
+
**Sample Error**:
|
|
153
|
+
```
|
|
154
|
+
[ERROR] [2024-01-15T14:32:15Z] DatabaseError: Connection timeout after 30s
|
|
155
|
+
at ConnectionPool.acquire (db.js:142)
|
|
156
|
+
at UserService.getUser (user-service.js:56)
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
**Correlation**: Errors started after deployment v1.2.4
|
|
160
|
+
**Hypothesis**: New query in v1.2.4 is too slow
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Step 3: Tracing & APM
|
|
166
|
+
|
|
167
|
+
### 3.1 Find Slow/Failed Requests
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
# In APM tool, search for:
|
|
171
|
+
# - Status: error
|
|
172
|
+
# - Duration: > 5s
|
|
173
|
+
# - Service: <your-service>
|
|
174
|
+
# - Time range: When issue occurred
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### 3.2 Analyze Traces
|
|
178
|
+
|
|
179
|
+
**What to look for:**
|
|
180
|
+
- Which span is taking longest?
|
|
181
|
+
- Are there error spans?
|
|
182
|
+
- Database queries - count and duration
|
|
183
|
+
- External API calls - duration and status
|
|
184
|
+
- Memory/CPU during request
|
|
185
|
+
|
|
186
|
+
### 3.3 Compare Good vs Bad Requests
|
|
187
|
+
|
|
188
|
+
```markdown
|
|
189
|
+
**Request Comparison**
|
|
190
|
+
|
|
191
|
+
| Aspect | Good Request | Bad Request |
|
|
192
|
+
|--------|--------------|-------------|
|
|
193
|
+
| Duration | 120ms | 32,000ms |
|
|
194
|
+
| DB Queries | 3 | 47 |
|
|
195
|
+
| External Calls | 1 | 1 |
|
|
196
|
+
| Error | None | Timeout |
|
|
197
|
+
| User Type | Regular | Premium |
|
|
198
|
+
| Data Size | Small | Large |
|
|
199
|
+
|
|
200
|
+
**Finding**: Premium users with large data trigger N+1 query
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## Step 4: Database Investigation
|
|
206
|
+
|
|
207
|
+
### 4.1 Check Database Performance
|
|
208
|
+
|
|
209
|
+
```sql
|
|
210
|
+
-- Active queries (PostgreSQL)
|
|
211
|
+
SELECT pid, now() - pg_stat_activity.query_start AS duration, query, state
|
|
212
|
+
FROM pg_stat_activity
|
|
213
|
+
WHERE state != 'idle'
|
|
214
|
+
ORDER BY duration DESC;
|
|
215
|
+
|
|
216
|
+
-- Slow query log
|
|
217
|
+
SELECT * FROM pg_stat_statements
|
|
218
|
+
ORDER BY total_time DESC
|
|
219
|
+
LIMIT 20;
|
|
220
|
+
|
|
221
|
+
-- Lock contention
|
|
222
|
+
SELECT * FROM pg_locks WHERE NOT granted;
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### 4.2 Analyze Slow Queries
|
|
226
|
+
|
|
227
|
+
```sql
|
|
228
|
+
-- Explain problematic query
|
|
229
|
+
EXPLAIN ANALYZE
|
|
230
|
+
SELECT * FROM users
|
|
231
|
+
WHERE created_at > '2024-01-01'
|
|
232
|
+
AND status = 'active';
|
|
233
|
+
|
|
234
|
+
-- Check for missing indexes
|
|
235
|
+
SELECT schemaname, tablename, attname, null_frac, n_distinct
|
|
236
|
+
FROM pg_stats
|
|
237
|
+
WHERE tablename = 'users';
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### 4.3 Check Connection Pool
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
# Application connection pool stats
|
|
244
|
+
curl -s http://localhost:9090/metrics | grep db_pool
|
|
245
|
+
|
|
246
|
+
# Database connections
|
|
247
|
+
SELECT count(*) FROM pg_stat_activity WHERE datname = 'mydb';
|
|
248
|
+
|
|
249
|
+
# Connection states
|
|
250
|
+
SELECT state, count(*) FROM pg_stat_activity
|
|
251
|
+
WHERE datname = 'mydb' GROUP BY state;
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## Step 5: Memory & CPU Analysis
|
|
257
|
+
|
|
258
|
+
### 5.1 Check Resource Usage
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
# Pod resource usage
|
|
262
|
+
kubectl top pods -n production -l app=<service>
|
|
263
|
+
|
|
264
|
+
# Detailed container stats
|
|
265
|
+
kubectl exec -n production <pod> -- top -bn1
|
|
266
|
+
|
|
267
|
+
# Memory breakdown
|
|
268
|
+
kubectl exec -n production <pod> -- cat /proc/meminfo
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### 5.2 Memory Leak Detection
|
|
272
|
+
|
|
273
|
+
```bash
|
|
274
|
+
# Heap dump (Node.js)
|
|
275
|
+
kubectl exec -n production <pod> -- \
|
|
276
|
+
node --heapsnapshot-signal=SIGUSR2 -e "process.kill(process.pid, 'SIGUSR2')"
|
|
277
|
+
|
|
278
|
+
# Memory over time
|
|
279
|
+
# Check APM/monitoring for memory growth pattern
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### 5.3 CPU Profiling
|
|
283
|
+
|
|
284
|
+
```bash
|
|
285
|
+
# CPU profile (Node.js)
|
|
286
|
+
kubectl exec -n production <pod> -- \
|
|
287
|
+
node --prof app.js
|
|
288
|
+
|
|
289
|
+
# Flame graphs
|
|
290
|
+
# Use APM continuous profiling or
|
|
291
|
+
# kubectl exec -n production <pod> -- perf record -F 99 -p $(pgrep node)
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## Step 6: Network Analysis
|
|
297
|
+
|
|
298
|
+
### 6.1 Check Network Connectivity
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
# DNS resolution
|
|
302
|
+
kubectl exec -n production <pod> -- nslookup api.external-service.com
|
|
303
|
+
|
|
304
|
+
# TCP connectivity
|
|
305
|
+
kubectl exec -n production <pod> -- nc -zv database.internal 5432
|
|
306
|
+
|
|
307
|
+
# Latency to dependencies
|
|
308
|
+
kubectl exec -n production <pod> -- curl -w "%{time_total}" -o /dev/null -s https://api.external.com
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### 6.2 Network Issues
|
|
312
|
+
|
|
313
|
+
```bash
|
|
314
|
+
# Check for connection timeouts
|
|
315
|
+
netstat -an | grep -c TIME_WAIT
|
|
316
|
+
netstat -an | grep -c ESTABLISHED
|
|
317
|
+
|
|
318
|
+
# DNS issues
|
|
319
|
+
kubectl logs -n kube-system -l k8s-app=kube-dns --tail=100
|
|
320
|
+
|
|
321
|
+
# Service mesh issues (if using Istio)
|
|
322
|
+
kubectl logs -n production <pod> -c istio-proxy --tail=100
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
---
|
|
326
|
+
|
|
327
|
+
## Step 7: Reproduce Safely
|
|
328
|
+
|
|
329
|
+
### 7.1 Local Reproduction
|
|
330
|
+
|
|
331
|
+
```bash
|
|
332
|
+
# Pull production data (anonymized) to local
|
|
333
|
+
./scripts/sync-test-data.sh --anonymize
|
|
334
|
+
|
|
335
|
+
# Run with production config (read-only)
|
|
336
|
+
ENVIRONMENT=prod-replica npm run start:debug
|
|
337
|
+
|
|
338
|
+
# Reproduce the scenario
|
|
339
|
+
curl -X POST http://localhost:3000/api/problematic-endpoint \
|
|
340
|
+
-H "Content-Type: application/json" \
|
|
341
|
+
-d '{"userId": "test-user-123"}'
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### 7.2 Staging Reproduction
|
|
345
|
+
|
|
346
|
+
```bash
|
|
347
|
+
# Deploy same version to staging
|
|
348
|
+
kubectl set image deployment/my-service \
|
|
349
|
+
my-service=my-registry/my-service:v1.2.4 \
|
|
350
|
+
-n staging
|
|
351
|
+
|
|
352
|
+
# Replay production traffic (if available)
|
|
353
|
+
./scripts/replay-traffic.sh --source production --target staging
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### 7.3 Debug Endpoints (if available)
|
|
357
|
+
|
|
358
|
+
```bash
|
|
359
|
+
# Enable debug mode for specific user (feature flag)
|
|
360
|
+
curl -X POST https://flags.example.com/api/flags/debug-mode \
|
|
361
|
+
-d '{"users": ["problem-user-id"]}'
|
|
362
|
+
|
|
363
|
+
# Use debug endpoints
|
|
364
|
+
curl -s https://api.example.com/debug/user/problem-user-id/state | jq
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
---
|
|
368
|
+
|
|
369
|
+
## Step 8: Document & Fix
|
|
370
|
+
|
|
371
|
+
### 8.1 Document Findings
|
|
372
|
+
|
|
373
|
+
```markdown
|
|
374
|
+
# Debug Session: TICKET-1234
|
|
375
|
+
|
|
376
|
+
## Summary
|
|
377
|
+
Premium users experiencing timeouts when loading dashboard.
|
|
378
|
+
|
|
379
|
+
## Root Cause
|
|
380
|
+
N+1 query in `getDashboardData()` - for users with 100+ items,
|
|
381
|
+
generates 100+ queries instead of batch loading.
|
|
382
|
+
|
|
383
|
+
## Evidence
|
|
384
|
+
- Traces show 100+ DB queries for affected requests
|
|
385
|
+
- All queries are identical SELECT on items table
|
|
386
|
+
- Works fine for users with < 20 items
|
|
387
|
+
|
|
388
|
+
## Code Location
|
|
389
|
+
`src/services/dashboard.js:142` - Loop calling single-item fetch
|
|
390
|
+
|
|
391
|
+
## Fix
|
|
392
|
+
Replace loop with batch query using WHERE id IN (...)
|
|
393
|
+
|
|
394
|
+
## Test Plan
|
|
395
|
+
1. Unit test with 100+ items
|
|
396
|
+
2. Load test on staging
|
|
397
|
+
3. Monitor after deploy
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### 8.2 Create Fix
|
|
401
|
+
|
|
402
|
+
```bash
|
|
403
|
+
# Create fix branch
|
|
404
|
+
git checkout -b fix/dashboard-n-plus-one
|
|
405
|
+
|
|
406
|
+
# Make changes
|
|
407
|
+
# ... edit code ...
|
|
408
|
+
|
|
409
|
+
# Test locally
|
|
410
|
+
npm run test
|
|
411
|
+
npm run test:integration
|
|
412
|
+
|
|
413
|
+
# Create PR
|
|
414
|
+
gh pr create --title "Fix N+1 query in dashboard loading"
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### 8.3 Verify Fix
|
|
418
|
+
|
|
419
|
+
```bash
|
|
420
|
+
# After deploying fix:
|
|
421
|
+
|
|
422
|
+
# Check error rate (should decrease)
|
|
423
|
+
# Monitor: error rate for dashboard endpoint
|
|
424
|
+
|
|
425
|
+
# Check latency (should improve)
|
|
426
|
+
# Monitor: p99 latency for dashboard endpoint
|
|
427
|
+
|
|
428
|
+
# Check DB queries (should decrease)
|
|
429
|
+
# Trace comparison: before vs after
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
## Debug Commands Reference
|
|
435
|
+
|
|
436
|
+
```bash
|
|
437
|
+
# Start debug session
|
|
438
|
+
/debug start --ticket TICKET-1234
|
|
439
|
+
|
|
440
|
+
# Log findings
|
|
441
|
+
/debug log "Found N+1 query in dashboard loading"
|
|
442
|
+
|
|
443
|
+
# Share findings
|
|
444
|
+
/debug share --channel #engineering
|
|
445
|
+
|
|
446
|
+
# End session
|
|
447
|
+
/debug end --summary "Root cause: N+1 query, fix deployed"
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
---
|
|
451
|
+
|
|
452
|
+
## Tools Reference
|
|
453
|
+
|
|
454
|
+
### Log Analysis
|
|
455
|
+
- **Datadog Logs**: `service:<name> status:error`
|
|
456
|
+
- **CloudWatch**: Filter patterns, Insights queries
|
|
457
|
+
- **ELK Stack**: Kibana query DSL
|
|
458
|
+
|
|
459
|
+
### Tracing
|
|
460
|
+
- **Datadog APM**: Service map, traces, profiles
|
|
461
|
+
- **Jaeger**: Distributed tracing
|
|
462
|
+
- **X-Ray**: AWS service tracing
|
|
463
|
+
|
|
464
|
+
### Database
|
|
465
|
+
- **pgAdmin/psql**: PostgreSQL
|
|
466
|
+
- **MySQL Workbench**: MySQL
|
|
467
|
+
- **Compass**: MongoDB
|
|
468
|
+
|
|
469
|
+
### Profiling
|
|
470
|
+
- **Node.js**: `--inspect`, Chrome DevTools
|
|
471
|
+
- **Python**: cProfile, py-spy
|
|
472
|
+
- **Go**: pprof
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
## When to Stop
|
|
477
|
+
|
|
478
|
+
**Stop debugging and escalate when:**
|
|
479
|
+
- Issue is causing significant user impact
|
|
480
|
+
- You've spent 30+ minutes without progress
|
|
481
|
+
- You need access you don't have
|
|
482
|
+
- The fix requires expertise you don't have
|
|
483
|
+
- It's outside business hours and can wait
|
|
484
|
+
|
|
485
|
+
**Escalation path:**
|
|
486
|
+
1. Team lead / Senior engineer
|
|
487
|
+
2. Service owner
|
|
488
|
+
3. Platform/SRE team
|
|
489
|
+
4. External support (DB vendor, cloud provider)
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Project Scaffolding
|
|
2
|
+
|
|
3
|
+
Quick-start templates for new projects.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Pre-configured project templates with ProAgents integration built-in.
|
|
10
|
+
|
|
11
|
+
## Available Templates
|
|
12
|
+
|
|
13
|
+
| Template | Description |
|
|
14
|
+
|----------|-------------|
|
|
15
|
+
| [React](./react/) | React SPA with Vite |
|
|
16
|
+
| [Next.js](./nextjs/) | Full-stack Next.js |
|
|
17
|
+
| [React Native](./react-native/) | Cross-platform mobile |
|
|
18
|
+
| [Node.js](./nodejs/) | Express/Node.js backend |
|
|
19
|
+
|
|
20
|
+
See [Project Types](./project-types.md) for detailed comparison.
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Create new project with template
|
|
26
|
+
proagents new my-app --template react
|
|
27
|
+
|
|
28
|
+
# Initialize ProAgents in existing project
|
|
29
|
+
proagents init --template nextjs
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Template Contents
|
|
33
|
+
|
|
34
|
+
Each template includes:
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
template/
|
|
38
|
+
├── src/ # Source code structure
|
|
39
|
+
├── tests/ # Test setup
|
|
40
|
+
├── .proagents/ # ProAgents config
|
|
41
|
+
│ ├── proagents.config.yaml
|
|
42
|
+
│ └── standards/
|
|
43
|
+
├── .github/ # CI/CD workflows
|
|
44
|
+
├── package.json # Dependencies
|
|
45
|
+
└── README.md # Documentation
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Creating Custom Templates
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Export current project as template
|
|
52
|
+
proagents scaffold export --name my-template
|
|
53
|
+
|
|
54
|
+
# Use custom template
|
|
55
|
+
proagents new my-app --template ./my-template
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Template Features
|
|
59
|
+
|
|
60
|
+
- Pre-configured linting (ESLint, Prettier)
|
|
61
|
+
- Testing setup (Jest, Vitest, or project-specific)
|
|
62
|
+
- CI/CD pipeline templates
|
|
63
|
+
- ProAgents workflow integration
|
|
64
|
+
- Git hooks (Husky)
|