@ngocsangairvds/vsaf 3.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/.claude/skills/bmad-advanced-elicitation/SKILL.md +136 -0
- package/.claude/skills/bmad-advanced-elicitation/methods.csv +51 -0
- package/.claude/skills/bmad-agent-analyst/SKILL.md +59 -0
- package/.claude/skills/bmad-agent-analyst/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-agent-architect/SKILL.md +54 -0
- package/.claude/skills/bmad-agent-architect/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-agent-dev/SKILL.md +69 -0
- package/.claude/skills/bmad-agent-dev/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-agent-pm/SKILL.md +59 -0
- package/.claude/skills/bmad-agent-pm/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-agent-tech-writer/SKILL.md +57 -0
- package/.claude/skills/bmad-agent-tech-writer/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-agent-tech-writer/explain-concept.md +20 -0
- package/.claude/skills/bmad-agent-tech-writer/mermaid-gen.md +20 -0
- package/.claude/skills/bmad-agent-tech-writer/validate-doc.md +19 -0
- package/.claude/skills/bmad-agent-tech-writer/write-document.md +20 -0
- package/.claude/skills/bmad-agent-ux-designer/SKILL.md +55 -0
- package/.claude/skills/bmad-agent-ux-designer/bmad-skill-manifest.yaml +11 -0
- package/.claude/skills/bmad-brainstorming/SKILL.md +6 -0
- package/.claude/skills/bmad-brainstorming/brain-methods.csv +62 -0
- package/.claude/skills/bmad-brainstorming/steps/step-01-session-setup.md +214 -0
- package/.claude/skills/bmad-brainstorming/steps/step-01b-continue.md +124 -0
- package/.claude/skills/bmad-brainstorming/steps/step-02a-user-selected.md +229 -0
- package/.claude/skills/bmad-brainstorming/steps/step-02b-ai-recommended.md +239 -0
- package/.claude/skills/bmad-brainstorming/steps/step-02c-random-selection.md +211 -0
- package/.claude/skills/bmad-brainstorming/steps/step-02d-progressive-flow.md +266 -0
- package/.claude/skills/bmad-brainstorming/steps/step-03-technique-execution.md +401 -0
- package/.claude/skills/bmad-brainstorming/steps/step-04-idea-organization.md +305 -0
- package/.claude/skills/bmad-brainstorming/template.md +15 -0
- package/.claude/skills/bmad-brainstorming/workflow.md +53 -0
- package/.claude/skills/bmad-check-implementation-readiness/SKILL.md +6 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-01-document-discovery.md +179 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-02-prd-analysis.md +168 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-03-epic-coverage-validation.md +169 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-04-ux-alignment.md +129 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-05-epic-quality-review.md +241 -0
- package/.claude/skills/bmad-check-implementation-readiness/steps/step-06-final-assessment.md +126 -0
- package/.claude/skills/bmad-check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/.claude/skills/bmad-check-implementation-readiness/workflow.md +47 -0
- package/.claude/skills/bmad-checkpoint-preview/SKILL.md +29 -0
- package/.claude/skills/bmad-checkpoint-preview/generate-trail.md +38 -0
- package/.claude/skills/bmad-checkpoint-preview/step-01-orientation.md +105 -0
- package/.claude/skills/bmad-checkpoint-preview/step-02-walkthrough.md +89 -0
- package/.claude/skills/bmad-checkpoint-preview/step-03-detail-pass.md +106 -0
- package/.claude/skills/bmad-checkpoint-preview/step-04-testing.md +74 -0
- package/.claude/skills/bmad-checkpoint-preview/step-05-wrapup.md +24 -0
- package/.claude/skills/bmad-code-review/SKILL.md +6 -0
- package/.claude/skills/bmad-code-review/steps/step-01-gather-context.md +85 -0
- package/.claude/skills/bmad-code-review/steps/step-02-review.md +34 -0
- package/.claude/skills/bmad-code-review/steps/step-03-triage.md +49 -0
- package/.claude/skills/bmad-code-review/steps/step-04-present.md +129 -0
- package/.claude/skills/bmad-code-review/workflow.md +55 -0
- package/.claude/skills/bmad-correct-course/SKILL.md +6 -0
- package/.claude/skills/bmad-correct-course/checklist.md +288 -0
- package/.claude/skills/bmad-correct-course/workflow.md +267 -0
- package/.claude/skills/bmad-create-architecture/SKILL.md +6 -0
- package/.claude/skills/bmad-create-architecture/architecture-decision-template.md +12 -0
- package/.claude/skills/bmad-create-architecture/data/domain-complexity.csv +13 -0
- package/.claude/skills/bmad-create-architecture/data/project-types.csv +7 -0
- package/.claude/skills/bmad-create-architecture/steps/step-01-init.md +153 -0
- package/.claude/skills/bmad-create-architecture/steps/step-01b-continue.md +173 -0
- package/.claude/skills/bmad-create-architecture/steps/step-02-context.md +224 -0
- package/.claude/skills/bmad-create-architecture/steps/step-03-starter.md +329 -0
- package/.claude/skills/bmad-create-architecture/steps/step-04-decisions.md +318 -0
- package/.claude/skills/bmad-create-architecture/steps/step-05-patterns.md +359 -0
- package/.claude/skills/bmad-create-architecture/steps/step-06-structure.md +379 -0
- package/.claude/skills/bmad-create-architecture/steps/step-07-validation.md +359 -0
- package/.claude/skills/bmad-create-architecture/steps/step-08-complete.md +76 -0
- package/.claude/skills/bmad-create-architecture/workflow.md +32 -0
- package/.claude/skills/bmad-create-epics-and-stories/SKILL.md +6 -0
- package/.claude/skills/bmad-create-epics-and-stories/steps/step-01-validate-prerequisites.md +255 -0
- package/.claude/skills/bmad-create-epics-and-stories/steps/step-02-design-epics.md +212 -0
- package/.claude/skills/bmad-create-epics-and-stories/steps/step-03-create-stories.md +255 -0
- package/.claude/skills/bmad-create-epics-and-stories/steps/step-04-final-validation.md +131 -0
- package/.claude/skills/bmad-create-epics-and-stories/templates/epics-template.md +61 -0
- package/.claude/skills/bmad-create-epics-and-stories/workflow.md +51 -0
- package/.claude/skills/bmad-create-prd/SKILL.md +6 -0
- package/.claude/skills/bmad-create-prd/data/domain-complexity.csv +15 -0
- package/.claude/skills/bmad-create-prd/data/prd-purpose.md +197 -0
- package/.claude/skills/bmad-create-prd/data/project-types.csv +11 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-01-init.md +178 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-01b-continue.md +161 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-02-discovery.md +208 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-02b-vision.md +142 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-02c-executive-summary.md +158 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-03-success.md +214 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-04-journeys.md +201 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-05-domain.md +194 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-06-innovation.md +211 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-07-project-type.md +222 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-08-scoping.md +216 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-09-functional.md +219 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-10-nonfunctional.md +230 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-11-polish.md +221 -0
- package/.claude/skills/bmad-create-prd/steps-c/step-12-complete.md +115 -0
- package/.claude/skills/bmad-create-prd/templates/prd-template.md +10 -0
- package/.claude/skills/bmad-create-prd/workflow.md +61 -0
- package/.claude/skills/bmad-create-story/SKILL.md +6 -0
- package/.claude/skills/bmad-create-story/checklist.md +357 -0
- package/.claude/skills/bmad-create-story/discover-inputs.md +88 -0
- package/.claude/skills/bmad-create-story/template.md +49 -0
- package/.claude/skills/bmad-create-story/workflow.md +380 -0
- package/.claude/skills/bmad-create-ux-design/SKILL.md +6 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-01-init.md +135 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-01b-continue.md +127 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-02-discovery.md +190 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-03-core-experience.md +217 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-04-emotional-response.md +220 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-05-inspiration.md +235 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-06-design-system.md +253 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-07-defining-experience.md +255 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-08-visual-foundation.md +225 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-09-design-directions.md +225 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-10-user-journeys.md +242 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-11-component-strategy.md +249 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-12-ux-patterns.md +238 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-13-responsive-accessibility.md +265 -0
- package/.claude/skills/bmad-create-ux-design/steps/step-14-complete.md +171 -0
- package/.claude/skills/bmad-create-ux-design/ux-design-template.md +13 -0
- package/.claude/skills/bmad-create-ux-design/workflow.md +35 -0
- package/.claude/skills/bmad-dev-story/SKILL.md +6 -0
- package/.claude/skills/bmad-dev-story/checklist.md +80 -0
- package/.claude/skills/bmad-dev-story/workflow.md +450 -0
- package/.claude/skills/bmad-distillator/SKILL.md +177 -0
- package/.claude/skills/bmad-distillator/agents/distillate-compressor.md +116 -0
- package/.claude/skills/bmad-distillator/agents/round-trip-reconstructor.md +68 -0
- package/.claude/skills/bmad-distillator/resources/compression-rules.md +51 -0
- package/.claude/skills/bmad-distillator/resources/distillate-format-reference.md +227 -0
- package/.claude/skills/bmad-distillator/resources/splitting-strategy.md +78 -0
- package/.claude/skills/bmad-distillator/scripts/analyze_sources.py +300 -0
- package/.claude/skills/bmad-distillator/scripts/tests/test_analyze_sources.py +204 -0
- package/.claude/skills/bmad-document-project/SKILL.md +6 -0
- package/.claude/skills/bmad-document-project/checklist.md +245 -0
- package/.claude/skills/bmad-document-project/documentation-requirements.csv +12 -0
- package/.claude/skills/bmad-document-project/instructions.md +128 -0
- package/.claude/skills/bmad-document-project/templates/deep-dive-template.md +345 -0
- package/.claude/skills/bmad-document-project/templates/index-template.md +169 -0
- package/.claude/skills/bmad-document-project/templates/project-overview-template.md +103 -0
- package/.claude/skills/bmad-document-project/templates/project-scan-report-schema.json +160 -0
- package/.claude/skills/bmad-document-project/templates/source-tree-template.md +135 -0
- package/.claude/skills/bmad-document-project/workflow.md +25 -0
- package/.claude/skills/bmad-document-project/workflows/deep-dive-instructions.md +299 -0
- package/.claude/skills/bmad-document-project/workflows/deep-dive-workflow.md +34 -0
- package/.claude/skills/bmad-document-project/workflows/full-scan-instructions.md +1107 -0
- package/.claude/skills/bmad-document-project/workflows/full-scan-workflow.md +34 -0
- package/.claude/skills/bmad-domain-research/SKILL.md +6 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-01-init.md +137 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-02-domain-analysis.md +229 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-05-technical-trends.md +234 -0
- package/.claude/skills/bmad-domain-research/domain-steps/step-06-research-synthesis.md +444 -0
- package/.claude/skills/bmad-domain-research/research.template.md +29 -0
- package/.claude/skills/bmad-domain-research/workflow.md +51 -0
- package/.claude/skills/bmad-edit-prd/SKILL.md +6 -0
- package/.claude/skills/bmad-edit-prd/data/prd-purpose.md +197 -0
- package/.claude/skills/bmad-edit-prd/steps-e/step-e-01-discovery.md +242 -0
- package/.claude/skills/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md +204 -0
- package/.claude/skills/bmad-edit-prd/steps-e/step-e-02-review.md +245 -0
- package/.claude/skills/bmad-edit-prd/steps-e/step-e-03-edit.md +250 -0
- package/.claude/skills/bmad-edit-prd/steps-e/step-e-04-complete.md +163 -0
- package/.claude/skills/bmad-edit-prd/workflow.md +62 -0
- package/.claude/skills/bmad-editorial-review-prose/SKILL.md +86 -0
- package/.claude/skills/bmad-editorial-review-structure/SKILL.md +179 -0
- package/.claude/skills/bmad-generate-project-context/SKILL.md +6 -0
- package/.claude/skills/bmad-generate-project-context/project-context-template.md +21 -0
- package/.claude/skills/bmad-generate-project-context/steps/step-01-discover.md +186 -0
- package/.claude/skills/bmad-generate-project-context/steps/step-02-generate.md +321 -0
- package/.claude/skills/bmad-generate-project-context/steps/step-03-complete.md +278 -0
- package/.claude/skills/bmad-generate-project-context/workflow.md +39 -0
- package/.claude/skills/bmad-help/SKILL.md +75 -0
- package/.claude/skills/bmad-index-docs/SKILL.md +66 -0
- package/.claude/skills/bmad-market-research/SKILL.md +6 -0
- package/.claude/skills/bmad-market-research/research.template.md +29 -0
- package/.claude/skills/bmad-market-research/steps/step-01-init.md +184 -0
- package/.claude/skills/bmad-market-research/steps/step-02-customer-behavior.md +239 -0
- package/.claude/skills/bmad-market-research/steps/step-03-customer-pain-points.md +251 -0
- package/.claude/skills/bmad-market-research/steps/step-04-customer-decisions.md +261 -0
- package/.claude/skills/bmad-market-research/steps/step-05-competitive-analysis.md +173 -0
- package/.claude/skills/bmad-market-research/steps/step-06-research-completion.md +478 -0
- package/.claude/skills/bmad-market-research/workflow.md +51 -0
- package/.claude/skills/bmad-party-mode/SKILL.md +125 -0
- package/.claude/skills/bmad-prfaq/SKILL.md +96 -0
- package/.claude/skills/bmad-prfaq/agents/artifact-analyzer.md +60 -0
- package/.claude/skills/bmad-prfaq/agents/web-researcher.md +49 -0
- package/.claude/skills/bmad-prfaq/assets/prfaq-template.md +62 -0
- package/.claude/skills/bmad-prfaq/bmad-manifest.json +16 -0
- package/.claude/skills/bmad-prfaq/references/customer-faq.md +55 -0
- package/.claude/skills/bmad-prfaq/references/internal-faq.md +51 -0
- package/.claude/skills/bmad-prfaq/references/press-release.md +60 -0
- package/.claude/skills/bmad-prfaq/references/verdict.md +79 -0
- package/.claude/skills/bmad-product-brief/SKILL.md +82 -0
- package/.claude/skills/bmad-product-brief/agents/artifact-analyzer.md +60 -0
- package/.claude/skills/bmad-product-brief/agents/opportunity-reviewer.md +44 -0
- package/.claude/skills/bmad-product-brief/agents/skeptic-reviewer.md +44 -0
- package/.claude/skills/bmad-product-brief/agents/web-researcher.md +49 -0
- package/.claude/skills/bmad-product-brief/bmad-manifest.json +17 -0
- package/.claude/skills/bmad-product-brief/prompts/contextual-discovery.md +57 -0
- package/.claude/skills/bmad-product-brief/prompts/draft-and-review.md +86 -0
- package/.claude/skills/bmad-product-brief/prompts/finalize.md +75 -0
- package/.claude/skills/bmad-product-brief/prompts/guided-elicitation.md +70 -0
- package/.claude/skills/bmad-product-brief/resources/brief-template.md +60 -0
- package/.claude/skills/bmad-qa-generate-e2e-tests/SKILL.md +6 -0
- package/.claude/skills/bmad-qa-generate-e2e-tests/checklist.md +33 -0
- package/.claude/skills/bmad-qa-generate-e2e-tests/workflow.md +136 -0
- package/.claude/skills/bmad-quick-dev/SKILL.md +6 -0
- package/.claude/skills/bmad-quick-dev/compile-epic-context.md +62 -0
- package/.claude/skills/bmad-quick-dev/spec-template.md +88 -0
- package/.claude/skills/bmad-quick-dev/step-01-clarify-and-route.md +91 -0
- package/.claude/skills/bmad-quick-dev/step-02-plan.md +47 -0
- package/.claude/skills/bmad-quick-dev/step-03-implement.md +39 -0
- package/.claude/skills/bmad-quick-dev/step-04-review.md +49 -0
- package/.claude/skills/bmad-quick-dev/step-05-present.md +63 -0
- package/.claude/skills/bmad-quick-dev/step-oneshot.md +61 -0
- package/.claude/skills/bmad-quick-dev/workflow.md +75 -0
- package/.claude/skills/bmad-retrospective/SKILL.md +6 -0
- package/.claude/skills/bmad-retrospective/workflow.md +1479 -0
- package/.claude/skills/bmad-review-adversarial-general/SKILL.md +37 -0
- package/.claude/skills/bmad-review-edge-case-hunter/SKILL.md +67 -0
- package/.claude/skills/bmad-shard-doc/SKILL.md +105 -0
- package/.claude/skills/bmad-sprint-planning/SKILL.md +6 -0
- package/.claude/skills/bmad-sprint-planning/checklist.md +33 -0
- package/.claude/skills/bmad-sprint-planning/sprint-status-template.yaml +56 -0
- package/.claude/skills/bmad-sprint-planning/workflow.md +263 -0
- package/.claude/skills/bmad-sprint-status/SKILL.md +6 -0
- package/.claude/skills/bmad-sprint-status/workflow.md +261 -0
- package/.claude/skills/bmad-technical-research/SKILL.md +6 -0
- package/.claude/skills/bmad-technical-research/research.template.md +29 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-01-init.md +137 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-02-technical-overview.md +239 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-03-integration-patterns.md +248 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-05-implementation-research.md +233 -0
- package/.claude/skills/bmad-technical-research/technical-steps/step-06-research-synthesis.md +487 -0
- package/.claude/skills/bmad-technical-research/workflow.md +52 -0
- package/.claude/skills/bmad-validate-prd/SKILL.md +6 -0
- package/.claude/skills/bmad-validate-prd/data/domain-complexity.csv +15 -0
- package/.claude/skills/bmad-validate-prd/data/prd-purpose.md +197 -0
- package/.claude/skills/bmad-validate-prd/data/project-types.csv +11 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-01-discovery.md +221 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-02-format-detection.md +188 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-02b-parity-check.md +206 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-03-density-validation.md +171 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-04-brief-coverage-validation.md +211 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-05-measurability-validation.md +225 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-06-traceability-validation.md +214 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-07-implementation-leakage-validation.md +202 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-08-domain-compliance-validation.md +240 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-09-project-type-validation.md +260 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-10-smart-validation.md +206 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-11-holistic-quality-validation.md +261 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-12-completeness-validation.md +239 -0
- package/.claude/skills/bmad-validate-prd/steps-v/step-v-13-report-complete.md +229 -0
- package/.claude/skills/bmad-validate-prd/workflow.md +61 -0
- package/.claude/skills/gitnexus/gitnexus-cli/SKILL.md +82 -0
- package/.claude/skills/gitnexus/gitnexus-debugging/SKILL.md +89 -0
- package/.claude/skills/gitnexus/gitnexus-exploring/SKILL.md +78 -0
- package/.claude/skills/gitnexus/gitnexus-guide/SKILL.md +64 -0
- package/.claude/skills/gitnexus/gitnexus-impact-analysis/SKILL.md +97 -0
- package/.claude/skills/gitnexus/gitnexus-refactoring/SKILL.md +121 -0
- package/.claude/skills/openspec-apply-change/SKILL.md +156 -0
- package/.claude/skills/openspec-archive-change/SKILL.md +114 -0
- package/.claude/skills/openspec-explore/SKILL.md +288 -0
- package/.claude/skills/openspec-propose/SKILL.md +110 -0
- package/.claude/skills/vsaf-build/SKILL.md +52 -0
- package/.claude/skills/vsaf-doc/SKILL.md +66 -0
- package/.claude/skills/vsaf-memory-protocol.md +51 -0
- package/.claude/skills/vsaf-onboard/SKILL.md +55 -0
- package/.claude/skills/vsaf-plan/SKILL.md +68 -0
- package/.claude/skills/vsaf-ship/SKILL.md +76 -0
- package/.claude/skills/vsaf-test/SKILL.md +70 -0
- package/README.md +124 -0
- package/assets/templates/.claude/settings.json +82 -0
- package/assets/templates/CLAUDE.md +248 -0
- package/assets/templates/Makefile +77 -0
- package/assets/templates/scripts/session-end-check.sh +28 -0
- package/bin/vsaf.js +68 -0
- package/package.json +22 -0
- package/src/global.js +98 -0
- package/src/project.js +94 -0
- package/src/status.js +51 -0
- package/src/utils.js +42 -0
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
# File references (ONLY variables used in this step)
|
|
3
|
+
validationReportPath: '{validation_report_path}'
|
|
4
|
+
prdFile: '{prd_file_path}'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Step 13: Validation Report Complete
|
|
8
|
+
|
|
9
|
+
## STEP GOAL:
|
|
10
|
+
|
|
11
|
+
Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps.
|
|
12
|
+
|
|
13
|
+
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
14
|
+
|
|
15
|
+
### Universal Rules:
|
|
16
|
+
|
|
17
|
+
- 🛑 NEVER generate content without user input
|
|
18
|
+
- 📖 CRITICAL: Read the complete step file before taking any action
|
|
19
|
+
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
|
|
20
|
+
- 📋 YOU ARE A FACILITATOR, not a content generator
|
|
21
|
+
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
22
|
+
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
23
|
+
|
|
24
|
+
### Role Reinforcement:
|
|
25
|
+
|
|
26
|
+
- ✅ You are a Validation Architect and Quality Assurance Specialist
|
|
27
|
+
- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
|
|
28
|
+
- ✅ We engage in collaborative dialogue, not command-response
|
|
29
|
+
- ✅ You bring synthesis and summary expertise
|
|
30
|
+
- ✅ This is the FINAL step - requires user interaction
|
|
31
|
+
|
|
32
|
+
### Step-Specific Rules:
|
|
33
|
+
|
|
34
|
+
- 🎯 Focus ONLY on summarizing findings and presenting options
|
|
35
|
+
- 🚫 FORBIDDEN to perform additional validation
|
|
36
|
+
- 💬 Approach: Conversational summary with clear next steps
|
|
37
|
+
- 🚪 This is the final step - no next step after this
|
|
38
|
+
|
|
39
|
+
## EXECUTION PROTOCOLS:
|
|
40
|
+
|
|
41
|
+
- 🎯 Load complete validation report
|
|
42
|
+
- 🎯 Summarize all findings from steps 1-12
|
|
43
|
+
- 🎯 Update report frontmatter with final status
|
|
44
|
+
- 💬 Present summary to user conversationally
|
|
45
|
+
- 💬 Offer menu options for next actions
|
|
46
|
+
- 🚫 FORBIDDEN to proceed without user selection
|
|
47
|
+
|
|
48
|
+
## CONTEXT BOUNDARIES:
|
|
49
|
+
|
|
50
|
+
- Available context: Complete validation report with findings from all validation steps
|
|
51
|
+
- Focus: Summary and presentation only (no new validation)
|
|
52
|
+
- Limits: Don't add new findings, just synthesize existing
|
|
53
|
+
- Dependencies: Steps 1-12 completed - all validation checks done
|
|
54
|
+
|
|
55
|
+
## MANDATORY SEQUENCE
|
|
56
|
+
|
|
57
|
+
**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
|
|
58
|
+
|
|
59
|
+
### 1. Load Complete Validation Report
|
|
60
|
+
|
|
61
|
+
Read the entire validation report from {validationReportPath}
|
|
62
|
+
|
|
63
|
+
Extract all findings from:
|
|
64
|
+
- Format Detection (Step 2)
|
|
65
|
+
- Parity Analysis (Step 2B, if applicable)
|
|
66
|
+
- Information Density (Step 3)
|
|
67
|
+
- Product Brief Coverage (Step 4)
|
|
68
|
+
- Measurability (Step 5)
|
|
69
|
+
- Traceability (Step 6)
|
|
70
|
+
- Implementation Leakage (Step 7)
|
|
71
|
+
- Domain Compliance (Step 8)
|
|
72
|
+
- Project-Type Compliance (Step 9)
|
|
73
|
+
- SMART Requirements (Step 10)
|
|
74
|
+
- Holistic Quality (Step 11)
|
|
75
|
+
- Completeness (Step 12)
|
|
76
|
+
|
|
77
|
+
### 2. Update Report Frontmatter with Final Status
|
|
78
|
+
|
|
79
|
+
Update validation report frontmatter:
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
---
|
|
83
|
+
validationTarget: '{prd_path}'
|
|
84
|
+
validationDate: '{current_date}'
|
|
85
|
+
inputDocuments: [list of documents]
|
|
86
|
+
validationStepsCompleted: ['step-v-01-discovery', 'step-v-02-format-detection', 'step-v-03-density-validation', 'step-v-04-brief-coverage-validation', 'step-v-05-measurability-validation', 'step-v-06-traceability-validation', 'step-v-07-implementation-leakage-validation', 'step-v-08-domain-compliance-validation', 'step-v-09-project-type-validation', 'step-v-10-smart-validation', 'step-v-11-holistic-quality-validation', 'step-v-12-completeness-validation']
|
|
87
|
+
validationStatus: COMPLETE
|
|
88
|
+
holisticQualityRating: '{rating from step 11}'
|
|
89
|
+
overallStatus: '{Pass/Warning/Critical based on all findings}'
|
|
90
|
+
---
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 3. Create Summary of Findings
|
|
94
|
+
|
|
95
|
+
**Overall Status:**
|
|
96
|
+
- Determine from all validation findings
|
|
97
|
+
- **Pass:** All critical checks pass, minor warnings acceptable
|
|
98
|
+
- **Warning:** Some issues found but PRD is usable
|
|
99
|
+
- **Critical:** Major issues that prevent PRD from being fit for purpose
|
|
100
|
+
|
|
101
|
+
**Quick Results Table:**
|
|
102
|
+
- Format: [classification]
|
|
103
|
+
- Information Density: [severity]
|
|
104
|
+
- Measurability: [severity]
|
|
105
|
+
- Traceability: [severity]
|
|
106
|
+
- Implementation Leakage: [severity]
|
|
107
|
+
- Domain Compliance: [status]
|
|
108
|
+
- Project-Type Compliance: [compliance score]
|
|
109
|
+
- SMART Quality: [percentage]
|
|
110
|
+
- Holistic Quality: [rating/5]
|
|
111
|
+
- Completeness: [percentage]
|
|
112
|
+
|
|
113
|
+
**Critical Issues:** List from all validation steps
|
|
114
|
+
**Warnings:** List from all validation steps
|
|
115
|
+
**Strengths:** List positives from all validation steps
|
|
116
|
+
|
|
117
|
+
**Holistic Quality Rating:** From step 11
|
|
118
|
+
**Top 3 Improvements:** From step 11
|
|
119
|
+
|
|
120
|
+
**Recommendation:** Based on overall status
|
|
121
|
+
|
|
122
|
+
### 4. Present Summary to User Conversationally
|
|
123
|
+
|
|
124
|
+
Display:
|
|
125
|
+
|
|
126
|
+
"**✓ PRD Validation Complete**
|
|
127
|
+
|
|
128
|
+
**Overall Status:** {Pass/Warning/Critical}
|
|
129
|
+
|
|
130
|
+
**Quick Results:**
|
|
131
|
+
{Present quick results table with key findings}
|
|
132
|
+
|
|
133
|
+
**Critical Issues:** {count or "None"}
|
|
134
|
+
{If any, list briefly}
|
|
135
|
+
|
|
136
|
+
**Warnings:** {count or "None"}
|
|
137
|
+
{If any, list briefly}
|
|
138
|
+
|
|
139
|
+
**Strengths:**
|
|
140
|
+
{List key strengths}
|
|
141
|
+
|
|
142
|
+
**Holistic Quality:** {rating}/5 - {label}
|
|
143
|
+
|
|
144
|
+
**Top 3 Improvements:**
|
|
145
|
+
1. {Improvement 1}
|
|
146
|
+
2. {Improvement 2}
|
|
147
|
+
3. {Improvement 3}
|
|
148
|
+
|
|
149
|
+
**Recommendation:**
|
|
150
|
+
{Based on overall status:
|
|
151
|
+
- Pass: "PRD is in good shape. Address minor improvements to make it great."
|
|
152
|
+
- Warning: "PRD is usable but has issues that should be addressed. Review warnings and improve where needed."
|
|
153
|
+
- Critical: "PRD has significant issues that should be fixed before use. Focus on critical issues above."}
|
|
154
|
+
|
|
155
|
+
**What would you like to do next?**"
|
|
156
|
+
|
|
157
|
+
### 5. Present MENU OPTIONS
|
|
158
|
+
|
|
159
|
+
Display:
|
|
160
|
+
|
|
161
|
+
**[R] Review Detailed Findings** - Walk through validation report section by section
|
|
162
|
+
**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements
|
|
163
|
+
**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers)
|
|
164
|
+
**[X] Exit** - Exit and Suggest Next Steps.
|
|
165
|
+
|
|
166
|
+
#### EXECUTION RULES:
|
|
167
|
+
|
|
168
|
+
- ALWAYS halt and wait for user input after presenting menu
|
|
169
|
+
- Only proceed based on user selection
|
|
170
|
+
|
|
171
|
+
#### Menu Handling Logic:
|
|
172
|
+
|
|
173
|
+
- **IF R (Review Detailed Findings):**
|
|
174
|
+
- Walk through validation report section by section
|
|
175
|
+
- Present findings from each validation step
|
|
176
|
+
- Allow user to ask questions
|
|
177
|
+
- After review, return to menu
|
|
178
|
+
|
|
179
|
+
- **IF E (Use Edit Workflow):**
|
|
180
|
+
- Explain: "The Edit workflow can use this validation report to systematically address issues. Edit mode will guide you through discovering what to edit, reviewing the PRD, and applying targeted improvements."
|
|
181
|
+
- Offer: "Would you like to launch Edit mode now? It will help you fix validation findings systematically."
|
|
182
|
+
- If yes: Invoke the `bmad-edit-prd` skill, passing the validation report path as context
|
|
183
|
+
- If no: Return to menu
|
|
184
|
+
|
|
185
|
+
- **IF F (Fix Simpler Items):**
|
|
186
|
+
- Offer immediate fixes for:
|
|
187
|
+
- Template variables (fill in with appropriate content)
|
|
188
|
+
- Conversational filler (remove wordy phrases)
|
|
189
|
+
- Implementation leakage (remove technology names from FRs/NFRs)
|
|
190
|
+
- Missing section headers (add ## headers)
|
|
191
|
+
- Ask: "Which simple fixes would you like me to make?"
|
|
192
|
+
- If user specifies fixes, make them and update validation report
|
|
193
|
+
- Return to menu
|
|
194
|
+
|
|
195
|
+
- **IF X (Exit):**
|
|
196
|
+
- Display: "**Validation Report Saved:** {validationReportPath}"
|
|
197
|
+
- Display: "**Summary:** {overall status} - {recommendation}"
|
|
198
|
+
- PRD Validation complete. Invoke the `bmad-help` skill.
|
|
199
|
+
|
|
200
|
+
- **IF Any other:** Help user, then redisplay menu
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
|
205
|
+
|
|
206
|
+
### ✅ SUCCESS:
|
|
207
|
+
|
|
208
|
+
- Complete validation report loaded successfully
|
|
209
|
+
- All findings from steps 1-12 summarized
|
|
210
|
+
- Report frontmatter updated with final status
|
|
211
|
+
- Overall status determined correctly (Pass/Warning/Critical)
|
|
212
|
+
- Quick results table presented
|
|
213
|
+
- Critical issues, warnings, and strengths listed
|
|
214
|
+
- Holistic quality rating included
|
|
215
|
+
- Top 3 improvements presented
|
|
216
|
+
- Clear recommendation provided
|
|
217
|
+
- Menu options presented with clear explanations
|
|
218
|
+
- User can review findings, get help, or exit
|
|
219
|
+
|
|
220
|
+
### ❌ SYSTEM FAILURE:
|
|
221
|
+
|
|
222
|
+
- Not loading complete validation report
|
|
223
|
+
- Missing summary of findings
|
|
224
|
+
- Not updating report frontmatter
|
|
225
|
+
- Not determining overall status
|
|
226
|
+
- Missing menu options
|
|
227
|
+
- Unclear next steps
|
|
228
|
+
|
|
229
|
+
**Master Rule:** User needs clear summary and actionable next steps. Edit workflow is best for complex issues; immediate fixes available for simpler ones.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
|
3
|
+
validateWorkflow: './steps-v/step-v-01-discovery.md'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# PRD Validate Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Validate existing PRDs against BMAD standards through comprehensive review.
|
|
9
|
+
|
|
10
|
+
**Your Role:** Validation Architect and Quality Assurance Specialist.
|
|
11
|
+
|
|
12
|
+
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
13
|
+
|
|
14
|
+
## WORKFLOW ARCHITECTURE
|
|
15
|
+
|
|
16
|
+
This uses **step-file architecture** for disciplined execution:
|
|
17
|
+
|
|
18
|
+
### Core Principles
|
|
19
|
+
|
|
20
|
+
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
21
|
+
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
22
|
+
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
23
|
+
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
24
|
+
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
25
|
+
|
|
26
|
+
### Step Processing Rules
|
|
27
|
+
|
|
28
|
+
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
29
|
+
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
30
|
+
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
31
|
+
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
32
|
+
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
33
|
+
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
34
|
+
|
|
35
|
+
### Critical Rules (NO EXCEPTIONS)
|
|
36
|
+
|
|
37
|
+
- 🛑 **NEVER** load multiple step files simultaneously
|
|
38
|
+
- 📖 **ALWAYS** read entire step file before execution
|
|
39
|
+
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
40
|
+
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
41
|
+
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
42
|
+
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
43
|
+
- 📋 **NEVER** create mental todo lists from future steps
|
|
44
|
+
|
|
45
|
+
## Activation
|
|
46
|
+
|
|
47
|
+
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
48
|
+
- Use `{user_name}` for greeting
|
|
49
|
+
- Use `{communication_language}` for all communications
|
|
50
|
+
- Use `{document_output_language}` for output documents
|
|
51
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
52
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
53
|
+
|
|
54
|
+
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
55
|
+
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
|
56
|
+
|
|
57
|
+
2. Route to Validate Workflow
|
|
58
|
+
|
|
59
|
+
"**Validate Mode: Validating an existing PRD against BMAD standards.**"
|
|
60
|
+
|
|
61
|
+
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-cli
|
|
3
|
+
description: "Use when the user needs to run GitNexus CLI commands like analyze/index a repo, check status, clean the index, generate a wiki, or list indexed repos. Examples: \"Index this repo\", \"Reanalyze the codebase\", \"Generate a wiki\""
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# GitNexus CLI Commands
|
|
7
|
+
|
|
8
|
+
All commands work via `npx` — no global install required.
|
|
9
|
+
|
|
10
|
+
## Commands
|
|
11
|
+
|
|
12
|
+
### analyze — Build or refresh the index
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx gitnexus analyze
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Run from the project root. This parses all source files, builds the knowledge graph, writes it to `.gitnexus/`, and generates CLAUDE.md / AGENTS.md context files.
|
|
19
|
+
|
|
20
|
+
| Flag | Effect |
|
|
21
|
+
| -------------- | ---------------------------------------------------------------- |
|
|
22
|
+
| `--force` | Force full re-index even if up to date |
|
|
23
|
+
| `--embeddings` | Enable embedding generation for semantic search (off by default) |
|
|
24
|
+
|
|
25
|
+
**When to run:** First time in a project, after major code changes, or when `gitnexus://repo/{name}/context` reports the index is stale. In Claude Code, a PostToolUse hook runs `analyze` automatically after `git commit` and `git merge`, preserving embeddings if previously generated.
|
|
26
|
+
|
|
27
|
+
### status — Check index freshness
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npx gitnexus status
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Shows whether the current repo has a GitNexus index, when it was last updated, and symbol/relationship counts. Use this to check if re-indexing is needed.
|
|
34
|
+
|
|
35
|
+
### clean — Delete the index
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx gitnexus clean
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Deletes the `.gitnexus/` directory and unregisters the repo from the global registry. Use before re-indexing if the index is corrupt or after removing GitNexus from a project.
|
|
42
|
+
|
|
43
|
+
| Flag | Effect |
|
|
44
|
+
| --------- | ------------------------------------------------- |
|
|
45
|
+
| `--force` | Skip confirmation prompt |
|
|
46
|
+
| `--all` | Clean all indexed repos, not just the current one |
|
|
47
|
+
|
|
48
|
+
### wiki — Generate documentation from the graph
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npx gitnexus wiki
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Generates repository documentation from the knowledge graph using an LLM. Requires an API key (saved to `~/.gitnexus/config.json` on first use).
|
|
55
|
+
|
|
56
|
+
| Flag | Effect |
|
|
57
|
+
| ------------------- | ----------------------------------------- |
|
|
58
|
+
| `--force` | Force full regeneration |
|
|
59
|
+
| `--model <model>` | LLM model (default: minimax/minimax-m2.5) |
|
|
60
|
+
| `--base-url <url>` | LLM API base URL |
|
|
61
|
+
| `--api-key <key>` | LLM API key |
|
|
62
|
+
| `--concurrency <n>` | Parallel LLM calls (default: 3) |
|
|
63
|
+
| `--gist` | Publish wiki as a public GitHub Gist |
|
|
64
|
+
|
|
65
|
+
### list — Show all indexed repos
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npx gitnexus list
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Lists all repositories registered in `~/.gitnexus/registry.json`. The MCP `list_repos` tool provides the same information.
|
|
72
|
+
|
|
73
|
+
## After Indexing
|
|
74
|
+
|
|
75
|
+
1. **Read `gitnexus://repo/{name}/context`** to verify the index loaded
|
|
76
|
+
2. Use the other GitNexus skills (`exploring`, `debugging`, `impact-analysis`, `refactoring`) for your task
|
|
77
|
+
|
|
78
|
+
## Troubleshooting
|
|
79
|
+
|
|
80
|
+
- **"Not inside a git repository"**: Run from a directory inside a git repo
|
|
81
|
+
- **Index is stale after re-analyzing**: Restart Claude Code to reload the MCP server
|
|
82
|
+
- **Embeddings slow**: Omit `--embeddings` (it's off by default) or set `OPENAI_API_KEY` for faster API-based embedding
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-debugging
|
|
3
|
+
description: "Use when the user is debugging a bug, tracing an error, or asking why something fails. Examples: \"Why is X failing?\", \"Where does this error come from?\", \"Trace this bug\""
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Debugging with GitNexus
|
|
7
|
+
|
|
8
|
+
## When to Use
|
|
9
|
+
|
|
10
|
+
- "Why is this function failing?"
|
|
11
|
+
- "Trace where this error comes from"
|
|
12
|
+
- "Who calls this method?"
|
|
13
|
+
- "This endpoint returns 500"
|
|
14
|
+
- Investigating bugs, errors, or unexpected behavior
|
|
15
|
+
|
|
16
|
+
## Workflow
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
1. gitnexus_query({query: "<error or symptom>"}) → Find related execution flows
|
|
20
|
+
2. gitnexus_context({name: "<suspect>"}) → See callers/callees/processes
|
|
21
|
+
3. READ gitnexus://repo/{name}/process/{name} → Trace execution flow
|
|
22
|
+
4. gitnexus_cypher({query: "MATCH path..."}) → Custom traces if needed
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
> If "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
26
|
+
|
|
27
|
+
## Checklist
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
- [ ] Understand the symptom (error message, unexpected behavior)
|
|
31
|
+
- [ ] gitnexus_query for error text or related code
|
|
32
|
+
- [ ] Identify the suspect function from returned processes
|
|
33
|
+
- [ ] gitnexus_context to see callers and callees
|
|
34
|
+
- [ ] Trace execution flow via process resource if applicable
|
|
35
|
+
- [ ] gitnexus_cypher for custom call chain traces if needed
|
|
36
|
+
- [ ] Read source files to confirm root cause
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Debugging Patterns
|
|
40
|
+
|
|
41
|
+
| Symptom | GitNexus Approach |
|
|
42
|
+
| -------------------- | ---------------------------------------------------------- |
|
|
43
|
+
| Error message | `gitnexus_query` for error text → `context` on throw sites |
|
|
44
|
+
| Wrong return value | `context` on the function → trace callees for data flow |
|
|
45
|
+
| Intermittent failure | `context` → look for external calls, async deps |
|
|
46
|
+
| Performance issue | `context` → find symbols with many callers (hot paths) |
|
|
47
|
+
| Recent regression | `detect_changes` to see what your changes affect |
|
|
48
|
+
|
|
49
|
+
## Tools
|
|
50
|
+
|
|
51
|
+
**gitnexus_query** — find code related to error:
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
gitnexus_query({query: "payment validation error"})
|
|
55
|
+
→ Processes: CheckoutFlow, ErrorHandling
|
|
56
|
+
→ Symbols: validatePayment, handlePaymentError, PaymentException
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**gitnexus_context** — full context for a suspect:
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
gitnexus_context({name: "validatePayment"})
|
|
63
|
+
→ Incoming calls: processCheckout, webhookHandler
|
|
64
|
+
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
65
|
+
→ Processes: CheckoutFlow (step 3/7)
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**gitnexus_cypher** — custom call chain traces:
|
|
69
|
+
|
|
70
|
+
```cypher
|
|
71
|
+
MATCH path = (a)-[:CodeRelation {type: 'CALLS'}*1..2]->(b:Function {name: "validatePayment"})
|
|
72
|
+
RETURN [n IN nodes(path) | n.name] AS chain
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Example: "Payment endpoint returns 500 intermittently"
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
1. gitnexus_query({query: "payment error handling"})
|
|
79
|
+
→ Processes: CheckoutFlow, ErrorHandling
|
|
80
|
+
→ Symbols: validatePayment, handlePaymentError
|
|
81
|
+
|
|
82
|
+
2. gitnexus_context({name: "validatePayment"})
|
|
83
|
+
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
84
|
+
|
|
85
|
+
3. READ gitnexus://repo/my-app/process/CheckoutFlow
|
|
86
|
+
→ Step 3: validatePayment → calls fetchRates (external)
|
|
87
|
+
|
|
88
|
+
4. Root cause: fetchRates calls external API without proper timeout
|
|
89
|
+
```
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-exploring
|
|
3
|
+
description: "Use when the user asks how code works, wants to understand architecture, trace execution flows, or explore unfamiliar parts of the codebase. Examples: \"How does X work?\", \"What calls this function?\", \"Show me the auth flow\""
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Exploring Codebases with GitNexus
|
|
7
|
+
|
|
8
|
+
## When to Use
|
|
9
|
+
|
|
10
|
+
- "How does authentication work?"
|
|
11
|
+
- "What's the project structure?"
|
|
12
|
+
- "Show me the main components"
|
|
13
|
+
- "Where is the database logic?"
|
|
14
|
+
- Understanding code you haven't seen before
|
|
15
|
+
|
|
16
|
+
## Workflow
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
1. READ gitnexus://repos → Discover indexed repos
|
|
20
|
+
2. READ gitnexus://repo/{name}/context → Codebase overview, check staleness
|
|
21
|
+
3. gitnexus_query({query: "<what you want to understand>"}) → Find related execution flows
|
|
22
|
+
4. gitnexus_context({name: "<symbol>"}) → Deep dive on specific symbol
|
|
23
|
+
5. READ gitnexus://repo/{name}/process/{name} → Trace full execution flow
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
> If step 2 says "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
27
|
+
|
|
28
|
+
## Checklist
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
- [ ] READ gitnexus://repo/{name}/context
|
|
32
|
+
- [ ] gitnexus_query for the concept you want to understand
|
|
33
|
+
- [ ] Review returned processes (execution flows)
|
|
34
|
+
- [ ] gitnexus_context on key symbols for callers/callees
|
|
35
|
+
- [ ] READ process resource for full execution traces
|
|
36
|
+
- [ ] Read source files for implementation details
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Resources
|
|
40
|
+
|
|
41
|
+
| Resource | What you get |
|
|
42
|
+
| --------------------------------------- | ------------------------------------------------------- |
|
|
43
|
+
| `gitnexus://repo/{name}/context` | Stats, staleness warning (~150 tokens) |
|
|
44
|
+
| `gitnexus://repo/{name}/clusters` | All functional areas with cohesion scores (~300 tokens) |
|
|
45
|
+
| `gitnexus://repo/{name}/cluster/{name}` | Area members with file paths (~500 tokens) |
|
|
46
|
+
| `gitnexus://repo/{name}/process/{name}` | Step-by-step execution trace (~200 tokens) |
|
|
47
|
+
|
|
48
|
+
## Tools
|
|
49
|
+
|
|
50
|
+
**gitnexus_query** — find execution flows related to a concept:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
gitnexus_query({query: "payment processing"})
|
|
54
|
+
→ Processes: CheckoutFlow, RefundFlow, WebhookHandler
|
|
55
|
+
→ Symbols grouped by flow with file locations
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**gitnexus_context** — 360-degree view of a symbol:
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
gitnexus_context({name: "validateUser"})
|
|
62
|
+
→ Incoming calls: loginHandler, apiMiddleware
|
|
63
|
+
→ Outgoing calls: checkToken, getUserById
|
|
64
|
+
→ Processes: LoginFlow (step 2/5), TokenRefresh (step 1/3)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Example: "How does payment processing work?"
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
1. READ gitnexus://repo/my-app/context → 918 symbols, 45 processes
|
|
71
|
+
2. gitnexus_query({query: "payment processing"})
|
|
72
|
+
→ CheckoutFlow: processPayment → validateCard → chargeStripe
|
|
73
|
+
→ RefundFlow: initiateRefund → calculateRefund → processRefund
|
|
74
|
+
3. gitnexus_context({name: "processPayment"})
|
|
75
|
+
→ Incoming: checkoutHandler, webhookHandler
|
|
76
|
+
→ Outgoing: validateCard, chargeStripe, saveTransaction
|
|
77
|
+
4. Read src/payments/processor.ts for implementation details
|
|
78
|
+
```
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-guide
|
|
3
|
+
description: "Use when the user asks about GitNexus itself — available tools, how to query the knowledge graph, MCP resources, graph schema, or workflow reference. Examples: \"What GitNexus tools are available?\", \"How do I use GitNexus?\""
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# GitNexus Guide
|
|
7
|
+
|
|
8
|
+
Quick reference for all GitNexus MCP tools, resources, and the knowledge graph schema.
|
|
9
|
+
|
|
10
|
+
## Always Start Here
|
|
11
|
+
|
|
12
|
+
For any task involving code understanding, debugging, impact analysis, or refactoring:
|
|
13
|
+
|
|
14
|
+
1. **Read `gitnexus://repo/{name}/context`** — codebase overview + check index freshness
|
|
15
|
+
2. **Match your task to a skill below** and **read that skill file**
|
|
16
|
+
3. **Follow the skill's workflow and checklist**
|
|
17
|
+
|
|
18
|
+
> If step 1 warns the index is stale, run `npx gitnexus analyze` in the terminal first.
|
|
19
|
+
|
|
20
|
+
## Skills
|
|
21
|
+
|
|
22
|
+
| Task | Skill to read |
|
|
23
|
+
| -------------------------------------------- | ------------------- |
|
|
24
|
+
| Understand architecture / "How does X work?" | `gitnexus-exploring` |
|
|
25
|
+
| Blast radius / "What breaks if I change X?" | `gitnexus-impact-analysis` |
|
|
26
|
+
| Trace bugs / "Why is X failing?" | `gitnexus-debugging` |
|
|
27
|
+
| Rename / extract / split / refactor | `gitnexus-refactoring` |
|
|
28
|
+
| Tools, resources, schema reference | `gitnexus-guide` (this file) |
|
|
29
|
+
| Index, status, clean, wiki CLI commands | `gitnexus-cli` |
|
|
30
|
+
|
|
31
|
+
## Tools Reference
|
|
32
|
+
|
|
33
|
+
| Tool | What it gives you |
|
|
34
|
+
| ---------------- | ------------------------------------------------------------------------ |
|
|
35
|
+
| `query` | Process-grouped code intelligence — execution flows related to a concept |
|
|
36
|
+
| `context` | 360-degree symbol view — categorized refs, processes it participates in |
|
|
37
|
+
| `impact` | Symbol blast radius — what breaks at depth 1/2/3 with confidence |
|
|
38
|
+
| `detect_changes` | Git-diff impact — what do your current changes affect |
|
|
39
|
+
| `rename` | Multi-file coordinated rename with confidence-tagged edits |
|
|
40
|
+
| `cypher` | Raw graph queries (read `gitnexus://repo/{name}/schema` first) |
|
|
41
|
+
| `list_repos` | Discover indexed repos |
|
|
42
|
+
|
|
43
|
+
## Resources Reference
|
|
44
|
+
|
|
45
|
+
Lightweight reads (~100-500 tokens) for navigation:
|
|
46
|
+
|
|
47
|
+
| Resource | Content |
|
|
48
|
+
| ---------------------------------------------- | ----------------------------------------- |
|
|
49
|
+
| `gitnexus://repo/{name}/context` | Stats, staleness check |
|
|
50
|
+
| `gitnexus://repo/{name}/clusters` | All functional areas with cohesion scores |
|
|
51
|
+
| `gitnexus://repo/{name}/cluster/{clusterName}` | Area members |
|
|
52
|
+
| `gitnexus://repo/{name}/processes` | All execution flows |
|
|
53
|
+
| `gitnexus://repo/{name}/process/{processName}` | Step-by-step trace |
|
|
54
|
+
| `gitnexus://repo/{name}/schema` | Graph schema for Cypher |
|
|
55
|
+
|
|
56
|
+
## Graph Schema
|
|
57
|
+
|
|
58
|
+
**Nodes:** File, Function, Class, Interface, Method, Community, Process
|
|
59
|
+
**Edges (via CodeRelation.type):** CALLS, IMPORTS, EXTENDS, IMPLEMENTS, DEFINES, MEMBER_OF, STEP_IN_PROCESS
|
|
60
|
+
|
|
61
|
+
```cypher
|
|
62
|
+
MATCH (caller)-[:CodeRelation {type: 'CALLS'}]->(f:Function {name: "myFunc"})
|
|
63
|
+
RETURN caller.name, caller.filePath
|
|
64
|
+
```
|