@cregis-dev/cckit 0.2.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 +253 -0
- package/bin/cckit.js +3 -0
- package/package.json +52 -0
- package/registry.json +194 -0
- package/src/adapters/trae-adapter.js +90 -0
- package/src/cli.js +88 -0
- package/src/commands/add.js +192 -0
- package/src/commands/init.js +333 -0
- package/src/commands/status.js +62 -0
- package/src/commands/sync.js +325 -0
- package/src/commands/update.js +425 -0
- package/src/core/config.js +82 -0
- package/src/core/differ.js +57 -0
- package/src/core/installer.js +97 -0
- package/src/core/plugin-installer.js +237 -0
- package/src/core/registry.js +75 -0
- package/src/core/templatize.js +42 -0
- package/src/core/upstream.js +357 -0
- package/src/utils/fs.js +50 -0
- package/src/utils/logger.js +16 -0
- package/templates/bmad/_config/agent-manifest.csv +12 -0
- package/templates/bmad/_config/agents/bmm-analyst.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-architect.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-dev.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-pm.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-qa.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-quick-flow-solo-dev.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-sm.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-tech-writer.customize.yaml +41 -0
- package/templates/bmad/_config/agents/bmm-ux-designer.customize.yaml +41 -0
- package/templates/bmad/_config/agents/core-bmad-master.customize.yaml +41 -0
- package/templates/bmad/_config/agents/tea-tea.customize.yaml +41 -0
- package/templates/bmad/_config/bmad-help.csv +48 -0
- package/templates/bmad/_config/files-manifest.csv +431 -0
- package/templates/bmad/_config/ides/claude-code.yaml +5 -0
- package/templates/bmad/_config/ides/opencode.yaml +5 -0
- package/templates/bmad/_config/ides/trae.yaml +5 -0
- package/templates/bmad/_config/task-manifest.csv +7 -0
- package/templates/bmad/_config/tool-manifest.csv +1 -0
- package/templates/bmad/_config/workflow-manifest.csv +35 -0
- package/templates/bmad/bmm/agents/analyst.md +78 -0
- package/templates/bmad/bmm/agents/architect.md +58 -0
- package/templates/bmad/bmm/agents/dev.md +69 -0
- package/templates/bmad/bmm/agents/pm.md +72 -0
- package/templates/bmad/bmm/agents/qa.md +92 -0
- package/templates/bmad/bmm/agents/quick-flow-solo-dev.md +69 -0
- package/templates/bmad/bmm/agents/sm.md +70 -0
- package/templates/bmad/bmm/agents/tech-writer/tech-writer.md +70 -0
- package/templates/bmad/bmm/agents/ux-designer.md +57 -0
- package/templates/bmad/bmm/config.yaml +15 -0
- package/templates/bmad/bmm/data/project-context-template.md +26 -0
- package/templates/bmad/bmm/module-help.csv +31 -0
- package/templates/bmad/bmm/teams/default-party.csv +20 -0
- package/templates/bmad/bmm/teams/team-fullstack.yaml +12 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -0
- package/templates/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +444 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +476 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +487 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
- package/templates/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv +15 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md +197 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv +11 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md +191 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +152 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +224 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +226 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +213 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +207 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +226 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +237 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +228 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +231 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +242 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +217 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +124 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +247 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +249 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md +253 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md +168 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +226 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +191 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +174 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +231 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md +10 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/templates/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/templates/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +13 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +173 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +329 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/templates/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -0
- package/templates/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/templates/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/templates/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +43 -0
- package/templates/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/templates/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -0
- package/templates/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +53 -0
- package/templates/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/templates/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -0
- package/templates/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/templates/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +52 -0
- package/templates/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/templates/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/templates/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +20 -0
- package/templates/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -0
- package/templates/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +52 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -0
- package/templates/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +143 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +126 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/templates/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/templates/bmad/bmm/workflows/document-project/checklist.md +245 -0
- package/templates/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/templates/bmad/bmm/workflows/document-project/instructions.md +130 -0
- package/templates/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/templates/bmad/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/templates/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/templates/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/templates/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/templates/bmad/bmm/workflows/document-project/workflow.yaml +22 -0
- package/templates/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/templates/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/templates/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/templates/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/templates/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/templates/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/templates/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/templates/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/templates/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/templates/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
- package/templates/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
- package/templates/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
- package/templates/bmad/bmm/workflows/qa-generate-e2e-tests/checklist.md +33 -0
- package/templates/bmad/bmm/workflows/qa-generate-e2e-tests/instructions.md +110 -0
- package/templates/bmad/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +42 -0
- package/templates/bmad/commands/bmad-agent-bmad-master.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-analyst.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-architect.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-dev.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-pm.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-qa.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-quick-flow-solo-dev.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-sm.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-tech-writer.md +15 -0
- package/templates/bmad/commands/bmad-agent-bmm-ux-designer.md +15 -0
- package/templates/bmad/commands/bmad-agent-tea-tea.md +15 -0
- package/templates/bmad/commands/bmad-bmm-check-implementation-readiness.md +6 -0
- package/templates/bmad/commands/bmad-bmm-code-review.md +14 -0
- package/templates/bmad/commands/bmad-bmm-correct-course.md +14 -0
- package/templates/bmad/commands/bmad-bmm-create-architecture.md +6 -0
- package/templates/bmad/commands/bmad-bmm-create-epics-and-stories.md +6 -0
- package/templates/bmad/commands/bmad-bmm-create-prd.md +6 -0
- package/templates/bmad/commands/bmad-bmm-create-product-brief.md +6 -0
- package/templates/bmad/commands/bmad-bmm-create-story.md +14 -0
- package/templates/bmad/commands/bmad-bmm-create-ux-design.md +6 -0
- package/templates/bmad/commands/bmad-bmm-dev-story.md +14 -0
- package/templates/bmad/commands/bmad-bmm-document-project.md +14 -0
- package/templates/bmad/commands/bmad-bmm-domain-research.md +6 -0
- package/templates/bmad/commands/bmad-bmm-edit-prd.md +6 -0
- package/templates/bmad/commands/bmad-bmm-generate-project-context.md +6 -0
- package/templates/bmad/commands/bmad-bmm-market-research.md +6 -0
- package/templates/bmad/commands/bmad-bmm-qa-automate.md +15 -0
- package/templates/bmad/commands/bmad-bmm-qa-generate-e2e-tests.md +14 -0
- package/templates/bmad/commands/bmad-bmm-quick-dev.md +6 -0
- package/templates/bmad/commands/bmad-bmm-quick-spec.md +6 -0
- package/templates/bmad/commands/bmad-bmm-retrospective.md +14 -0
- package/templates/bmad/commands/bmad-bmm-sprint-planning.md +14 -0
- package/templates/bmad/commands/bmad-bmm-sprint-status.md +14 -0
- package/templates/bmad/commands/bmad-bmm-technical-research.md +6 -0
- package/templates/bmad/commands/bmad-bmm-validate-prd.md +6 -0
- package/templates/bmad/commands/bmad-brainstorming.md +6 -0
- package/templates/bmad/commands/bmad-editorial-review-prose.md +10 -0
- package/templates/bmad/commands/bmad-editorial-review-structure.md +10 -0
- package/templates/bmad/commands/bmad-help.md +10 -0
- package/templates/bmad/commands/bmad-index-docs.md +10 -0
- package/templates/bmad/commands/bmad-party-mode.md +6 -0
- package/templates/bmad/commands/bmad-review-adversarial-general.md +10 -0
- package/templates/bmad/commands/bmad-shard-doc.md +10 -0
- package/templates/bmad/commands/bmad-tea-teach-me-testing.md +6 -0
- package/templates/bmad/commands/bmad-tea-testarch-atdd.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-automate.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-ci.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-framework.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-nfr.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-test-design.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-test-review.md +14 -0
- package/templates/bmad/commands/bmad-tea-testarch-trace.md +14 -0
- package/templates/bmad/core/agents/bmad-master.md +56 -0
- package/templates/bmad/core/config.yaml +8 -0
- package/templates/bmad/core/module-help.csv +9 -0
- package/templates/bmad/core/tasks/editorial-review-prose.xml +102 -0
- package/templates/bmad/core/tasks/editorial-review-structure.xml +208 -0
- package/templates/bmad/core/tasks/help.md +86 -0
- package/templates/bmad/core/tasks/index-docs.xml +65 -0
- package/templates/bmad/core/tasks/review-adversarial-general.xml +49 -0
- package/templates/bmad/core/tasks/shard-doc.xml +108 -0
- package/templates/bmad/core/tasks/workflow.xml +235 -0
- package/templates/bmad/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/templates/bmad/core/workflows/advanced-elicitation/workflow.xml +118 -0
- package/templates/bmad/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/templates/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/templates/bmad/core/workflows/brainstorming/template.md +15 -0
- package/templates/bmad/core/workflows/brainstorming/workflow.md +58 -0
- package/templates/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
- package/templates/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/templates/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -0
- package/templates/bmad/core/workflows/party-mode/workflow.md +194 -0
- package/templates/bmad/tea/agents/tea.md +71 -0
- package/templates/bmad/tea/config.yaml +20 -0
- package/templates/bmad/tea/module-help.csv +10 -0
- package/templates/bmad/tea/teams/default-party.csv +2 -0
- package/templates/bmad/tea/testarch/knowledge/adr-quality-readiness-checklist.md +377 -0
- package/templates/bmad/tea/testarch/knowledge/api-request.md +563 -0
- package/templates/bmad/tea/testarch/knowledge/api-testing-patterns.md +915 -0
- package/templates/bmad/tea/testarch/knowledge/auth-session.md +548 -0
- package/templates/bmad/tea/testarch/knowledge/burn-in.md +273 -0
- package/templates/bmad/tea/testarch/knowledge/ci-burn-in.md +675 -0
- package/templates/bmad/tea/testarch/knowledge/component-tdd.md +486 -0
- package/templates/bmad/tea/testarch/knowledge/contract-testing.md +957 -0
- package/templates/bmad/tea/testarch/knowledge/data-factories.md +500 -0
- package/templates/bmad/tea/testarch/knowledge/email-auth.md +721 -0
- package/templates/bmad/tea/testarch/knowledge/error-handling.md +725 -0
- package/templates/bmad/tea/testarch/knowledge/feature-flags.md +750 -0
- package/templates/bmad/tea/testarch/knowledge/file-utils.md +456 -0
- package/templates/bmad/tea/testarch/knowledge/fixture-architecture.md +401 -0
- package/templates/bmad/tea/testarch/knowledge/fixtures-composition.md +382 -0
- package/templates/bmad/tea/testarch/knowledge/intercept-network-call.md +426 -0
- package/templates/bmad/tea/testarch/knowledge/log.md +426 -0
- package/templates/bmad/tea/testarch/knowledge/network-error-monitor.md +401 -0
- package/templates/bmad/tea/testarch/knowledge/network-first.md +486 -0
- package/templates/bmad/tea/testarch/knowledge/network-recorder.md +527 -0
- package/templates/bmad/tea/testarch/knowledge/nfr-criteria.md +670 -0
- package/templates/bmad/tea/testarch/knowledge/overview.md +286 -0
- package/templates/bmad/tea/testarch/knowledge/playwright-cli.md +165 -0
- package/templates/bmad/tea/testarch/knowledge/playwright-config.md +730 -0
- package/templates/bmad/tea/testarch/knowledge/probability-impact.md +601 -0
- package/templates/bmad/tea/testarch/knowledge/recurse.md +421 -0
- package/templates/bmad/tea/testarch/knowledge/risk-governance.md +615 -0
- package/templates/bmad/tea/testarch/knowledge/selective-testing.md +732 -0
- package/templates/bmad/tea/testarch/knowledge/selector-resilience.md +527 -0
- package/templates/bmad/tea/testarch/knowledge/test-healing-patterns.md +644 -0
- package/templates/bmad/tea/testarch/knowledge/test-levels-framework.md +473 -0
- package/templates/bmad/tea/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/templates/bmad/tea/testarch/knowledge/test-quality.md +664 -0
- package/templates/bmad/tea/testarch/knowledge/timing-debugging.md +372 -0
- package/templates/bmad/tea/testarch/knowledge/visual-debugging.md +524 -0
- package/templates/bmad/tea/testarch/tea-index.csv +36 -0
- package/templates/bmad/tea/workflows/testarch/README.md +74 -0
- package/templates/bmad/tea/workflows/testarch/atdd/atdd-checklist-template.md +371 -0
- package/templates/bmad/tea/workflows/testarch/atdd/checklist.md +374 -0
- package/templates/bmad/tea/workflows/testarch/atdd/instructions.md +45 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-01-preflight-and-context.md +196 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-01b-resume.md +96 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-02-generation-mode.md +125 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-03-test-strategy.md +110 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-04-generate-tests.md +229 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-04a-subprocess-api-failing.md +215 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-04b-subprocess-e2e-failing.md +244 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-04c-aggregate.md +354 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-c/step-05-validate-and-complete.md +106 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/atdd/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/atdd/validation-report-20260127-095021.md +73 -0
- package/templates/bmad/tea/workflows/testarch/atdd/validation-report-20260127-102401.md +116 -0
- package/templates/bmad/tea/workflows/testarch/atdd/workflow-plan.md +21 -0
- package/templates/bmad/tea/workflows/testarch/atdd/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/atdd/workflow.yaml +46 -0
- package/templates/bmad/tea/workflows/testarch/automate/checklist.md +582 -0
- package/templates/bmad/tea/workflows/testarch/automate/instructions.md +50 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-01-preflight-and-context.md +205 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-01b-resume.md +94 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-02-identify-targets.md +145 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-03-generate-tests.md +278 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-03a-subprocess-api.md +183 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-03b-subprocess-backend.md +246 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-03b-subprocess-e2e.md +213 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-03c-aggregate.md +377 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-c/step-04-validate-and-summarize.md +106 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/automate/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/automate/validation-report-20260127-095021.md +72 -0
- package/templates/bmad/tea/workflows/testarch/automate/validation-report-20260127-102401.md +114 -0
- package/templates/bmad/tea/workflows/testarch/automate/workflow-plan.md +20 -0
- package/templates/bmad/tea/workflows/testarch/automate/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/automate/workflow.yaml +53 -0
- package/templates/bmad/tea/workflows/testarch/ci/azure-pipelines-template.yaml +155 -0
- package/templates/bmad/tea/workflows/testarch/ci/checklist.md +288 -0
- package/templates/bmad/tea/workflows/testarch/ci/github-actions-template.yaml +210 -0
- package/templates/bmad/tea/workflows/testarch/ci/gitlab-ci-template.yaml +158 -0
- package/templates/bmad/tea/workflows/testarch/ci/harness-pipeline-template.yaml +159 -0
- package/templates/bmad/tea/workflows/testarch/ci/instructions.md +45 -0
- package/templates/bmad/tea/workflows/testarch/ci/jenkins-pipeline-template.groovy +129 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-c/step-01-preflight.md +158 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-c/step-01b-resume.md +110 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-c/step-02-generate-pipeline.md +118 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-c/step-03-configure-quality-gates.md +105 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-c/step-04-validate-and-summary.md +92 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/ci/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/ci/validation-report-20260127-095021.md +72 -0
- package/templates/bmad/tea/workflows/testarch/ci/validation-report-20260127-102401.md +114 -0
- package/templates/bmad/tea/workflows/testarch/ci/workflow-plan.md +20 -0
- package/templates/bmad/tea/workflows/testarch/ci/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/ci/workflow.yaml +48 -0
- package/templates/bmad/tea/workflows/testarch/framework/checklist.md +321 -0
- package/templates/bmad/tea/workflows/testarch/framework/instructions.md +45 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-01-preflight.md +132 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-01b-resume.md +116 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-02-select-framework.md +117 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-03-scaffold-framework.md +196 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-04-docs-and-scripts.md +105 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-c/step-05-validate-and-summary.md +93 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/framework/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/framework/validation-report-20260127-095021.md +73 -0
- package/templates/bmad/tea/workflows/testarch/framework/validation-report-20260127-102401.md +116 -0
- package/templates/bmad/tea/workflows/testarch/framework/workflow-plan.md +22 -0
- package/templates/bmad/tea/workflows/testarch/framework/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/framework/workflow.yaml +48 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/instructions.md +43 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/nfr-report-template.md +470 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-01-load-context.md +138 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-01b-resume.md +106 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-02-define-thresholds.md +107 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-03-gather-evidence.md +108 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04-evaluate-and-score.md +140 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04a-subprocess-security.md +138 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04b-subprocess-performance.md +84 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04c-subprocess-reliability.md +85 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04d-subprocess-scalability.md +88 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-04e-aggregate-nfr.md +247 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-c/step-05-generate-report.md +108 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/validation-report-20260127-095021.md +73 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/validation-report-20260127-102401.md +116 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/workflow-plan.md +19 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/nfr-assess/workflow.yaml +48 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/checklist.md +197 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/data/curriculum.yaml +129 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/data/quiz-questions.yaml +206 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/data/role-paths.yaml +136 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/data/session-content-map.yaml +207 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/data/tea-resources-index.yaml +359 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/instructions.md +130 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-01-init.md +235 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-01b-continue.md +147 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-02-assess.md +258 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-03-session-menu.md +219 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-01.md +460 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-02.md +465 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-03.md +301 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-04.md +234 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-05.md +234 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-06.md +209 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-04-session-07.md +212 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-c/step-05-completion.md +339 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-e/step-e-01-assess-workflow.md +141 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-e/step-e-02-apply-edits.md +122 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/steps-v/step-v-01-validate.md +263 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/templates/certificate-template.md +86 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/templates/progress-template.yaml +95 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/templates/session-notes-template.md +83 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/workflow-plan-teach-me-testing.md +950 -0
- package/templates/bmad/tea/workflows/testarch/teach-me-testing/workflow.md +90 -0
- package/templates/bmad/tea/workflows/testarch/test-design/checklist.md +464 -0
- package/templates/bmad/tea/workflows/testarch/test-design/instructions.md +105 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-01-detect-mode.md +134 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-01b-resume.md +102 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-02-load-context.md +212 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-03-risk-and-testability.md +110 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-04-coverage-plan.md +123 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-c/step-05-generate-output.md +151 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/test-design/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/test-design/test-design-architecture-template.md +230 -0
- package/templates/bmad/tea/workflows/testarch/test-design/test-design-handoff-template.md +70 -0
- package/templates/bmad/tea/workflows/testarch/test-design/test-design-qa-template.md +396 -0
- package/templates/bmad/tea/workflows/testarch/test-design/test-design-template.md +344 -0
- package/templates/bmad/tea/workflows/testarch/test-design/validation-report-20260127-095021.md +73 -0
- package/templates/bmad/tea/workflows/testarch/test-design/validation-report-20260127-102401.md +116 -0
- package/templates/bmad/tea/workflows/testarch/test-design/workflow-plan.md +22 -0
- package/templates/bmad/tea/workflows/testarch/test-design/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/test-design/workflow.yaml +77 -0
- package/templates/bmad/tea/workflows/testarch/test-review/checklist.md +475 -0
- package/templates/bmad/tea/workflows/testarch/test-review/instructions.md +45 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-01-load-context.md +169 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-01b-resume.md +104 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-02-discover-tests.md +113 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03-quality-evaluation.md +173 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03a-subprocess-determinism.md +214 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03b-subprocess-isolation.md +125 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03c-subprocess-maintainability.md +102 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03d-subprocess-coverage.md +111 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03e-subprocess-performance.md +117 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-03f-aggregate-scores.md +277 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-c/step-04-generate-report.md +111 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/test-review/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/test-review/test-review-template.md +387 -0
- package/templates/bmad/tea/workflows/testarch/test-review/validation-report-20260127-095021.md +72 -0
- package/templates/bmad/tea/workflows/testarch/test-review/validation-report-20260127-102401.md +114 -0
- package/templates/bmad/tea/workflows/testarch/test-review/workflow-plan.md +18 -0
- package/templates/bmad/tea/workflows/testarch/test-review/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/test-review/workflow.yaml +48 -0
- package/templates/bmad/tea/workflows/testarch/trace/checklist.md +647 -0
- package/templates/bmad/tea/workflows/testarch/trace/instructions.md +43 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-01-load-context.md +105 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-01b-resume.md +102 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-02-discover-tests.md +112 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-03-map-criteria.md +97 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-04-analyze-gaps.md +330 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-c/step-05-gate-decision.md +266 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-e/step-01-assess.md +65 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-e/step-02-apply-edit.md +60 -0
- package/templates/bmad/tea/workflows/testarch/trace/steps-v/step-01-validate.md +67 -0
- package/templates/bmad/tea/workflows/testarch/trace/trace-template.md +708 -0
- package/templates/bmad/tea/workflows/testarch/trace/validation-report-20260127-095021.md +73 -0
- package/templates/bmad/tea/workflows/testarch/trace/validation-report-20260127-102401.md +116 -0
- package/templates/bmad/tea/workflows/testarch/trace/workflow-plan.md +21 -0
- package/templates/bmad/tea/workflows/testarch/trace/workflow.md +41 -0
- package/templates/bmad/tea/workflows/testarch/trace/workflow.yaml +56 -0
- package/templates/ecc/agents/architect.md +211 -0
- package/templates/ecc/agents/build-error-resolver.md +114 -0
- package/templates/ecc/agents/code-reviewer.md +224 -0
- package/templates/ecc/agents/database-reviewer.md +91 -0
- package/templates/ecc/agents/doc-updater.md +107 -0
- package/templates/ecc/agents/e2e-runner.md +107 -0
- package/templates/ecc/agents/go-build-resolver.md +94 -0
- package/templates/ecc/agents/go-reviewer.md +76 -0
- package/templates/ecc/agents/planner.md +212 -0
- package/templates/ecc/agents/python-reviewer.md +98 -0
- package/templates/ecc/agents/refactor-cleaner.md +85 -0
- package/templates/ecc/agents/security-reviewer.md +108 -0
- package/templates/ecc/agents/tdd-guide.md +80 -0
- package/templates/ecc/commands/build-fix.md +62 -0
- package/templates/ecc/commands/checkpoint.md +74 -0
- package/templates/ecc/commands/code-review.md +40 -0
- package/templates/ecc/commands/e2e.md +363 -0
- package/templates/ecc/commands/eval.md +120 -0
- package/templates/ecc/commands/evolve.md +193 -0
- package/templates/ecc/commands/go-build.md +183 -0
- package/templates/ecc/commands/go-review.md +148 -0
- package/templates/ecc/commands/go-test.md +268 -0
- package/templates/ecc/commands/instinct-export.md +91 -0
- package/templates/ecc/commands/instinct-import.md +142 -0
- package/templates/ecc/commands/instinct-status.md +86 -0
- package/templates/ecc/commands/learn-eval.md +91 -0
- package/templates/ecc/commands/learn.md +70 -0
- package/templates/ecc/commands/multi-backend.md +158 -0
- package/templates/ecc/commands/multi-execute.md +310 -0
- package/templates/ecc/commands/multi-frontend.md +158 -0
- package/templates/ecc/commands/multi-plan.md +261 -0
- package/templates/ecc/commands/multi-workflow.md +183 -0
- package/templates/ecc/commands/orchestrate.md +172 -0
- package/templates/ecc/commands/plan.md +113 -0
- package/templates/ecc/commands/pm2.md +272 -0
- package/templates/ecc/commands/python-review.md +297 -0
- package/templates/ecc/commands/refactor-clean.md +80 -0
- package/templates/ecc/commands/sessions.md +305 -0
- package/templates/ecc/commands/setup-pm.md +80 -0
- package/templates/ecc/commands/skill-create.md +174 -0
- package/templates/ecc/commands/tdd.md +326 -0
- package/templates/ecc/commands/test-coverage.md +69 -0
- package/templates/ecc/commands/update-codemaps.md +72 -0
- package/templates/ecc/commands/update-docs.md +84 -0
- package/templates/ecc/commands/verify.md +59 -0
- package/templates/ecc/rules/README.md +82 -0
- package/templates/ecc/rules/common/agents.md +49 -0
- package/templates/ecc/rules/common/coding-style.md +48 -0
- package/templates/ecc/rules/common/git-workflow.md +45 -0
- package/templates/ecc/rules/common/hooks.md +30 -0
- package/templates/ecc/rules/common/patterns.md +31 -0
- package/templates/ecc/rules/common/performance.md +55 -0
- package/templates/ecc/rules/common/security.md +29 -0
- package/templates/ecc/rules/common/testing.md +29 -0
- package/templates/ecc/rules/golang/coding-style.md +32 -0
- package/templates/ecc/rules/golang/hooks.md +17 -0
- package/templates/ecc/rules/golang/patterns.md +45 -0
- package/templates/ecc/rules/golang/security.md +34 -0
- package/templates/ecc/rules/golang/testing.md +31 -0
- package/templates/ecc/rules/python/coding-style.md +42 -0
- package/templates/ecc/rules/python/hooks.md +19 -0
- package/templates/ecc/rules/python/patterns.md +39 -0
- package/templates/ecc/rules/python/security.md +30 -0
- package/templates/ecc/rules/python/testing.md +38 -0
- package/templates/ecc/rules/typescript/coding-style.md +65 -0
- package/templates/ecc/rules/typescript/hooks.md +22 -0
- package/templates/ecc/rules/typescript/patterns.md +52 -0
- package/templates/ecc/rules/typescript/security.md +28 -0
- package/templates/ecc/rules/typescript/testing.md +18 -0
- package/templates/ecc/skills/api-design/SKILL.md +522 -0
- package/templates/ecc/skills/backend-patterns/SKILL.md +597 -0
- package/templates/ecc/skills/clickhouse-io/SKILL.md +438 -0
- package/templates/ecc/skills/coding-standards/SKILL.md +529 -0
- package/templates/ecc/skills/configure-ecc/SKILL.md +298 -0
- package/templates/ecc/skills/content-hash-cache-pattern/SKILL.md +160 -0
- package/templates/ecc/skills/continuous-learning/SKILL.md +118 -0
- package/templates/ecc/skills/continuous-learning/config.json +18 -0
- package/templates/ecc/skills/continuous-learning/evaluate-session.sh +69 -0
- package/templates/ecc/skills/continuous-learning-v2/SKILL.md +292 -0
- package/templates/ecc/skills/continuous-learning-v2/agents/observer.md +137 -0
- package/templates/ecc/skills/continuous-learning-v2/agents/start-observer.sh +143 -0
- package/templates/ecc/skills/continuous-learning-v2/config.json +41 -0
- package/templates/ecc/skills/continuous-learning-v2/hooks/observe.sh +157 -0
- package/templates/ecc/skills/continuous-learning-v2/scripts/instinct-cli.py +575 -0
- package/templates/ecc/skills/continuous-learning-v2/scripts/test_parse_instinct.py +82 -0
- package/templates/ecc/skills/cost-aware-llm-pipeline/SKILL.md +182 -0
- package/templates/ecc/skills/cpp-coding-standards/SKILL.md +722 -0
- package/templates/ecc/skills/cpp-testing/SKILL.md +322 -0
- package/templates/ecc/skills/database-migrations/SKILL.md +334 -0
- package/templates/ecc/skills/deployment-patterns/SKILL.md +426 -0
- package/templates/ecc/skills/django-patterns/SKILL.md +733 -0
- package/templates/ecc/skills/django-security/SKILL.md +592 -0
- package/templates/ecc/skills/django-tdd/SKILL.md +728 -0
- package/templates/ecc/skills/django-verification/SKILL.md +468 -0
- package/templates/ecc/skills/docker-patterns/SKILL.md +363 -0
- package/templates/ecc/skills/e2e-testing/SKILL.md +325 -0
- package/templates/ecc/skills/eval-harness/SKILL.md +235 -0
- package/templates/ecc/skills/frontend-patterns/SKILL.md +641 -0
- package/templates/ecc/skills/golang-patterns/SKILL.md +673 -0
- package/templates/ecc/skills/golang-testing/SKILL.md +719 -0
- package/templates/ecc/skills/iterative-retrieval/SKILL.md +210 -0
- package/templates/ecc/skills/java-coding-standards/SKILL.md +146 -0
- package/templates/ecc/skills/jpa-patterns/SKILL.md +150 -0
- package/templates/ecc/skills/nutrient-document-processing/SKILL.md +165 -0
- package/templates/ecc/skills/postgres-patterns/SKILL.md +146 -0
- package/templates/ecc/skills/project-guidelines-example/SKILL.md +348 -0
- package/templates/ecc/skills/python-patterns/SKILL.md +749 -0
- package/templates/ecc/skills/python-testing/SKILL.md +815 -0
- package/templates/ecc/skills/regex-vs-llm-structured-text/SKILL.md +219 -0
- package/templates/ecc/skills/search-first/SKILL.md +159 -0
- package/templates/ecc/skills/security-review/SKILL.md +494 -0
- package/templates/ecc/skills/security-review/cloud-infrastructure-security.md +361 -0
- package/templates/ecc/skills/security-scan/SKILL.md +164 -0
- package/templates/ecc/skills/springboot-patterns/SKILL.md +313 -0
- package/templates/ecc/skills/springboot-security/SKILL.md +271 -0
- package/templates/ecc/skills/springboot-tdd/SKILL.md +157 -0
- package/templates/ecc/skills/springboot-verification/SKILL.md +230 -0
- package/templates/ecc/skills/strategic-compact/SKILL.md +102 -0
- package/templates/ecc/skills/strategic-compact/suggest-compact.sh +54 -0
- package/templates/ecc/skills/swift-actor-persistence/SKILL.md +142 -0
- package/templates/ecc/skills/swift-protocol-di-testing/SKILL.md +189 -0
- package/templates/ecc/skills/tdd-workflow/SKILL.md +409 -0
- package/templates/ecc/skills/verification-loop/SKILL.md +125 -0
- package/templates/ext-skills/pinchtab/SKILL.md +570 -0
- package/templates/mcp/claude-code/.mcp.json +35 -0
- package/templates/mcp/trae/mcp.json +35 -0
- package/templates/trae-bmad/rules/bmad-agent-bmad-master.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-analyst.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-architect.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-dev.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-pm.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-qa.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-quick-flow-solo-dev.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-sm.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-tech-writer.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-bmm-ux-designer.md +15 -0
- package/templates/trae-bmad/rules/bmad-agent-tea-tea.md +15 -0
- package/templates/trae-bmad/rules/bmad-bmm-check-implementation-readiness.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-code-review.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-correct-course.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-architecture.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-epics-and-stories.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-prd.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-product-brief.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-story.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-create-ux-design.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-dev-story.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-document-project.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-domain-research.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-edit-prd.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-generate-project-context.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-market-research.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-qa-automate.md +15 -0
- package/templates/trae-bmad/rules/bmad-bmm-qa-generate-e2e-tests.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-quick-dev.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-quick-spec.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-retrospective.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-sprint-planning.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-sprint-status.md +14 -0
- package/templates/trae-bmad/rules/bmad-bmm-technical-research.md +6 -0
- package/templates/trae-bmad/rules/bmad-bmm-validate-prd.md +6 -0
- package/templates/trae-bmad/rules/bmad-brainstorming.md +6 -0
- package/templates/trae-bmad/rules/bmad-editorial-review-prose.md +10 -0
- package/templates/trae-bmad/rules/bmad-editorial-review-structure.md +10 -0
- package/templates/trae-bmad/rules/bmad-help.md +10 -0
- package/templates/trae-bmad/rules/bmad-index-docs.md +10 -0
- package/templates/trae-bmad/rules/bmad-party-mode.md +6 -0
- package/templates/trae-bmad/rules/bmad-review-adversarial-general.md +10 -0
- package/templates/trae-bmad/rules/bmad-shard-doc.md +10 -0
- package/templates/trae-bmad/rules/bmad-tea-teach-me-testing.md +6 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-atdd.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-automate.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-ci.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-framework.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-nfr.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-test-design.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-test-review.md +14 -0
- package/templates/trae-bmad/rules/bmad-tea-testarch-trace.md +14 -0
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: iterative-retrieval
|
|
3
|
+
description: Pattern for progressively refining context retrieval to solve the subagent context problem
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Iterative Retrieval Pattern
|
|
7
|
+
|
|
8
|
+
Solves the "context problem" in multi-agent workflows where subagents don't know what context they need until they start working.
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
- Spawning subagents that need codebase context they cannot predict upfront
|
|
13
|
+
- Building multi-agent workflows where context is progressively refined
|
|
14
|
+
- Encountering "context too large" or "missing context" failures in agent tasks
|
|
15
|
+
- Designing RAG-like retrieval pipelines for code exploration
|
|
16
|
+
- Optimizing token usage in agent orchestration
|
|
17
|
+
|
|
18
|
+
## The Problem
|
|
19
|
+
|
|
20
|
+
Subagents are spawned with limited context. They don't know:
|
|
21
|
+
- Which files contain relevant code
|
|
22
|
+
- What patterns exist in the codebase
|
|
23
|
+
- What terminology the project uses
|
|
24
|
+
|
|
25
|
+
Standard approaches fail:
|
|
26
|
+
- **Send everything**: Exceeds context limits
|
|
27
|
+
- **Send nothing**: Agent lacks critical information
|
|
28
|
+
- **Guess what's needed**: Often wrong
|
|
29
|
+
|
|
30
|
+
## The Solution: Iterative Retrieval
|
|
31
|
+
|
|
32
|
+
A 4-phase loop that progressively refines context:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
┌─────────────────────────────────────────────┐
|
|
36
|
+
│ │
|
|
37
|
+
│ ┌──────────┐ ┌──────────┐ │
|
|
38
|
+
│ │ DISPATCH │─────▶│ EVALUATE │ │
|
|
39
|
+
│ └──────────┘ └──────────┘ │
|
|
40
|
+
│ ▲ │ │
|
|
41
|
+
│ │ ▼ │
|
|
42
|
+
│ ┌──────────┐ ┌──────────┐ │
|
|
43
|
+
│ │ LOOP │◀─────│ REFINE │ │
|
|
44
|
+
│ └──────────┘ └──────────┘ │
|
|
45
|
+
│ │
|
|
46
|
+
│ Max 3 cycles, then proceed │
|
|
47
|
+
└─────────────────────────────────────────────┘
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Phase 1: DISPATCH
|
|
51
|
+
|
|
52
|
+
Initial broad query to gather candidate files:
|
|
53
|
+
|
|
54
|
+
```javascript
|
|
55
|
+
// Start with high-level intent
|
|
56
|
+
const initialQuery = {
|
|
57
|
+
patterns: ['src/**/*.ts', 'lib/**/*.ts'],
|
|
58
|
+
keywords: ['authentication', 'user', 'session'],
|
|
59
|
+
excludes: ['*.test.ts', '*.spec.ts']
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
// Dispatch to retrieval agent
|
|
63
|
+
const candidates = await retrieveFiles(initialQuery);
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Phase 2: EVALUATE
|
|
67
|
+
|
|
68
|
+
Assess retrieved content for relevance:
|
|
69
|
+
|
|
70
|
+
```javascript
|
|
71
|
+
function evaluateRelevance(files, task) {
|
|
72
|
+
return files.map(file => ({
|
|
73
|
+
path: file.path,
|
|
74
|
+
relevance: scoreRelevance(file.content, task),
|
|
75
|
+
reason: explainRelevance(file.content, task),
|
|
76
|
+
missingContext: identifyGaps(file.content, task)
|
|
77
|
+
}));
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Scoring criteria:
|
|
82
|
+
- **High (0.8-1.0)**: Directly implements target functionality
|
|
83
|
+
- **Medium (0.5-0.7)**: Contains related patterns or types
|
|
84
|
+
- **Low (0.2-0.4)**: Tangentially related
|
|
85
|
+
- **None (0-0.2)**: Not relevant, exclude
|
|
86
|
+
|
|
87
|
+
### Phase 3: REFINE
|
|
88
|
+
|
|
89
|
+
Update search criteria based on evaluation:
|
|
90
|
+
|
|
91
|
+
```javascript
|
|
92
|
+
function refineQuery(evaluation, previousQuery) {
|
|
93
|
+
return {
|
|
94
|
+
// Add new patterns discovered in high-relevance files
|
|
95
|
+
patterns: [...previousQuery.patterns, ...extractPatterns(evaluation)],
|
|
96
|
+
|
|
97
|
+
// Add terminology found in codebase
|
|
98
|
+
keywords: [...previousQuery.keywords, ...extractKeywords(evaluation)],
|
|
99
|
+
|
|
100
|
+
// Exclude confirmed irrelevant paths
|
|
101
|
+
excludes: [...previousQuery.excludes, ...evaluation
|
|
102
|
+
.filter(e => e.relevance < 0.2)
|
|
103
|
+
.map(e => e.path)
|
|
104
|
+
],
|
|
105
|
+
|
|
106
|
+
// Target specific gaps
|
|
107
|
+
focusAreas: evaluation
|
|
108
|
+
.flatMap(e => e.missingContext)
|
|
109
|
+
.filter(unique)
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Phase 4: LOOP
|
|
115
|
+
|
|
116
|
+
Repeat with refined criteria (max 3 cycles):
|
|
117
|
+
|
|
118
|
+
```javascript
|
|
119
|
+
async function iterativeRetrieve(task, maxCycles = 3) {
|
|
120
|
+
let query = createInitialQuery(task);
|
|
121
|
+
let bestContext = [];
|
|
122
|
+
|
|
123
|
+
for (let cycle = 0; cycle < maxCycles; cycle++) {
|
|
124
|
+
const candidates = await retrieveFiles(query);
|
|
125
|
+
const evaluation = evaluateRelevance(candidates, task);
|
|
126
|
+
|
|
127
|
+
// Check if we have sufficient context
|
|
128
|
+
const highRelevance = evaluation.filter(e => e.relevance >= 0.7);
|
|
129
|
+
if (highRelevance.length >= 3 && !hasCriticalGaps(evaluation)) {
|
|
130
|
+
return highRelevance;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
// Refine and continue
|
|
134
|
+
query = refineQuery(evaluation, query);
|
|
135
|
+
bestContext = mergeContext(bestContext, highRelevance);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
return bestContext;
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Practical Examples
|
|
143
|
+
|
|
144
|
+
### Example 1: Bug Fix Context
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
Task: "Fix the authentication token expiry bug"
|
|
148
|
+
|
|
149
|
+
Cycle 1:
|
|
150
|
+
DISPATCH: Search for "token", "auth", "expiry" in src/**
|
|
151
|
+
EVALUATE: Found auth.ts (0.9), tokens.ts (0.8), user.ts (0.3)
|
|
152
|
+
REFINE: Add "refresh", "jwt" keywords; exclude user.ts
|
|
153
|
+
|
|
154
|
+
Cycle 2:
|
|
155
|
+
DISPATCH: Search refined terms
|
|
156
|
+
EVALUATE: Found session-manager.ts (0.95), jwt-utils.ts (0.85)
|
|
157
|
+
REFINE: Sufficient context (2 high-relevance files)
|
|
158
|
+
|
|
159
|
+
Result: auth.ts, tokens.ts, session-manager.ts, jwt-utils.ts
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Example 2: Feature Implementation
|
|
163
|
+
|
|
164
|
+
```
|
|
165
|
+
Task: "Add rate limiting to API endpoints"
|
|
166
|
+
|
|
167
|
+
Cycle 1:
|
|
168
|
+
DISPATCH: Search "rate", "limit", "api" in routes/**
|
|
169
|
+
EVALUATE: No matches - codebase uses "throttle" terminology
|
|
170
|
+
REFINE: Add "throttle", "middleware" keywords
|
|
171
|
+
|
|
172
|
+
Cycle 2:
|
|
173
|
+
DISPATCH: Search refined terms
|
|
174
|
+
EVALUATE: Found throttle.ts (0.9), middleware/index.ts (0.7)
|
|
175
|
+
REFINE: Need router patterns
|
|
176
|
+
|
|
177
|
+
Cycle 3:
|
|
178
|
+
DISPATCH: Search "router", "express" patterns
|
|
179
|
+
EVALUATE: Found router-setup.ts (0.8)
|
|
180
|
+
REFINE: Sufficient context
|
|
181
|
+
|
|
182
|
+
Result: throttle.ts, middleware/index.ts, router-setup.ts
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## Integration with Agents
|
|
186
|
+
|
|
187
|
+
Use in agent prompts:
|
|
188
|
+
|
|
189
|
+
```markdown
|
|
190
|
+
When retrieving context for this task:
|
|
191
|
+
1. Start with broad keyword search
|
|
192
|
+
2. Evaluate each file's relevance (0-1 scale)
|
|
193
|
+
3. Identify what context is still missing
|
|
194
|
+
4. Refine search criteria and repeat (max 3 cycles)
|
|
195
|
+
5. Return files with relevance >= 0.7
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Best Practices
|
|
199
|
+
|
|
200
|
+
1. **Start broad, narrow progressively** - Don't over-specify initial queries
|
|
201
|
+
2. **Learn codebase terminology** - First cycle often reveals naming conventions
|
|
202
|
+
3. **Track what's missing** - Explicit gap identification drives refinement
|
|
203
|
+
4. **Stop at "good enough"** - 3 high-relevance files beats 10 mediocre ones
|
|
204
|
+
5. **Exclude confidently** - Low-relevance files won't become relevant
|
|
205
|
+
|
|
206
|
+
## Related
|
|
207
|
+
|
|
208
|
+
- [The Longform Guide](https://x.com/affaanmustafa/status/2014040193557471352) - Subagent orchestration section
|
|
209
|
+
- `continuous-learning` skill - For patterns that improve over time
|
|
210
|
+
- Agent definitions in `~/.claude/agents/`
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: java-coding-standards
|
|
3
|
+
description: "Java coding standards for Spring Boot services: naming, immutability, Optional usage, streams, exceptions, generics, and project layout."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Java Coding Standards
|
|
7
|
+
|
|
8
|
+
Standards for readable, maintainable Java (17+) code in Spring Boot services.
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
- Writing or reviewing Java code in Spring Boot projects
|
|
13
|
+
- Enforcing naming, immutability, or exception handling conventions
|
|
14
|
+
- Working with records, sealed classes, or pattern matching (Java 17+)
|
|
15
|
+
- Reviewing use of Optional, streams, or generics
|
|
16
|
+
- Structuring packages and project layout
|
|
17
|
+
|
|
18
|
+
## Core Principles
|
|
19
|
+
|
|
20
|
+
- Prefer clarity over cleverness
|
|
21
|
+
- Immutable by default; minimize shared mutable state
|
|
22
|
+
- Fail fast with meaningful exceptions
|
|
23
|
+
- Consistent naming and package structure
|
|
24
|
+
|
|
25
|
+
## Naming
|
|
26
|
+
|
|
27
|
+
```java
|
|
28
|
+
// ✅ Classes/Records: PascalCase
|
|
29
|
+
public class MarketService {}
|
|
30
|
+
public record Money(BigDecimal amount, Currency currency) {}
|
|
31
|
+
|
|
32
|
+
// ✅ Methods/fields: camelCase
|
|
33
|
+
private final MarketRepository marketRepository;
|
|
34
|
+
public Market findBySlug(String slug) {}
|
|
35
|
+
|
|
36
|
+
// ✅ Constants: UPPER_SNAKE_CASE
|
|
37
|
+
private static final int MAX_PAGE_SIZE = 100;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Immutability
|
|
41
|
+
|
|
42
|
+
```java
|
|
43
|
+
// ✅ Favor records and final fields
|
|
44
|
+
public record MarketDto(Long id, String name, MarketStatus status) {}
|
|
45
|
+
|
|
46
|
+
public class Market {
|
|
47
|
+
private final Long id;
|
|
48
|
+
private final String name;
|
|
49
|
+
// getters only, no setters
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Optional Usage
|
|
54
|
+
|
|
55
|
+
```java
|
|
56
|
+
// ✅ Return Optional from find* methods
|
|
57
|
+
Optional<Market> market = marketRepository.findBySlug(slug);
|
|
58
|
+
|
|
59
|
+
// ✅ Map/flatMap instead of get()
|
|
60
|
+
return market
|
|
61
|
+
.map(MarketResponse::from)
|
|
62
|
+
.orElseThrow(() -> new EntityNotFoundException("Market not found"));
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Streams Best Practices
|
|
66
|
+
|
|
67
|
+
```java
|
|
68
|
+
// ✅ Use streams for transformations, keep pipelines short
|
|
69
|
+
List<String> names = markets.stream()
|
|
70
|
+
.map(Market::name)
|
|
71
|
+
.filter(Objects::nonNull)
|
|
72
|
+
.toList();
|
|
73
|
+
|
|
74
|
+
// ❌ Avoid complex nested streams; prefer loops for clarity
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Exceptions
|
|
78
|
+
|
|
79
|
+
- Use unchecked exceptions for domain errors; wrap technical exceptions with context
|
|
80
|
+
- Create domain-specific exceptions (e.g., `MarketNotFoundException`)
|
|
81
|
+
- Avoid broad `catch (Exception ex)` unless rethrowing/logging centrally
|
|
82
|
+
|
|
83
|
+
```java
|
|
84
|
+
throw new MarketNotFoundException(slug);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Generics and Type Safety
|
|
88
|
+
|
|
89
|
+
- Avoid raw types; declare generic parameters
|
|
90
|
+
- Prefer bounded generics for reusable utilities
|
|
91
|
+
|
|
92
|
+
```java
|
|
93
|
+
public <T extends Identifiable> Map<Long, T> indexById(Collection<T> items) { ... }
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Project Structure (Maven/Gradle)
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
src/main/java/com/example/app/
|
|
100
|
+
config/
|
|
101
|
+
controller/
|
|
102
|
+
service/
|
|
103
|
+
repository/
|
|
104
|
+
domain/
|
|
105
|
+
dto/
|
|
106
|
+
util/
|
|
107
|
+
src/main/resources/
|
|
108
|
+
application.yml
|
|
109
|
+
src/test/java/... (mirrors main)
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Formatting and Style
|
|
113
|
+
|
|
114
|
+
- Use 2 or 4 spaces consistently (project standard)
|
|
115
|
+
- One public top-level type per file
|
|
116
|
+
- Keep methods short and focused; extract helpers
|
|
117
|
+
- Order members: constants, fields, constructors, public methods, protected, private
|
|
118
|
+
|
|
119
|
+
## Code Smells to Avoid
|
|
120
|
+
|
|
121
|
+
- Long parameter lists → use DTO/builders
|
|
122
|
+
- Deep nesting → early returns
|
|
123
|
+
- Magic numbers → named constants
|
|
124
|
+
- Static mutable state → prefer dependency injection
|
|
125
|
+
- Silent catch blocks → log and act or rethrow
|
|
126
|
+
|
|
127
|
+
## Logging
|
|
128
|
+
|
|
129
|
+
```java
|
|
130
|
+
private static final Logger log = LoggerFactory.getLogger(MarketService.class);
|
|
131
|
+
log.info("fetch_market slug={}", slug);
|
|
132
|
+
log.error("failed_fetch_market slug={}", slug, ex);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Null Handling
|
|
136
|
+
|
|
137
|
+
- Accept `@Nullable` only when unavoidable; otherwise use `@NonNull`
|
|
138
|
+
- Use Bean Validation (`@NotNull`, `@NotBlank`) on inputs
|
|
139
|
+
|
|
140
|
+
## Testing Expectations
|
|
141
|
+
|
|
142
|
+
- JUnit 5 + AssertJ for fluent assertions
|
|
143
|
+
- Mockito for mocking; avoid partial mocks where possible
|
|
144
|
+
- Favor deterministic tests; no hidden sleeps
|
|
145
|
+
|
|
146
|
+
**Remember**: Keep code intentional, typed, and observable. Optimize for maintainability over micro-optimizations unless proven necessary.
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: jpa-patterns
|
|
3
|
+
description: JPA/Hibernate patterns for entity design, relationships, query optimization, transactions, auditing, indexing, pagination, and pooling in Spring Boot.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# JPA/Hibernate Patterns
|
|
7
|
+
|
|
8
|
+
Use for data modeling, repositories, and performance tuning in Spring Boot.
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
- Designing JPA entities and table mappings
|
|
13
|
+
- Defining relationships (@OneToMany, @ManyToOne, @ManyToMany)
|
|
14
|
+
- Optimizing queries (N+1 prevention, fetch strategies, projections)
|
|
15
|
+
- Configuring transactions, auditing, or soft deletes
|
|
16
|
+
- Setting up pagination, sorting, or custom repository methods
|
|
17
|
+
- Tuning connection pooling (HikariCP) or second-level caching
|
|
18
|
+
|
|
19
|
+
## Entity Design
|
|
20
|
+
|
|
21
|
+
```java
|
|
22
|
+
@Entity
|
|
23
|
+
@Table(name = "markets", indexes = {
|
|
24
|
+
@Index(name = "idx_markets_slug", columnList = "slug", unique = true)
|
|
25
|
+
})
|
|
26
|
+
@EntityListeners(AuditingEntityListener.class)
|
|
27
|
+
public class MarketEntity {
|
|
28
|
+
@Id @GeneratedValue(strategy = GenerationType.IDENTITY)
|
|
29
|
+
private Long id;
|
|
30
|
+
|
|
31
|
+
@Column(nullable = false, length = 200)
|
|
32
|
+
private String name;
|
|
33
|
+
|
|
34
|
+
@Column(nullable = false, unique = true, length = 120)
|
|
35
|
+
private String slug;
|
|
36
|
+
|
|
37
|
+
@Enumerated(EnumType.STRING)
|
|
38
|
+
private MarketStatus status = MarketStatus.ACTIVE;
|
|
39
|
+
|
|
40
|
+
@CreatedDate private Instant createdAt;
|
|
41
|
+
@LastModifiedDate private Instant updatedAt;
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Enable auditing:
|
|
46
|
+
```java
|
|
47
|
+
@Configuration
|
|
48
|
+
@EnableJpaAuditing
|
|
49
|
+
class JpaConfig {}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Relationships and N+1 Prevention
|
|
53
|
+
|
|
54
|
+
```java
|
|
55
|
+
@OneToMany(mappedBy = "market", cascade = CascadeType.ALL, orphanRemoval = true)
|
|
56
|
+
private List<PositionEntity> positions = new ArrayList<>();
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
- Default to lazy loading; use `JOIN FETCH` in queries when needed
|
|
60
|
+
- Avoid `EAGER` on collections; use DTO projections for read paths
|
|
61
|
+
|
|
62
|
+
```java
|
|
63
|
+
@Query("select m from MarketEntity m left join fetch m.positions where m.id = :id")
|
|
64
|
+
Optional<MarketEntity> findWithPositions(@Param("id") Long id);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Repository Patterns
|
|
68
|
+
|
|
69
|
+
```java
|
|
70
|
+
public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
|
|
71
|
+
Optional<MarketEntity> findBySlug(String slug);
|
|
72
|
+
|
|
73
|
+
@Query("select m from MarketEntity m where m.status = :status")
|
|
74
|
+
Page<MarketEntity> findByStatus(@Param("status") MarketStatus status, Pageable pageable);
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
- Use projections for lightweight queries:
|
|
79
|
+
```java
|
|
80
|
+
public interface MarketSummary {
|
|
81
|
+
Long getId();
|
|
82
|
+
String getName();
|
|
83
|
+
MarketStatus getStatus();
|
|
84
|
+
}
|
|
85
|
+
Page<MarketSummary> findAllBy(Pageable pageable);
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Transactions
|
|
89
|
+
|
|
90
|
+
- Annotate service methods with `@Transactional`
|
|
91
|
+
- Use `@Transactional(readOnly = true)` for read paths to optimize
|
|
92
|
+
- Choose propagation carefully; avoid long-running transactions
|
|
93
|
+
|
|
94
|
+
```java
|
|
95
|
+
@Transactional
|
|
96
|
+
public Market updateStatus(Long id, MarketStatus status) {
|
|
97
|
+
MarketEntity entity = repo.findById(id)
|
|
98
|
+
.orElseThrow(() -> new EntityNotFoundException("Market"));
|
|
99
|
+
entity.setStatus(status);
|
|
100
|
+
return Market.from(entity);
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Pagination
|
|
105
|
+
|
|
106
|
+
```java
|
|
107
|
+
PageRequest page = PageRequest.of(pageNumber, pageSize, Sort.by("createdAt").descending());
|
|
108
|
+
Page<MarketEntity> markets = repo.findByStatus(MarketStatus.ACTIVE, page);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
For cursor-like pagination, include `id > :lastId` in JPQL with ordering.
|
|
112
|
+
|
|
113
|
+
## Indexing and Performance
|
|
114
|
+
|
|
115
|
+
- Add indexes for common filters (`status`, `slug`, foreign keys)
|
|
116
|
+
- Use composite indexes matching query patterns (`status, created_at`)
|
|
117
|
+
- Avoid `select *`; project only needed columns
|
|
118
|
+
- Batch writes with `saveAll` and `hibernate.jdbc.batch_size`
|
|
119
|
+
|
|
120
|
+
## Connection Pooling (HikariCP)
|
|
121
|
+
|
|
122
|
+
Recommended properties:
|
|
123
|
+
```
|
|
124
|
+
spring.datasource.hikari.maximum-pool-size=20
|
|
125
|
+
spring.datasource.hikari.minimum-idle=5
|
|
126
|
+
spring.datasource.hikari.connection-timeout=30000
|
|
127
|
+
spring.datasource.hikari.validation-timeout=5000
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
For PostgreSQL LOB handling, add:
|
|
131
|
+
```
|
|
132
|
+
spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Caching
|
|
136
|
+
|
|
137
|
+
- 1st-level cache is per EntityManager; avoid keeping entities across transactions
|
|
138
|
+
- For read-heavy entities, consider second-level cache cautiously; validate eviction strategy
|
|
139
|
+
|
|
140
|
+
## Migrations
|
|
141
|
+
|
|
142
|
+
- Use Flyway or Liquibase; never rely on Hibernate auto DDL in production
|
|
143
|
+
- Keep migrations idempotent and additive; avoid dropping columns without plan
|
|
144
|
+
|
|
145
|
+
## Testing Data Access
|
|
146
|
+
|
|
147
|
+
- Prefer `@DataJpaTest` with Testcontainers to mirror production
|
|
148
|
+
- Assert SQL efficiency using logs: set `logging.level.org.hibernate.SQL=DEBUG` and `logging.level.org.hibernate.orm.jdbc.bind=TRACE` for parameter values
|
|
149
|
+
|
|
150
|
+
**Remember**: Keep entities lean, queries intentional, and transactions short. Prevent N+1 with fetch strategies and projections, and index for your read/write paths.
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: nutrient-document-processing
|
|
3
|
+
description: Process, convert, OCR, extract, redact, sign, and fill documents using the Nutrient DWS API. Works with PDFs, DOCX, XLSX, PPTX, HTML, and images.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Nutrient Document Processing
|
|
7
|
+
|
|
8
|
+
Process documents with the [Nutrient DWS Processor API](https://www.nutrient.io/api/). Convert formats, extract text and tables, OCR scanned documents, redact PII, add watermarks, digitally sign, and fill PDF forms.
|
|
9
|
+
|
|
10
|
+
## Setup
|
|
11
|
+
|
|
12
|
+
Get a free API key at **[nutrient.io](https://dashboard.nutrient.io/sign_up/?product=processor)**
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
export NUTRIENT_API_KEY="pdf_live_..."
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
All requests go to `https://api.nutrient.io/build` as multipart POST with an `instructions` JSON field.
|
|
19
|
+
|
|
20
|
+
## Operations
|
|
21
|
+
|
|
22
|
+
### Convert Documents
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# DOCX to PDF
|
|
26
|
+
curl -X POST https://api.nutrient.io/build \
|
|
27
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
28
|
+
-F "document.docx=@document.docx" \
|
|
29
|
+
-F 'instructions={"parts":[{"file":"document.docx"}]}' \
|
|
30
|
+
-o output.pdf
|
|
31
|
+
|
|
32
|
+
# PDF to DOCX
|
|
33
|
+
curl -X POST https://api.nutrient.io/build \
|
|
34
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
35
|
+
-F "document.pdf=@document.pdf" \
|
|
36
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"docx"}}' \
|
|
37
|
+
-o output.docx
|
|
38
|
+
|
|
39
|
+
# HTML to PDF
|
|
40
|
+
curl -X POST https://api.nutrient.io/build \
|
|
41
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
42
|
+
-F "index.html=@index.html" \
|
|
43
|
+
-F 'instructions={"parts":[{"html":"index.html"}]}' \
|
|
44
|
+
-o output.pdf
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Supported inputs: PDF, DOCX, XLSX, PPTX, DOC, XLS, PPT, PPS, PPSX, ODT, RTF, HTML, JPG, PNG, TIFF, HEIC, GIF, WebP, SVG, TGA, EPS.
|
|
48
|
+
|
|
49
|
+
### Extract Text and Data
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# Extract plain text
|
|
53
|
+
curl -X POST https://api.nutrient.io/build \
|
|
54
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
55
|
+
-F "document.pdf=@document.pdf" \
|
|
56
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"text"}}' \
|
|
57
|
+
-o output.txt
|
|
58
|
+
|
|
59
|
+
# Extract tables as Excel
|
|
60
|
+
curl -X POST https://api.nutrient.io/build \
|
|
61
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
62
|
+
-F "document.pdf=@document.pdf" \
|
|
63
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"xlsx"}}' \
|
|
64
|
+
-o tables.xlsx
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### OCR Scanned Documents
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# OCR to searchable PDF (supports 100+ languages)
|
|
71
|
+
curl -X POST https://api.nutrient.io/build \
|
|
72
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
73
|
+
-F "scanned.pdf=@scanned.pdf" \
|
|
74
|
+
-F 'instructions={"parts":[{"file":"scanned.pdf"}],"actions":[{"type":"ocr","language":"english"}]}' \
|
|
75
|
+
-o searchable.pdf
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Languages: Supports 100+ languages via ISO 639-2 codes (e.g., `eng`, `deu`, `fra`, `spa`, `jpn`, `kor`, `chi_sim`, `chi_tra`, `ara`, `hin`, `rus`). Full language names like `english` or `german` also work. See the [complete OCR language table](https://www.nutrient.io/guides/document-engine/ocr/language-support/) for all supported codes.
|
|
79
|
+
|
|
80
|
+
### Redact Sensitive Information
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
# Pattern-based (SSN, email)
|
|
84
|
+
curl -X POST https://api.nutrient.io/build \
|
|
85
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
86
|
+
-F "document.pdf=@document.pdf" \
|
|
87
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"social-security-number"}},{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"email-address"}}]}' \
|
|
88
|
+
-o redacted.pdf
|
|
89
|
+
|
|
90
|
+
# Regex-based
|
|
91
|
+
curl -X POST https://api.nutrient.io/build \
|
|
92
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
93
|
+
-F "document.pdf=@document.pdf" \
|
|
94
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"regex","strategyOptions":{"regex":"\\b[A-Z]{2}\\d{6}\\b"}}]}' \
|
|
95
|
+
-o redacted.pdf
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Presets: `social-security-number`, `email-address`, `credit-card-number`, `international-phone-number`, `north-american-phone-number`, `date`, `time`, `url`, `ipv4`, `ipv6`, `mac-address`, `us-zip-code`, `vin`.
|
|
99
|
+
|
|
100
|
+
### Add Watermarks
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X POST https://api.nutrient.io/build \
|
|
104
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
105
|
+
-F "document.pdf=@document.pdf" \
|
|
106
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"watermark","text":"CONFIDENTIAL","fontSize":72,"opacity":0.3,"rotation":-45}]}' \
|
|
107
|
+
-o watermarked.pdf
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Digital Signatures
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# Self-signed CMS signature
|
|
114
|
+
curl -X POST https://api.nutrient.io/build \
|
|
115
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
116
|
+
-F "document.pdf=@document.pdf" \
|
|
117
|
+
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"sign","signatureType":"cms"}]}' \
|
|
118
|
+
-o signed.pdf
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Fill PDF Forms
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
curl -X POST https://api.nutrient.io/build \
|
|
125
|
+
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
|
126
|
+
-F "form.pdf=@form.pdf" \
|
|
127
|
+
-F 'instructions={"parts":[{"file":"form.pdf"}],"actions":[{"type":"fillForm","formFields":{"name":"Jane Smith","email":"jane@example.com","date":"2026-02-06"}}]}' \
|
|
128
|
+
-o filled.pdf
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## MCP Server (Alternative)
|
|
132
|
+
|
|
133
|
+
For native tool integration, use the MCP server instead of curl:
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"mcpServers": {
|
|
138
|
+
"nutrient-dws": {
|
|
139
|
+
"command": "npx",
|
|
140
|
+
"args": ["-y", "@nutrient-sdk/dws-mcp-server"],
|
|
141
|
+
"env": {
|
|
142
|
+
"NUTRIENT_DWS_API_KEY": "YOUR_API_KEY",
|
|
143
|
+
"SANDBOX_PATH": "/path/to/working/directory"
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## When to Use
|
|
151
|
+
|
|
152
|
+
- Converting documents between formats (PDF, DOCX, XLSX, PPTX, HTML, images)
|
|
153
|
+
- Extracting text, tables, or key-value pairs from PDFs
|
|
154
|
+
- OCR on scanned documents or images
|
|
155
|
+
- Redacting PII before sharing documents
|
|
156
|
+
- Adding watermarks to drafts or confidential documents
|
|
157
|
+
- Digitally signing contracts or agreements
|
|
158
|
+
- Filling PDF forms programmatically
|
|
159
|
+
|
|
160
|
+
## Links
|
|
161
|
+
|
|
162
|
+
- [API Playground](https://dashboard.nutrient.io/processor-api/playground/)
|
|
163
|
+
- [Full API Docs](https://www.nutrient.io/guides/dws-processor/)
|
|
164
|
+
- [Agent Skill Repo](https://github.com/PSPDFKit-labs/nutrient-agent-skill)
|
|
165
|
+
- [npm MCP Server](https://www.npmjs.com/package/@nutrient-sdk/dws-mcp-server)
|