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,454 @@
|
|
|
1
|
+
# Data Retention Policies
|
|
2
|
+
|
|
3
|
+
Configure data retention for compliance and operational needs.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Retention policies ensure data is kept for required periods and properly disposed of when no longer needed.
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
13
|
+
│ Retention Lifecycle │
|
|
14
|
+
├─────────────────────────────────────────────────────────────┤
|
|
15
|
+
│ │
|
|
16
|
+
│ Data Created ──► Active Storage ──► Archive ──► Deletion │
|
|
17
|
+
│ │ │ │ │ │
|
|
18
|
+
│ ▼ ▼ ▼ ▼ │
|
|
19
|
+
│ Log Entry Hot Storage Cold Storage Purge │
|
|
20
|
+
│ (0-90 days) (90+ days) (End of │
|
|
21
|
+
│ retention) │
|
|
22
|
+
│ │
|
|
23
|
+
└─────────────────────────────────────────────────────────────┘
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Retention Periods by Type
|
|
29
|
+
|
|
30
|
+
### Default Retention Schedule
|
|
31
|
+
|
|
32
|
+
| Data Type | Retention Period | Compliance Requirement |
|
|
33
|
+
|-----------|------------------|----------------------|
|
|
34
|
+
| Security Events | 7 years | SOC 2, HIPAA |
|
|
35
|
+
| Code Changes | 5 years | SOC 2, PCI-DSS |
|
|
36
|
+
| Deployment Logs | 3 years | SOC 2 |
|
|
37
|
+
| Access Logs | 1 year | GDPR, PCI-DSS |
|
|
38
|
+
| Feature Tracking | 2 years | Internal |
|
|
39
|
+
| Analysis Cache | 90 days | Internal |
|
|
40
|
+
| Temporary Files | 7 days | Internal |
|
|
41
|
+
|
|
42
|
+
### By Compliance Framework
|
|
43
|
+
|
|
44
|
+
**SOC 2:**
|
|
45
|
+
| Data Category | Minimum Retention |
|
|
46
|
+
|---------------|-------------------|
|
|
47
|
+
| Access control evidence | 1 year |
|
|
48
|
+
| Change management records | 1 year |
|
|
49
|
+
| Security incident logs | 3 years |
|
|
50
|
+
| Audit evidence | 3 years |
|
|
51
|
+
|
|
52
|
+
**GDPR:**
|
|
53
|
+
| Data Category | Maximum Retention |
|
|
54
|
+
|---------------|-------------------|
|
|
55
|
+
| Personal data | As needed + legitimate interest |
|
|
56
|
+
| Consent records | Duration of consent + 3 years |
|
|
57
|
+
| Data subject requests | 3 years |
|
|
58
|
+
| Processing records | Ongoing + 1 year |
|
|
59
|
+
|
|
60
|
+
**HIPAA:**
|
|
61
|
+
| Data Category | Minimum Retention |
|
|
62
|
+
|---------------|-------------------|
|
|
63
|
+
| PHI access logs | 6 years |
|
|
64
|
+
| Security documentation | 6 years |
|
|
65
|
+
| Risk assessments | 6 years |
|
|
66
|
+
| Training records | 6 years |
|
|
67
|
+
|
|
68
|
+
**PCI-DSS:**
|
|
69
|
+
| Data Category | Minimum Retention |
|
|
70
|
+
|---------------|-------------------|
|
|
71
|
+
| Audit trails | 1 year (3 months immediately available) |
|
|
72
|
+
| Security event logs | 1 year |
|
|
73
|
+
| Incident response | 1 year |
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Configuration
|
|
78
|
+
|
|
79
|
+
### Basic Configuration
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
# proagents.config.yaml
|
|
83
|
+
|
|
84
|
+
retention:
|
|
85
|
+
enabled: true
|
|
86
|
+
|
|
87
|
+
# Default retention (in days)
|
|
88
|
+
defaults:
|
|
89
|
+
security_events: 2555 # 7 years
|
|
90
|
+
code_changes: 1825 # 5 years
|
|
91
|
+
deployments: 1095 # 3 years
|
|
92
|
+
access_logs: 365 # 1 year
|
|
93
|
+
feature_data: 730 # 2 years
|
|
94
|
+
cache: 90
|
|
95
|
+
temp: 7
|
|
96
|
+
|
|
97
|
+
# Automatic cleanup
|
|
98
|
+
auto_cleanup:
|
|
99
|
+
enabled: true
|
|
100
|
+
schedule: "0 2 * * *" # 2 AM daily
|
|
101
|
+
dry_run_first: true
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Advanced Configuration
|
|
105
|
+
|
|
106
|
+
```yaml
|
|
107
|
+
retention:
|
|
108
|
+
enabled: true
|
|
109
|
+
|
|
110
|
+
# Custom retention by data type
|
|
111
|
+
policies:
|
|
112
|
+
# Security events
|
|
113
|
+
- name: "security_critical"
|
|
114
|
+
match:
|
|
115
|
+
event_type: ["vuln_critical", "permission_escalation", "secret_exposed"]
|
|
116
|
+
retention_days: 2555
|
|
117
|
+
storage_class: "cold"
|
|
118
|
+
encryption: true
|
|
119
|
+
|
|
120
|
+
# Code changes
|
|
121
|
+
- name: "code_changes"
|
|
122
|
+
match:
|
|
123
|
+
category: "code_change"
|
|
124
|
+
retention_days: 1825
|
|
125
|
+
archive_after_days: 365
|
|
126
|
+
storage_class: "standard"
|
|
127
|
+
|
|
128
|
+
# Access logs
|
|
129
|
+
- name: "access_logs"
|
|
130
|
+
match:
|
|
131
|
+
category: "access"
|
|
132
|
+
retention_days: 365
|
|
133
|
+
storage_class: "standard"
|
|
134
|
+
|
|
135
|
+
# Feature data
|
|
136
|
+
- name: "active_features"
|
|
137
|
+
match:
|
|
138
|
+
type: "feature_tracking"
|
|
139
|
+
status: "active"
|
|
140
|
+
retention_days: null # Keep while active
|
|
141
|
+
archive_on_complete: true
|
|
142
|
+
|
|
143
|
+
# Temporary data
|
|
144
|
+
- name: "temp_files"
|
|
145
|
+
match:
|
|
146
|
+
type: "temporary"
|
|
147
|
+
retention_days: 7
|
|
148
|
+
no_archive: true
|
|
149
|
+
|
|
150
|
+
# Storage classes
|
|
151
|
+
storage_classes:
|
|
152
|
+
hot:
|
|
153
|
+
max_age_days: 90
|
|
154
|
+
location: "local"
|
|
155
|
+
standard:
|
|
156
|
+
max_age_days: 365
|
|
157
|
+
location: "local"
|
|
158
|
+
cold:
|
|
159
|
+
min_age_days: 365
|
|
160
|
+
location: "s3-glacier"
|
|
161
|
+
|
|
162
|
+
# Archive settings
|
|
163
|
+
archive:
|
|
164
|
+
enabled: true
|
|
165
|
+
destination: "s3://company-archive"
|
|
166
|
+
compression: true
|
|
167
|
+
encryption: true
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Retention Rules
|
|
173
|
+
|
|
174
|
+
### Rule Syntax
|
|
175
|
+
|
|
176
|
+
```yaml
|
|
177
|
+
retention:
|
|
178
|
+
policies:
|
|
179
|
+
- name: "policy_name"
|
|
180
|
+
|
|
181
|
+
# Match criteria (all must match)
|
|
182
|
+
match:
|
|
183
|
+
category: "category_name"
|
|
184
|
+
event_type: ["type1", "type2"]
|
|
185
|
+
severity: "critical"
|
|
186
|
+
path: "src/auth/**"
|
|
187
|
+
custom:
|
|
188
|
+
field: "value"
|
|
189
|
+
|
|
190
|
+
# Retention settings
|
|
191
|
+
retention_days: 365 # Days to keep
|
|
192
|
+
archive_after_days: 90 # Days before archive
|
|
193
|
+
storage_class: "standard" # Storage tier
|
|
194
|
+
encryption: true # Encrypt at rest
|
|
195
|
+
|
|
196
|
+
# Deletion settings
|
|
197
|
+
deletion:
|
|
198
|
+
method: "secure" # standard, secure
|
|
199
|
+
verification: true # Verify deletion
|
|
200
|
+
notify: true # Notify on deletion
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Rule Priority
|
|
204
|
+
|
|
205
|
+
Rules are evaluated in order. First match wins:
|
|
206
|
+
|
|
207
|
+
```yaml
|
|
208
|
+
policies:
|
|
209
|
+
# Most specific first
|
|
210
|
+
- name: "critical_security"
|
|
211
|
+
match:
|
|
212
|
+
event_type: "vuln_critical"
|
|
213
|
+
retention_days: 2555
|
|
214
|
+
|
|
215
|
+
# General security
|
|
216
|
+
- name: "security_events"
|
|
217
|
+
match:
|
|
218
|
+
category: "security"
|
|
219
|
+
retention_days: 1825
|
|
220
|
+
|
|
221
|
+
# Catch-all
|
|
222
|
+
- name: "default"
|
|
223
|
+
match: {}
|
|
224
|
+
retention_days: 365
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
## Data Lifecycle Management
|
|
230
|
+
|
|
231
|
+
### Lifecycle Stages
|
|
232
|
+
|
|
233
|
+
```
|
|
234
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
235
|
+
│ Data Lifecycle │
|
|
236
|
+
├─────────────────────────────────────────────────────────────┤
|
|
237
|
+
│ │
|
|
238
|
+
│ Stage 1: Active (0-90 days) │
|
|
239
|
+
│ ├── Fast access │
|
|
240
|
+
│ ├── Hot storage │
|
|
241
|
+
│ └── Full detail │
|
|
242
|
+
│ │
|
|
243
|
+
│ Stage 2: Standard (90-365 days) │
|
|
244
|
+
│ ├── Normal access │
|
|
245
|
+
│ ├── Standard storage │
|
|
246
|
+
│ └── Full detail │
|
|
247
|
+
│ │
|
|
248
|
+
│ Stage 3: Archive (365+ days) │
|
|
249
|
+
│ ├── Slow access │
|
|
250
|
+
│ ├── Cold storage │
|
|
251
|
+
│ └── Compressed │
|
|
252
|
+
│ │
|
|
253
|
+
│ Stage 4: Deletion (End of retention) │
|
|
254
|
+
│ ├── Secure deletion │
|
|
255
|
+
│ ├── Verification │
|
|
256
|
+
│ └── Audit log │
|
|
257
|
+
│ │
|
|
258
|
+
└─────────────────────────────────────────────────────────────┘
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Automatic Transitions
|
|
262
|
+
|
|
263
|
+
```yaml
|
|
264
|
+
lifecycle:
|
|
265
|
+
transitions:
|
|
266
|
+
- from: "active"
|
|
267
|
+
to: "standard"
|
|
268
|
+
after_days: 90
|
|
269
|
+
|
|
270
|
+
- from: "standard"
|
|
271
|
+
to: "archive"
|
|
272
|
+
after_days: 365
|
|
273
|
+
actions:
|
|
274
|
+
- compress: true
|
|
275
|
+
- move_to_cold_storage: true
|
|
276
|
+
|
|
277
|
+
- from: "archive"
|
|
278
|
+
to: "deletion"
|
|
279
|
+
after_days: 2555 # End of retention
|
|
280
|
+
actions:
|
|
281
|
+
- secure_delete: true
|
|
282
|
+
- verify_deletion: true
|
|
283
|
+
- log_deletion: true
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
---
|
|
287
|
+
|
|
288
|
+
## Deletion Procedures
|
|
289
|
+
|
|
290
|
+
### Secure Deletion
|
|
291
|
+
|
|
292
|
+
```yaml
|
|
293
|
+
deletion:
|
|
294
|
+
# Standard deletion
|
|
295
|
+
standard:
|
|
296
|
+
method: "delete"
|
|
297
|
+
verify: false
|
|
298
|
+
|
|
299
|
+
# Secure deletion (for compliance)
|
|
300
|
+
secure:
|
|
301
|
+
method: "overwrite"
|
|
302
|
+
passes: 3 # Number of overwrites
|
|
303
|
+
verify: true
|
|
304
|
+
certificate: true # Generate deletion certificate
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Deletion Verification
|
|
308
|
+
|
|
309
|
+
```bash
|
|
310
|
+
# Preview what will be deleted
|
|
311
|
+
proagents retention preview-deletion
|
|
312
|
+
|
|
313
|
+
# Run deletion (dry run)
|
|
314
|
+
proagents retention cleanup --dry-run
|
|
315
|
+
|
|
316
|
+
# Run deletion
|
|
317
|
+
proagents retention cleanup
|
|
318
|
+
|
|
319
|
+
# Verify deletion
|
|
320
|
+
proagents retention verify-deletion --date 2024-01-15
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Deletion Certificate
|
|
324
|
+
|
|
325
|
+
For compliance, generate deletion certificates:
|
|
326
|
+
|
|
327
|
+
```json
|
|
328
|
+
{
|
|
329
|
+
"certificate_id": "del_cert_abc123",
|
|
330
|
+
"issued_at": "2024-01-15T10:00:00Z",
|
|
331
|
+
"data_deleted": {
|
|
332
|
+
"type": "access_logs",
|
|
333
|
+
"date_range": "2022-01-01 to 2022-12-31",
|
|
334
|
+
"record_count": 45678,
|
|
335
|
+
"storage_location": "s3://archive/2022/"
|
|
336
|
+
},
|
|
337
|
+
"deletion_method": "secure_overwrite_3pass",
|
|
338
|
+
"verification": {
|
|
339
|
+
"verified": true,
|
|
340
|
+
"verified_at": "2024-01-15T10:05:00Z",
|
|
341
|
+
"verifier": "system"
|
|
342
|
+
},
|
|
343
|
+
"signature": "sha256:abc123..."
|
|
344
|
+
}
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
---
|
|
348
|
+
|
|
349
|
+
## Legal Holds
|
|
350
|
+
|
|
351
|
+
### Implementing Legal Hold
|
|
352
|
+
|
|
353
|
+
When litigation requires data preservation:
|
|
354
|
+
|
|
355
|
+
```yaml
|
|
356
|
+
legal_holds:
|
|
357
|
+
- id: "hold_001"
|
|
358
|
+
name: "Case #12345"
|
|
359
|
+
created_at: "2024-01-15"
|
|
360
|
+
created_by: "legal@company.com"
|
|
361
|
+
|
|
362
|
+
# Scope
|
|
363
|
+
scope:
|
|
364
|
+
date_range:
|
|
365
|
+
from: "2023-01-01"
|
|
366
|
+
to: "2023-12-31"
|
|
367
|
+
categories:
|
|
368
|
+
- "code_changes"
|
|
369
|
+
- "deployments"
|
|
370
|
+
users:
|
|
371
|
+
- "developer@company.com"
|
|
372
|
+
paths:
|
|
373
|
+
- "src/payment/**"
|
|
374
|
+
|
|
375
|
+
# Settings
|
|
376
|
+
settings:
|
|
377
|
+
suspend_deletion: true
|
|
378
|
+
notify_on_access: true
|
|
379
|
+
export_required: true
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Legal Hold Commands
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
# Create legal hold
|
|
386
|
+
proagents retention hold create --name "Case #12345" --scope ./hold-scope.yaml
|
|
387
|
+
|
|
388
|
+
# List legal holds
|
|
389
|
+
proagents retention hold list
|
|
390
|
+
|
|
391
|
+
# Release legal hold
|
|
392
|
+
proagents retention hold release hold_001 --reason "Case closed"
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## Reporting
|
|
398
|
+
|
|
399
|
+
### Retention Report
|
|
400
|
+
|
|
401
|
+
```bash
|
|
402
|
+
# Generate retention report
|
|
403
|
+
proagents retention report
|
|
404
|
+
|
|
405
|
+
# Output:
|
|
406
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
407
|
+
│ Data Retention Report │
|
|
408
|
+
├─────────────────────────────────────────────────────────────┤
|
|
409
|
+
│ │
|
|
410
|
+
│ Current Storage: │
|
|
411
|
+
│ ├── Active (hot): 2.3 GB │
|
|
412
|
+
│ ├── Standard: 15.6 GB │
|
|
413
|
+
│ └── Archive (cold): 89.2 GB │
|
|
414
|
+
│ │
|
|
415
|
+
│ By Category: │
|
|
416
|
+
│ ├── Security Events: 45.2 GB (7 year retention) │
|
|
417
|
+
│ ├── Code Changes: 32.1 GB (5 year retention) │
|
|
418
|
+
│ ├── Deployments: 18.4 GB (3 year retention) │
|
|
419
|
+
│ └── Access Logs: 11.4 GB (1 year retention) │
|
|
420
|
+
│ │
|
|
421
|
+
│ Upcoming Deletions: │
|
|
422
|
+
│ ├── Next 30 days: 1.2 GB (access logs from 2023-01) │
|
|
423
|
+
│ ├── Next 90 days: 3.4 GB │
|
|
424
|
+
│ └── Next year: 12.8 GB │
|
|
425
|
+
│ │
|
|
426
|
+
│ Legal Holds: 1 active │
|
|
427
|
+
│ │
|
|
428
|
+
│ Compliance Status: │
|
|
429
|
+
│ ├── SOC 2: ✅ Meeting retention requirements │
|
|
430
|
+
│ ├── GDPR: ✅ Within limits │
|
|
431
|
+
│ └── PCI-DSS: ✅ Compliant │
|
|
432
|
+
│ │
|
|
433
|
+
└─────────────────────────────────────────────────────────────┘
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
### Compliance Verification
|
|
437
|
+
|
|
438
|
+
```bash
|
|
439
|
+
# Verify retention meets compliance
|
|
440
|
+
proagents retention verify --framework soc2 --framework gdpr
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
## Best Practices
|
|
446
|
+
|
|
447
|
+
1. **Document Policies**: Keep retention policies in version control
|
|
448
|
+
2. **Regular Reviews**: Review retention annually
|
|
449
|
+
3. **Test Deletion**: Verify secure deletion works correctly
|
|
450
|
+
4. **Monitor Storage**: Track storage growth trends
|
|
451
|
+
5. **Plan Ahead**: Budget for long-term storage costs
|
|
452
|
+
6. **Legal Coordination**: Coordinate holds with legal team
|
|
453
|
+
7. **Automate**: Use automatic lifecycle management
|
|
454
|
+
8. **Verify**: Regularly verify retention compliance
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# Configuration
|
|
2
|
+
|
|
3
|
+
Project-specific configuration files and customization.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
This directory contains configuration for customizing ProAgents to your project's needs.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Structure
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
proagents/config/
|
|
17
|
+
├── README.md # This file
|
|
18
|
+
├── proagents.config.yaml # Main configuration file
|
|
19
|
+
├── standards/ # Project coding standards
|
|
20
|
+
│ ├── README.md
|
|
21
|
+
│ ├── coding-standards.template.md
|
|
22
|
+
│ ├── architecture-rules.template.md
|
|
23
|
+
│ ├── naming-conventions.template.md
|
|
24
|
+
│ └── testing-standards.template.md
|
|
25
|
+
├── rules/ # Custom validation rules
|
|
26
|
+
│ ├── README.md
|
|
27
|
+
│ ├── custom-rules.template.yaml
|
|
28
|
+
│ └── validation-rules.template.yaml
|
|
29
|
+
├── templates/ # Code generation templates
|
|
30
|
+
│ ├── README.md
|
|
31
|
+
│ ├── component.template.tsx
|
|
32
|
+
│ ├── hook.template.ts
|
|
33
|
+
│ ├── api-route.template.ts
|
|
34
|
+
│ └── test.template.ts
|
|
35
|
+
└── integrations/ # Third-party integrations
|
|
36
|
+
├── README.md
|
|
37
|
+
└── [integration configs]
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Subdirectories
|
|
43
|
+
|
|
44
|
+
| Directory | Purpose | Documentation |
|
|
45
|
+
|-----------|---------|---------------|
|
|
46
|
+
| [standards/](./standards/) | Project coding standards | [README](./standards/README.md) |
|
|
47
|
+
| [rules/](./rules/) | Custom validation rules | [README](./rules/README.md) |
|
|
48
|
+
| [templates/](./templates/) | Code generation templates | [README](./templates/README.md) |
|
|
49
|
+
| [integrations/](./integrations/) | Integration configs | [README](./integrations/README.md) |
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Quick Start
|
|
54
|
+
|
|
55
|
+
### 1. Copy Main Config
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# Copy the default configuration
|
|
59
|
+
cp proagents/proagents.config.yaml proagents/config/proagents.config.yaml
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 2. Add Project Standards
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# Copy standards templates
|
|
66
|
+
cp proagents/config/standards/*.template.md proagents/config/standards/
|
|
67
|
+
|
|
68
|
+
# Remove .template from names
|
|
69
|
+
for f in proagents/config/standards/*.template.md; do
|
|
70
|
+
mv "$f" "${f%.template.md}.md"
|
|
71
|
+
done
|
|
72
|
+
|
|
73
|
+
# Edit for your project
|
|
74
|
+
vim proagents/config/standards/coding-standards.md
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### 3. Add Custom Rules
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Copy rules templates
|
|
81
|
+
cp proagents/config/rules/*.template.yaml proagents/config/rules/
|
|
82
|
+
|
|
83
|
+
# Edit for your project
|
|
84
|
+
vim proagents/config/rules/custom-rules.yaml
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### 4. Add Code Templates
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# Copy template files
|
|
91
|
+
cp proagents/config/templates/*.template.* proagents/config/templates/
|
|
92
|
+
|
|
93
|
+
# Customize for your project
|
|
94
|
+
vim proagents/config/templates/component.template.tsx
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Configuration Priority
|
|
100
|
+
|
|
101
|
+
When ProAgents runs, configuration is loaded in this order (later overrides earlier):
|
|
102
|
+
|
|
103
|
+
1. **Framework defaults** (lowest priority)
|
|
104
|
+
2. **Project config** (`proagents/config/`)
|
|
105
|
+
3. **Environment variables**
|
|
106
|
+
4. **Command line arguments** (highest priority)
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Main Configuration File
|
|
111
|
+
|
|
112
|
+
The `proagents.config.yaml` file controls all aspects of ProAgents:
|
|
113
|
+
|
|
114
|
+
```yaml
|
|
115
|
+
# proagents.config.yaml
|
|
116
|
+
|
|
117
|
+
project:
|
|
118
|
+
name: "My Project"
|
|
119
|
+
type: "fullstack"
|
|
120
|
+
|
|
121
|
+
# Checkpoints
|
|
122
|
+
checkpoints:
|
|
123
|
+
after_analysis: true
|
|
124
|
+
after_design: true
|
|
125
|
+
before_deployment: true
|
|
126
|
+
|
|
127
|
+
# Git integration
|
|
128
|
+
git:
|
|
129
|
+
enabled: true
|
|
130
|
+
branch_prefix: "feature/"
|
|
131
|
+
commit_convention: "conventional"
|
|
132
|
+
|
|
133
|
+
# Learning system
|
|
134
|
+
learning:
|
|
135
|
+
enabled: true
|
|
136
|
+
auto_apply_corrections: true
|
|
137
|
+
|
|
138
|
+
# Testing
|
|
139
|
+
testing:
|
|
140
|
+
framework: "vitest"
|
|
141
|
+
coverage_threshold: 80
|
|
142
|
+
|
|
143
|
+
# See proagents/proagents.config.yaml for full options
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Validation
|
|
149
|
+
|
|
150
|
+
Validate your configuration:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
# Check configuration is valid
|
|
154
|
+
proagents config validate
|
|
155
|
+
|
|
156
|
+
# Show resolved configuration
|
|
157
|
+
proagents config show
|
|
158
|
+
|
|
159
|
+
# Test against project
|
|
160
|
+
proagents config test
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Template Locations
|
|
166
|
+
|
|
167
|
+
Templates exist in two locations for flexibility:
|
|
168
|
+
|
|
169
|
+
| Location | Naming Convention | Purpose |
|
|
170
|
+
|----------|-------------------|---------|
|
|
171
|
+
| `config/standards/` | `*.template.md` | Project-specific standards |
|
|
172
|
+
| `config/rules/` | `*.template.yaml` | Project-specific rules |
|
|
173
|
+
| `standards/` | `*-template.md` | Framework defaults |
|
|
174
|
+
| `rules/` | `*-template.yaml` | Framework defaults |
|
|
175
|
+
|
|
176
|
+
**Recommendation:** Use `config/` for project customization. The root `standards/` and `rules/` directories contain framework defaults that can be extended.
|
|
177
|
+
|
|
178
|
+
When customizing:
|
|
179
|
+
1. Copy from `config/` templates (project-specific)
|
|
180
|
+
2. Or extend from root templates (framework defaults)
|
|
181
|
+
3. Both approaches work - choose based on your needs
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Integration Configurations
|
|
2
|
+
|
|
3
|
+
Configuration examples for integrating ProAgents with external tools.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Available Integrations
|
|
8
|
+
|
|
9
|
+
| Integration | Purpose | Config File |
|
|
10
|
+
|-------------|---------|-------------|
|
|
11
|
+
| Jira | Issue tracking, sprint management | `jira.yaml` |
|
|
12
|
+
| Linear | Modern issue tracking | `linear.yaml` |
|
|
13
|
+
| GitHub | Repository, PRs, Issues | `github.yaml` |
|
|
14
|
+
| Slack | Team notifications | `slack.yaml` |
|
|
15
|
+
| Notion | Documentation sync | `notion.yaml` |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Setup Process
|
|
20
|
+
|
|
21
|
+
1. **Copy the example config** to your `proagents.config.yaml`
|
|
22
|
+
2. **Set environment variables** for API keys (never commit secrets)
|
|
23
|
+
3. **Test the integration** with `/integration test <name>`
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Environment Variables
|
|
28
|
+
|
|
29
|
+
Create a `.env` file (gitignored) with your credentials:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# .env
|
|
33
|
+
JIRA_API_TOKEN=your-token
|
|
34
|
+
JIRA_EMAIL=your-email@company.com
|
|
35
|
+
LINEAR_API_KEY=lin_api_xxx
|
|
36
|
+
GITHUB_TOKEN=ghp_xxx
|
|
37
|
+
SLACK_WEBHOOK_URL=https://hooks.slack.com/...
|
|
38
|
+
NOTION_API_KEY=secret_xxx
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Testing Integrations
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Test single integration
|
|
47
|
+
proagents integration test jira
|
|
48
|
+
|
|
49
|
+
# Test all integrations
|
|
50
|
+
proagents integration test --all
|
|
51
|
+
|
|
52
|
+
# Check connection status
|
|
53
|
+
proagents integration status
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Common Issues
|
|
59
|
+
|
|
60
|
+
### Authentication Failures
|
|
61
|
+
- Verify API tokens are correct
|
|
62
|
+
- Check token permissions/scopes
|
|
63
|
+
- Ensure tokens haven't expired
|
|
64
|
+
|
|
65
|
+
### Connection Issues
|
|
66
|
+
- Check network/firewall settings
|
|
67
|
+
- Verify base URLs are correct
|
|
68
|
+
- Check for VPN requirements
|