contextos-agents 1.5.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/.agents/AGENTS.md +421 -0
- package/.agents/adapters/aider/export.js +137 -0
- package/.agents/adapters/claude/export.js +55 -0
- package/.agents/adapters/copilot/export.js +107 -0
- package/.agents/adapters/cursor/export.js +210 -0
- package/.agents/adapters/gemini/export.js +115 -0
- package/.agents/adapters/shared.js +119 -0
- package/.agents/adapters/zed/export.js +111 -0
- package/.agents/core/profiles/backend.yaml +47 -0
- package/.agents/core/profiles/enterprise.yaml +46 -0
- package/.agents/core/profiles/frontend.yaml +46 -0
- package/.agents/core/profiles/hackathon.yaml +45 -0
- package/.agents/core/profiles/mvp.yaml +43 -0
- package/.agents/core/profiles/startup.yaml +48 -0
- package/.agents/core/skills/adapters/EXAMPLES.md +19 -0
- package/.agents/core/skills/adapters/SKILL.md +105 -0
- package/.agents/core/skills/adapters/TROUBLESHOOTING.md +7 -0
- package/.agents/core/skills/adapters/VALIDATION.json +12 -0
- package/.agents/core/skills/adapters/skill.yaml +10 -0
- package/.agents/core/skills/architecture-diagrams/SKILL.md +108 -0
- package/.agents/core/skills/architecture-diagrams/VALIDATION.json +12 -0
- package/.agents/core/skills/architecture-diagrams/skill.yaml +8 -0
- package/.agents/core/skills/brutalist-design/SKILL.md +150 -0
- package/.agents/core/skills/brutalist-design/VALIDATION.json +12 -0
- package/.agents/core/skills/brutalist-design/skill.yaml +8 -0
- package/.agents/core/skills/context-manager/EXAMPLES.md +19 -0
- package/.agents/core/skills/context-manager/SKILL.md +126 -0
- package/.agents/core/skills/context-manager/TROUBLESHOOTING.md +7 -0
- package/.agents/core/skills/context-manager/VALIDATION.json +12 -0
- package/.agents/core/skills/context-manager/skill.yaml +10 -0
- package/.agents/core/skills/context-os/EXAMPLES.md +21 -0
- package/.agents/core/skills/context-os/SKILL.md +169 -0
- package/.agents/core/skills/context-os/TROUBLESHOOTING.md +7 -0
- package/.agents/core/skills/context-os/VALIDATION.json +12 -0
- package/.agents/core/skills/context-os/packs.yaml +59 -0
- package/.agents/core/skills/context-os/references/context-rules.md +68 -0
- package/.agents/core/skills/context-os/references/pipeline.md +119 -0
- package/.agents/core/skills/context-os/references/project-graph.md +103 -0
- package/.agents/core/skills/context-os/rules.yaml +135 -0
- package/.agents/core/skills/context-os/skill.yaml +10 -0
- package/.agents/core/skills/database/EXAMPLES.md +74 -0
- package/.agents/core/skills/database/SKILL.md +101 -0
- package/.agents/core/skills/database/TROUBLESHOOTING.md +18 -0
- package/.agents/core/skills/database/VALIDATION.json +11 -0
- package/.agents/core/skills/database/skill.yaml +25 -0
- package/.agents/core/skills/ddd/EXAMPLES.md +42 -0
- package/.agents/core/skills/ddd/SKILL.md +247 -0
- package/.agents/core/skills/ddd/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/ddd/VALIDATION.json +12 -0
- package/.agents/core/skills/ddd/ddd.md +178 -0
- package/.agents/core/skills/ddd/skill.yaml +10 -0
- package/.agents/core/skills/decisions/EXAMPLES.md +35 -0
- package/.agents/core/skills/decisions/SKILL.md +90 -0
- package/.agents/core/skills/decisions/TROUBLESHOOTING.md +13 -0
- package/.agents/core/skills/decisions/VALIDATION.json +12 -0
- package/.agents/core/skills/decisions/skill.yaml +10 -0
- package/.agents/core/skills/docker/EXAMPLES.md +56 -0
- package/.agents/core/skills/docker/SKILL.md +63 -0
- package/.agents/core/skills/docker/TROUBLESHOOTING.md +18 -0
- package/.agents/core/skills/docker/VALIDATION.json +11 -0
- package/.agents/core/skills/docker/skill.yaml +23 -0
- package/.agents/core/skills/engineering-workflow/EXAMPLES.md +57 -0
- package/.agents/core/skills/engineering-workflow/SKILL.md +343 -0
- package/.agents/core/skills/engineering-workflow/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/engineering-workflow/VALIDATION.json +12 -0
- package/.agents/core/skills/engineering-workflow/skill.yaml +13 -0
- package/.agents/core/skills/fastapi/EXAMPLES.md +36 -0
- package/.agents/core/skills/fastapi/SKILL.md +148 -0
- package/.agents/core/skills/fastapi/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/fastapi/VALIDATION.json +12 -0
- package/.agents/core/skills/fastapi/fastapi.md +112 -0
- package/.agents/core/skills/fastapi/skill.yaml +10 -0
- package/.agents/core/skills/gemini-precision/SKILL.md +169 -0
- package/.agents/core/skills/gemini-precision/VALIDATION.json +12 -0
- package/.agents/core/skills/gemini-precision/skill.yaml +9 -0
- package/.agents/core/skills/generators/EXAMPLES.md +19 -0
- package/.agents/core/skills/generators/SKILL.md +112 -0
- package/.agents/core/skills/generators/TROUBLESHOOTING.md +7 -0
- package/.agents/core/skills/generators/VALIDATION.json +12 -0
- package/.agents/core/skills/generators/skill.yaml +10 -0
- package/.agents/core/skills/generators/templates/API.md +77 -0
- package/.agents/core/skills/generators/templates/ARCHITECTURE.md +70 -0
- package/.agents/core/skills/generators/templates/DATABASE.md +42 -0
- package/.agents/core/skills/generators/templates/DECISION.md +46 -0
- package/.agents/core/skills/generators/templates/PRD.md +67 -0
- package/.agents/core/skills/generators/templates/PROJECT_GRAPH.md +56 -0
- package/.agents/core/skills/generators/templates/ROADMAP.md +51 -0
- package/.agents/core/skills/generators/templates/TASKS.md +43 -0
- package/.agents/core/skills/generators/templates/UI.md +73 -0
- package/.agents/core/skills/graphify/EXAMPLES.md +73 -0
- package/.agents/core/skills/graphify/SKILL.md +130 -0
- package/.agents/core/skills/graphify/VALIDATION.json +12 -0
- package/.agents/core/skills/graphify/skill.yaml +13 -0
- package/.agents/core/skills/gstack-roles/EXAMPLES.md +23 -0
- package/.agents/core/skills/gstack-roles/SKILL.md +152 -0
- package/.agents/core/skills/gstack-roles/TROUBLESHOOTING.md +13 -0
- package/.agents/core/skills/gstack-roles/VALIDATION.json +12 -0
- package/.agents/core/skills/gstack-roles/skill.yaml +12 -0
- package/.agents/core/skills/impeccable-design/EXAMPLES.md +26 -0
- package/.agents/core/skills/impeccable-design/SKILL.md +201 -0
- package/.agents/core/skills/impeccable-design/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/impeccable-design/VALIDATION.json +12 -0
- package/.agents/core/skills/impeccable-design/skill.yaml +14 -0
- package/.agents/core/skills/interview-me/SKILL.md +97 -0
- package/.agents/core/skills/interview-me/VALIDATION.json +12 -0
- package/.agents/core/skills/interview-me/skill.yaml +8 -0
- package/.agents/core/skills/microservices/EXAMPLES.md +38 -0
- package/.agents/core/skills/microservices/SKILL.md +164 -0
- package/.agents/core/skills/microservices/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/microservices/VALIDATION.json +12 -0
- package/.agents/core/skills/microservices/microservices.md +119 -0
- package/.agents/core/skills/microservices/skill.yaml +10 -0
- package/.agents/core/skills/minimalist-design/SKILL.md +113 -0
- package/.agents/core/skills/minimalist-design/VALIDATION.json +12 -0
- package/.agents/core/skills/minimalist-design/skill.yaml +8 -0
- package/.agents/core/skills/nestjs/EXAMPLES.md +40 -0
- package/.agents/core/skills/nestjs/SKILL.md +139 -0
- package/.agents/core/skills/nestjs/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/nestjs/VALIDATION.json +12 -0
- package/.agents/core/skills/nestjs/nestjs.md +103 -0
- package/.agents/core/skills/nestjs/skill.yaml +10 -0
- package/.agents/core/skills/nextjs/EXAMPLES.md +40 -0
- package/.agents/core/skills/nextjs/SKILL.md +163 -0
- package/.agents/core/skills/nextjs/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/nextjs/VALIDATION.json +12 -0
- package/.agents/core/skills/nextjs/nextjs.md +67 -0
- package/.agents/core/skills/nextjs/skill.yaml +10 -0
- package/.agents/core/skills/node/EXAMPLES.md +80 -0
- package/.agents/core/skills/node/SKILL.md +128 -0
- package/.agents/core/skills/node/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/node/VALIDATION.json +12 -0
- package/.agents/core/skills/node/node.md +87 -0
- package/.agents/core/skills/node/skill.yaml +10 -0
- package/.agents/core/skills/performance/EXAMPLES.md +30 -0
- package/.agents/core/skills/performance/SKILL.md +75 -0
- package/.agents/core/skills/performance/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/performance/VALIDATION.json +12 -0
- package/.agents/core/skills/performance/performance.md +52 -0
- package/.agents/core/skills/performance/skill.yaml +10 -0
- package/.agents/core/skills/ponytail-mindset/EXAMPLES.md +45 -0
- package/.agents/core/skills/ponytail-mindset/SKILL.md +193 -0
- package/.agents/core/skills/ponytail-mindset/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/ponytail-mindset/VALIDATION.json +12 -0
- package/.agents/core/skills/ponytail-mindset/skill.yaml +14 -0
- package/.agents/core/skills/react/EXAMPLES.md +79 -0
- package/.agents/core/skills/react/SKILL.md +132 -0
- package/.agents/core/skills/react/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/react/VALIDATION.json +12 -0
- package/.agents/core/skills/react/react.md +93 -0
- package/.agents/core/skills/react/skill.yaml +10 -0
- package/.agents/core/skills/react-best-practices/SKILL.md +155 -0
- package/.agents/core/skills/react-best-practices/VALIDATION.json +12 -0
- package/.agents/core/skills/react-best-practices/skill.yaml +10 -0
- package/.agents/core/skills/redesign-audit/SKILL.md +117 -0
- package/.agents/core/skills/redesign-audit/VALIDATION.json +12 -0
- package/.agents/core/skills/redesign-audit/skill.yaml +8 -0
- package/.agents/core/skills/security/EXAMPLES.md +64 -0
- package/.agents/core/skills/security/SKILL.md +158 -0
- package/.agents/core/skills/security/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/security/VALIDATION.json +12 -0
- package/.agents/core/skills/security/security.md +106 -0
- package/.agents/core/skills/security/skill.yaml +10 -0
- package/.agents/core/skills/soft-design/SKILL.md +108 -0
- package/.agents/core/skills/soft-design/VALIDATION.json +12 -0
- package/.agents/core/skills/soft-design/skill.yaml +8 -0
- package/.agents/core/skills/state-management/EXAMPLES.md +56 -0
- package/.agents/core/skills/state-management/SKILL.md +48 -0
- package/.agents/core/skills/state-management/TROUBLESHOOTING.md +18 -0
- package/.agents/core/skills/state-management/VALIDATION.json +11 -0
- package/.agents/core/skills/state-management/skill.yaml +22 -0
- package/.agents/core/skills/subagent-orchestrator/SKILL.md +100 -0
- package/.agents/core/skills/subagent-orchestrator/VALIDATION.json +12 -0
- package/.agents/core/skills/subagent-orchestrator/skill.yaml +8 -0
- package/.agents/core/skills/system-design/EXAMPLES.md +75 -0
- package/.agents/core/skills/system-design/SKILL.md +419 -0
- package/.agents/core/skills/system-design/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/system-design/VALIDATION.json +12 -0
- package/.agents/core/skills/system-design/skill.yaml +13 -0
- package/.agents/core/skills/system-design/system-design.md +112 -0
- package/.agents/core/skills/testing/EXAMPLES.md +71 -0
- package/.agents/core/skills/testing/SKILL.md +70 -0
- package/.agents/core/skills/testing/TROUBLESHOOTING.md +18 -0
- package/.agents/core/skills/testing/VALIDATION.json +11 -0
- package/.agents/core/skills/testing/skill.yaml +26 -0
- package/.agents/core/skills/typescript/EXAMPLES.md +64 -0
- package/.agents/core/skills/typescript/SKILL.md +112 -0
- package/.agents/core/skills/typescript/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/typescript/VALIDATION.json +12 -0
- package/.agents/core/skills/typescript/skill.yaml +10 -0
- package/.agents/core/skills/typescript/typescript.md +71 -0
- package/.agents/core/skills/ui-design/EXAMPLES.md +21 -0
- package/.agents/core/skills/ui-design/SKILL.md +124 -0
- package/.agents/core/skills/ui-design/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/ui-design/VALIDATION.json +12 -0
- package/.agents/core/skills/ui-design/skill.yaml +10 -0
- package/.agents/core/skills/ui-design/ui.md +88 -0
- package/.agents/core/skills/ui-ux-pro/EXAMPLES.md +62 -0
- package/.agents/core/skills/ui-ux-pro/SKILL.md +375 -0
- package/.agents/core/skills/ui-ux-pro/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/ui-ux-pro/VALIDATION.json +12 -0
- package/.agents/core/skills/ui-ux-pro/skill.yaml +13 -0
- package/.agents/core/skills/ux-design/EXAMPLES.md +36 -0
- package/.agents/core/skills/ux-design/SKILL.md +116 -0
- package/.agents/core/skills/ux-design/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/ux-design/VALIDATION.json +12 -0
- package/.agents/core/skills/ux-design/skill.yaml +10 -0
- package/.agents/core/skills/ux-design/ux.md +80 -0
- package/.agents/core/skills/vercel-optimize/SKILL.md +83 -0
- package/.agents/core/skills/vercel-optimize/VALIDATION.json +12 -0
- package/.agents/core/skills/vercel-optimize/skill.yaml +10 -0
- package/.agents/core/skills/web-accessibility/EXAMPLES.md +39 -0
- package/.agents/core/skills/web-accessibility/SKILL.md +170 -0
- package/.agents/core/skills/web-accessibility/TROUBLESHOOTING.md +19 -0
- package/.agents/core/skills/web-accessibility/VALIDATION.json +12 -0
- package/.agents/core/skills/web-accessibility/accessibility.md +63 -0
- package/.agents/core/skills/web-accessibility/skill.yaml +10 -0
- package/.agents/ctx.js +370 -0
- package/.agents/generated/claude/skills/adapters/SKILL.md +126 -0
- package/.agents/generated/claude/skills/architecture-diagrams/SKILL.md +101 -0
- package/.agents/generated/claude/skills/brutalist-design/SKILL.md +145 -0
- package/.agents/generated/claude/skills/context-manager/SKILL.md +147 -0
- package/.agents/generated/claude/skills/context-os/SKILL.md +191 -0
- package/.agents/generated/claude/skills/database/SKILL.md +191 -0
- package/.agents/generated/claude/skills/ddd/SKILL.md +305 -0
- package/.agents/generated/claude/skills/decisions/SKILL.md +134 -0
- package/.agents/generated/claude/skills/docker/SKILL.md +135 -0
- package/.agents/generated/claude/skills/engineering-workflow/SKILL.md +414 -0
- package/.agents/generated/claude/skills/fastapi/SKILL.md +200 -0
- package/.agents/generated/claude/skills/gemini-precision/SKILL.md +161 -0
- package/.agents/generated/claude/skills/generators/SKILL.md +133 -0
- package/.agents/generated/claude/skills/graphify/SKILL.md +198 -0
- package/.agents/generated/claude/skills/gstack-roles/SKILL.md +184 -0
- package/.agents/generated/claude/skills/impeccable-design/SKILL.md +241 -0
- package/.agents/generated/claude/skills/interview-me/SKILL.md +90 -0
- package/.agents/generated/claude/skills/microservices/SKILL.md +218 -0
- package/.agents/generated/claude/skills/minimalist-design/SKILL.md +108 -0
- package/.agents/generated/claude/skills/nestjs/SKILL.md +195 -0
- package/.agents/generated/claude/skills/nextjs/SKILL.md +219 -0
- package/.agents/generated/claude/skills/node/SKILL.md +224 -0
- package/.agents/generated/claude/skills/performance/SKILL.md +121 -0
- package/.agents/generated/claude/skills/ponytail-mindset/SKILL.md +252 -0
- package/.agents/generated/claude/skills/react/SKILL.md +227 -0
- package/.agents/generated/claude/skills/react-best-practices/SKILL.md +146 -0
- package/.agents/generated/claude/skills/redesign-audit/SKILL.md +112 -0
- package/.agents/generated/claude/skills/security/SKILL.md +237 -0
- package/.agents/generated/claude/skills/soft-design/SKILL.md +103 -0
- package/.agents/generated/claude/skills/state-management/SKILL.md +120 -0
- package/.agents/generated/claude/skills/subagent-orchestrator/SKILL.md +93 -0
- package/.agents/generated/claude/skills/system-design/SKILL.md +507 -0
- package/.agents/generated/claude/skills/testing/SKILL.md +157 -0
- package/.agents/generated/claude/skills/typescript/SKILL.md +192 -0
- package/.agents/generated/claude/skills/ui-design/SKILL.md +161 -0
- package/.agents/generated/claude/skills/ui-ux-pro/SKILL.md +451 -0
- package/.agents/generated/claude/skills/ux-design/SKILL.md +168 -0
- package/.agents/generated/claude/skills/vercel-optimize/SKILL.md +76 -0
- package/.agents/generated/claude/skills/web-accessibility/SKILL.md +225 -0
- package/.agents/generated/gemini/skills/adapters/SKILL.md +135 -0
- package/.agents/generated/gemini/skills/architecture-diagrams/SKILL.md +107 -0
- package/.agents/generated/gemini/skills/brutalist-design/SKILL.md +151 -0
- package/.agents/generated/gemini/skills/context-manager/SKILL.md +156 -0
- package/.agents/generated/gemini/skills/context-os/SKILL.md +200 -0
- package/.agents/generated/gemini/skills/database/SKILL.md +200 -0
- package/.agents/generated/gemini/skills/ddd/SKILL.md +314 -0
- package/.agents/generated/gemini/skills/decisions/SKILL.md +143 -0
- package/.agents/generated/gemini/skills/docker/SKILL.md +144 -0
- package/.agents/generated/gemini/skills/engineering-workflow/SKILL.md +423 -0
- package/.agents/generated/gemini/skills/fastapi/SKILL.md +209 -0
- package/.agents/generated/gemini/skills/gemini-precision/SKILL.md +167 -0
- package/.agents/generated/gemini/skills/generators/SKILL.md +142 -0
- package/.agents/generated/gemini/skills/graphify/SKILL.md +205 -0
- package/.agents/generated/gemini/skills/gstack-roles/SKILL.md +193 -0
- package/.agents/generated/gemini/skills/impeccable-design/SKILL.md +250 -0
- package/.agents/generated/gemini/skills/interview-me/SKILL.md +96 -0
- package/.agents/generated/gemini/skills/microservices/SKILL.md +227 -0
- package/.agents/generated/gemini/skills/minimalist-design/SKILL.md +114 -0
- package/.agents/generated/gemini/skills/nestjs/SKILL.md +204 -0
- package/.agents/generated/gemini/skills/nextjs/SKILL.md +298 -0
- package/.agents/generated/gemini/skills/node/SKILL.md +323 -0
- package/.agents/generated/gemini/skills/performance/SKILL.md +185 -0
- package/.agents/generated/gemini/skills/ponytail-mindset/SKILL.md +261 -0
- package/.agents/generated/gemini/skills/react/SKILL.md +332 -0
- package/.agents/generated/gemini/skills/react-best-practices/SKILL.md +152 -0
- package/.agents/generated/gemini/skills/redesign-audit/SKILL.md +118 -0
- package/.agents/generated/gemini/skills/security/SKILL.md +355 -0
- package/.agents/generated/gemini/skills/soft-design/SKILL.md +109 -0
- package/.agents/generated/gemini/skills/state-management/SKILL.md +129 -0
- package/.agents/generated/gemini/skills/subagent-orchestrator/SKILL.md +99 -0
- package/.agents/generated/gemini/skills/system-design/SKILL.md +631 -0
- package/.agents/generated/gemini/skills/testing/SKILL.md +166 -0
- package/.agents/generated/gemini/skills/typescript/SKILL.md +275 -0
- package/.agents/generated/gemini/skills/ui-design/SKILL.md +170 -0
- package/.agents/generated/gemini/skills/ui-ux-pro/SKILL.md +460 -0
- package/.agents/generated/gemini/skills/ux-design/SKILL.md +177 -0
- package/.agents/generated/gemini/skills/vercel-optimize/SKILL.md +82 -0
- package/.agents/generated/gemini/skills/web-accessibility/SKILL.md +300 -0
- package/.agents/mcp/runtime.py +454 -0
- package/.agents/mcp/server.mjs +189373 -0
- package/.agents/plugins.js +574 -0
- package/.agents/profiles.js +267 -0
- package/.agents/resolver.js +336 -0
- package/.agents/skills-index.json +200 -0
- package/.agents/skills.json +6 -0
- package/.agents/validate.js +500 -0
- package/LICENSE +21 -0
- package/README.md +415 -0
- package/benchmarks/gemini-issues.js +533 -0
- package/bin/index.js +458 -0
- package/package.json +70 -0
- package/registry.json +53 -0
- package/registry.schema.json +32 -0
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# {{Project Name}} — API Specification
|
|
2
|
+
|
|
3
|
+
## Base URL
|
|
4
|
+
|
|
5
|
+
`{{base_url}}` (e.g., `https://api.example.com/v1`)
|
|
6
|
+
|
|
7
|
+
## Authentication
|
|
8
|
+
|
|
9
|
+
{{auth_method}} (e.g., Bearer token via JWT)
|
|
10
|
+
|
|
11
|
+
## Endpoints
|
|
12
|
+
|
|
13
|
+
### {{Module Name}}
|
|
14
|
+
|
|
15
|
+
#### `{{METHOD}} {{path}}`
|
|
16
|
+
|
|
17
|
+
{{description}}
|
|
18
|
+
|
|
19
|
+
**Request:**
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{{request_body}}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Response (200):**
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{{response_body}}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Errors:**
|
|
32
|
+
|
|
33
|
+
| Code | Description |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| 400 | {{bad_request_reason}} |
|
|
36
|
+
| 401 | Unauthorized |
|
|
37
|
+
| 404 | {{not_found_reason}} |
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Error Format
|
|
42
|
+
|
|
43
|
+
All errors follow this format:
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"error": {
|
|
48
|
+
"code": "ERROR_CODE",
|
|
49
|
+
"message": "Human-readable message",
|
|
50
|
+
"details": {}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Pagination
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"data": [...],
|
|
60
|
+
"pagination": {
|
|
61
|
+
"page": 1,
|
|
62
|
+
"per_page": 20,
|
|
63
|
+
"total": 100,
|
|
64
|
+
"total_pages": 5
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Rate Limiting
|
|
70
|
+
|
|
71
|
+
- {{rate_limit}} requests per {{window}}
|
|
72
|
+
- Headers: `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`
|
|
73
|
+
|
|
74
|
+
## Versioning
|
|
75
|
+
|
|
76
|
+
- URL-based: `/v1/`, `/v2/`
|
|
77
|
+
- Breaking changes require new version
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# {{Project Name}} — System Architecture
|
|
2
|
+
|
|
3
|
+
## Architecture Overview
|
|
4
|
+
<!-- High-level architecture description and diagram -->
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
{{architecture_diagram}}
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Tech Stack
|
|
11
|
+
|
|
12
|
+
| Layer | Technology | Reason |
|
|
13
|
+
| --- | --- | --- |
|
|
14
|
+
| Frontend | {{e.g., Next.js + React}} | {{reason}} |
|
|
15
|
+
| Backend | {{e.g., Node.js + Express}} | {{reason}} |
|
|
16
|
+
| Database | {{e.g., PostgreSQL}} | {{reason}} |
|
|
17
|
+
| Cache | {{e.g., Redis}} | {{reason}} |
|
|
18
|
+
| Auth | {{e.g., JWT + OAuth2}} | {{reason}} |
|
|
19
|
+
| Hosting | {{e.g., Vercel + Railway}} | {{reason}} |
|
|
20
|
+
|
|
21
|
+
## System Components
|
|
22
|
+
|
|
23
|
+
### {{Component 1 Name}}
|
|
24
|
+
|
|
25
|
+
- **Responsibility:** {{what it does}}
|
|
26
|
+
- **Interfaces:** {{what it exposes}}
|
|
27
|
+
- **Dependencies:** {{what it depends on}}
|
|
28
|
+
|
|
29
|
+
### {{Component 2 Name}}
|
|
30
|
+
|
|
31
|
+
- **Responsibility:** {{what it does}}
|
|
32
|
+
- **Interfaces:** {{what it exposes}}
|
|
33
|
+
- **Dependencies:** {{what it depends on}}
|
|
34
|
+
|
|
35
|
+
## Data Flow
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
User → Frontend → API Gateway → Service Layer → Database
|
|
39
|
+
↓
|
|
40
|
+
Cache Layer
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Directory Structure
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
{{project_root}}/
|
|
47
|
+
├── src/
|
|
48
|
+
│ ├── modules/ # Feature modules
|
|
49
|
+
│ │ ├── {{module_1}}/
|
|
50
|
+
│ │ └── {{module_2}}/
|
|
51
|
+
│ ├── shared/ # Shared utilities
|
|
52
|
+
│ ├── config/ # Configuration
|
|
53
|
+
│ └── types/ # Type definitions
|
|
54
|
+
├── tests/
|
|
55
|
+
├── docs/
|
|
56
|
+
└── infrastructure/
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Security Architecture
|
|
60
|
+
<!-- Authentication, authorization, data protection -->
|
|
61
|
+
|
|
62
|
+
## Scalability Considerations
|
|
63
|
+
<!-- How will this scale? What are the bottlenecks? -->
|
|
64
|
+
|
|
65
|
+
## Error Handling Strategy
|
|
66
|
+
<!-- How are errors propagated, logged, and reported? -->
|
|
67
|
+
|
|
68
|
+
## Key Architectural Decisions
|
|
69
|
+
<!-- Reference to ADRs in docs/decisions/ -->
|
|
70
|
+
- See `docs/decisions/` for all architectural decisions with rationale
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# {{Project Name}} — Database Schema
|
|
2
|
+
|
|
3
|
+
## Database Engine
|
|
4
|
+
|
|
5
|
+
{{e.g., PostgreSQL 16}}
|
|
6
|
+
|
|
7
|
+
## Entity Relationship Diagram
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
{{ER_diagram}}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Tables
|
|
14
|
+
|
|
15
|
+
### {{table_name}}
|
|
16
|
+
|
|
17
|
+
| Column | Type | Constraints | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| id | UUID | PK, DEFAULT gen_random_uuid() | Primary key |
|
|
20
|
+
| {{column}} | {{type}} | {{constraints}} | {{description}} |
|
|
21
|
+
| created_at | TIMESTAMPTZ | NOT NULL, DEFAULT NOW() | Creation timestamp |
|
|
22
|
+
| updated_at | TIMESTAMPTZ | NOT NULL, DEFAULT NOW() | Last update timestamp |
|
|
23
|
+
|
|
24
|
+
**Indexes:**
|
|
25
|
+
|
|
26
|
+
- `idx_{{table}}_{{column}}` ON ({{column}})
|
|
27
|
+
|
|
28
|
+
**Relations:**
|
|
29
|
+
|
|
30
|
+
- {{table_name}}.{{fk_column}} → {{related_table}}.id
|
|
31
|
+
|
|
32
|
+
## Migrations Strategy
|
|
33
|
+
<!-- How are schema changes applied? -->
|
|
34
|
+
- Tool: {{e.g., Prisma Migrate, Alembic, Knex}}
|
|
35
|
+
- Naming: `YYYYMMDD_HHMMSS_description`
|
|
36
|
+
- Rule: Never modify existing migrations, always create new ones
|
|
37
|
+
|
|
38
|
+
## Seed Data
|
|
39
|
+
<!-- What data needs to exist for the app to work? -->
|
|
40
|
+
|
|
41
|
+
## Performance Considerations
|
|
42
|
+
<!-- Indexes, query optimization, connection pooling -->
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# ADR-{{number}}: {{Decision Title}}
|
|
2
|
+
|
|
3
|
+
**Date:** {{YYYY-MM-DD}}
|
|
4
|
+
**Status:** {{proposed | accepted | deprecated | superseded}}
|
|
5
|
+
**Affected modules:** {{module_1}}, {{module_2}}
|
|
6
|
+
|
|
7
|
+
## Decision
|
|
8
|
+
|
|
9
|
+
{{What was decided, in one sentence.}}
|
|
10
|
+
|
|
11
|
+
## Why
|
|
12
|
+
|
|
13
|
+
{{The reasoning behind this decision. What problem does it solve?}}
|
|
14
|
+
|
|
15
|
+
## Alternatives Considered
|
|
16
|
+
|
|
17
|
+
### {{Alternative 1}}
|
|
18
|
+
|
|
19
|
+
- **Pros:** {{advantages}}
|
|
20
|
+
- **Cons:** {{disadvantages}}
|
|
21
|
+
- **Why rejected:** {{reason}}
|
|
22
|
+
|
|
23
|
+
### {{Alternative 2}}
|
|
24
|
+
|
|
25
|
+
- **Pros:** {{advantages}}
|
|
26
|
+
- **Cons:** {{disadvantages}}
|
|
27
|
+
- **Why rejected:** {{reason}}
|
|
28
|
+
|
|
29
|
+
## Tradeoffs
|
|
30
|
+
|
|
31
|
+
| Aspect | Gain | Cost |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| {{aspect_1}} | {{what_we_gain}} | {{what_we_lose}} |
|
|
34
|
+
| {{aspect_2}} | {{what_we_gain}} | {{what_we_lose}} |
|
|
35
|
+
|
|
36
|
+
## Impact
|
|
37
|
+
|
|
38
|
+
- **Code changes:** {{what files/modules are affected}}
|
|
39
|
+
- **Performance:** {{performance impact}}
|
|
40
|
+
- **Team:** {{learning curve, tooling changes}}
|
|
41
|
+
- **Reversibility:** {{easy | moderate | hard | irreversible}}
|
|
42
|
+
|
|
43
|
+
## References
|
|
44
|
+
|
|
45
|
+
- {{link_1}}
|
|
46
|
+
- {{link_2}}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# {{Project Name}} — Product Requirements Document
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
<!-- One paragraph describing what this product does and who it's for -->
|
|
5
|
+
{{project_description}}
|
|
6
|
+
|
|
7
|
+
## Problem Statement
|
|
8
|
+
<!-- What problem does this solve? Why does it need to exist? -->
|
|
9
|
+
|
|
10
|
+
## Target Users
|
|
11
|
+
<!-- Who will use this? Define user personas -->
|
|
12
|
+
|
|
13
|
+
| Persona | Description | Key Needs |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| {{persona_1}} | {{description}} | {{needs}} |
|
|
16
|
+
| {{persona_2}} | {{description}} | {{needs}} |
|
|
17
|
+
|
|
18
|
+
## Core Features
|
|
19
|
+
|
|
20
|
+
### Must Have (P0)
|
|
21
|
+
<!-- Features required for MVP -->
|
|
22
|
+
- [ ] {{feature_1}}
|
|
23
|
+
- [ ] {{feature_2}}
|
|
24
|
+
|
|
25
|
+
### Should Have (P1)
|
|
26
|
+
<!-- Features for v1.0 -->
|
|
27
|
+
- [ ] {{feature_3}}
|
|
28
|
+
- [ ] {{feature_4}}
|
|
29
|
+
|
|
30
|
+
### Nice to Have (P2)
|
|
31
|
+
<!-- Future features -->
|
|
32
|
+
- [ ] {{feature_5}}
|
|
33
|
+
|
|
34
|
+
## User Flows
|
|
35
|
+
|
|
36
|
+
### {{Primary Flow Name}}
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
Step 1: {{action}}
|
|
40
|
+
Step 2: {{action}}
|
|
41
|
+
Step 3: {{action}}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Non-Functional Requirements
|
|
45
|
+
|
|
46
|
+
| Requirement | Target |
|
|
47
|
+
| --- | --- |
|
|
48
|
+
| Performance | {{e.g., page load < 2s}} |
|
|
49
|
+
| Availability | {{e.g., 99.9%}} |
|
|
50
|
+
| Security | {{e.g., OWASP Top 10 compliance}} |
|
|
51
|
+
| Accessibility | {{e.g., WCAG 2.1 AA}} |
|
|
52
|
+
| Scalability | {{e.g., 10K concurrent users}} |
|
|
53
|
+
|
|
54
|
+
## Constraints
|
|
55
|
+
<!-- Technical, business, or timeline constraints -->
|
|
56
|
+
- {{constraint_1}}
|
|
57
|
+
- {{constraint_2}}
|
|
58
|
+
|
|
59
|
+
## Success Metrics
|
|
60
|
+
<!-- How will we measure success? -->
|
|
61
|
+
- {{metric_1}}
|
|
62
|
+
- {{metric_2}}
|
|
63
|
+
|
|
64
|
+
## Out of Scope
|
|
65
|
+
<!-- What this project explicitly does NOT do -->
|
|
66
|
+
- {{exclusion_1}}
|
|
67
|
+
- {{exclusion_2}}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# {{Project Name}} — Project Graph
|
|
2
|
+
|
|
3
|
+
## Project
|
|
4
|
+
|
|
5
|
+
```yaml
|
|
6
|
+
name: "{{project_name}}"
|
|
7
|
+
type: {{webapp | api | mobile | cli | saas | crm | ecommerce}}
|
|
8
|
+
profile: {{startup | enterprise | mvp | hackathon}}
|
|
9
|
+
pack: {{skill_pack_name}}
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Modules
|
|
13
|
+
|
|
14
|
+
### {{module_name}}
|
|
15
|
+
|
|
16
|
+
```yaml
|
|
17
|
+
module: {{module_name}}
|
|
18
|
+
description: "{{what this module does}}"
|
|
19
|
+
features:
|
|
20
|
+
- {{feature_1}}
|
|
21
|
+
- {{feature_2}}
|
|
22
|
+
files:
|
|
23
|
+
- src/modules/{{module_name}}/**
|
|
24
|
+
skills: [{{skill_1}}, {{skill_2}}]
|
|
25
|
+
depends_on: [{{other_module}}]
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
<!-- Repeat for each module -->
|
|
31
|
+
|
|
32
|
+
## Module Dependency Graph
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
{{module_1}} ──depends──▶ {{module_2}}
|
|
36
|
+
│
|
|
37
|
+
└──depends──▶ {{module_3}}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## File → Module Mapping
|
|
41
|
+
|
|
42
|
+
| File Pattern | Module | Skills |
|
|
43
|
+
| --- | --- | --- |
|
|
44
|
+
| `src/modules/{{module}}/**` | {{module}} | {{skills}} |
|
|
45
|
+
| `src/shared/**` | shared | {{skills}} |
|
|
46
|
+
| `src/config/**` | config | — |
|
|
47
|
+
| `tests/**` | testing | testing |
|
|
48
|
+
| `docs/**` | docs | — |
|
|
49
|
+
|
|
50
|
+
## Feature → Task Mapping
|
|
51
|
+
|
|
52
|
+
### {{Feature Name}} `[{{module}}]`
|
|
53
|
+
|
|
54
|
+
- [ ] {{task_1}} → `{{file_path}}`
|
|
55
|
+
- [ ] {{task_2}} → `{{file_path}}`
|
|
56
|
+
- [ ] {{task_3}} → `{{file_path}}`
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# {{Project Name}} — Roadmap
|
|
2
|
+
|
|
3
|
+
## Vision
|
|
4
|
+
|
|
5
|
+
{{one_sentence_vision}}
|
|
6
|
+
|
|
7
|
+
## Milestones
|
|
8
|
+
|
|
9
|
+
### v0.1 — MVP ({{target_date}})
|
|
10
|
+
|
|
11
|
+
**Goal:** {{what_mvp_achieves}}
|
|
12
|
+
|
|
13
|
+
- [ ] {{feature_1}}
|
|
14
|
+
- [ ] {{feature_2}}
|
|
15
|
+
- [ ] {{feature_3}}
|
|
16
|
+
|
|
17
|
+
**Success criteria:** {{how_to_know_mvp_is_done}}
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
### v0.2 — {{milestone_name}} ({{target_date}})
|
|
22
|
+
|
|
23
|
+
**Goal:** {{what_this_milestone_achieves}}
|
|
24
|
+
|
|
25
|
+
- [ ] {{feature_4}}
|
|
26
|
+
- [ ] {{feature_5}}
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
### v1.0 — Production ({{target_date}})
|
|
31
|
+
|
|
32
|
+
**Goal:** {{what_production_means}}
|
|
33
|
+
|
|
34
|
+
- [ ] {{feature_6}}
|
|
35
|
+
- [ ] {{feature_7}}
|
|
36
|
+
- [ ] Performance optimization
|
|
37
|
+
- [ ] Security audit
|
|
38
|
+
- [ ] Documentation
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Backlog
|
|
43
|
+
<!-- Future ideas not yet scheduled -->
|
|
44
|
+
- {{idea_1}}
|
|
45
|
+
- {{idea_2}}
|
|
46
|
+
|
|
47
|
+
## Risks
|
|
48
|
+
|
|
49
|
+
| Risk | Impact | Mitigation |
|
|
50
|
+
|---|---|---|
|
|
51
|
+
| {{risk_1}} | {{high/medium/low}} | {{mitigation}} |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# {{Project Name}} — Tasks
|
|
2
|
+
|
|
3
|
+
## Current Sprint: {{sprint_name}}
|
|
4
|
+
|
|
5
|
+
### In Progress
|
|
6
|
+
|
|
7
|
+
- [ ] {{task}} `[{{module}}]` `[{{size: S/M/L/XL}}]`
|
|
8
|
+
|
|
9
|
+
### To Do
|
|
10
|
+
|
|
11
|
+
- [ ] {{task}} `[{{module}}]` `[{{size}}]`
|
|
12
|
+
- [ ] {{task}} `[{{module}}]` `[{{size}}]`
|
|
13
|
+
|
|
14
|
+
### Done
|
|
15
|
+
|
|
16
|
+
- [x] {{completed_task}} `[{{module}}]`
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Task Format
|
|
21
|
+
|
|
22
|
+
Each task should include:
|
|
23
|
+
|
|
24
|
+
- **Description**: What needs to be done
|
|
25
|
+
- **Module**: Which Project Graph module this belongs to
|
|
26
|
+
- **Size**: S (< 1hr), M (1-4hr), L (4-8hr), XL (> 8hr)
|
|
27
|
+
- **Dependencies**: What must be done first
|
|
28
|
+
- **Acceptance criteria**: How to know it's done
|
|
29
|
+
- **Skills needed**: Which skills the AI should load
|
|
30
|
+
|
|
31
|
+
### Example Task
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
- [ ] Implement appointment calendar API [appointments] [L]
|
|
35
|
+
Dependencies: auth module, database schema
|
|
36
|
+
Acceptance: CRUD endpoints for appointments, tests passing
|
|
37
|
+
Skills: node, typescript, postgres, testing
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Backlog
|
|
41
|
+
<!-- Tasks not yet assigned to a sprint -->
|
|
42
|
+
- [ ] {{backlog_task_1}}
|
|
43
|
+
- [ ] {{backlog_task_2}}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# {{Project Name}} — UI/UX Specification
|
|
2
|
+
|
|
3
|
+
## Design System
|
|
4
|
+
|
|
5
|
+
### Colors
|
|
6
|
+
|
|
7
|
+
| Token | Value | Usage |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| `--color-primary` | {{hex}} | Primary actions, links |
|
|
10
|
+
| `--color-secondary` | {{hex}} | Secondary elements |
|
|
11
|
+
| `--color-background` | {{hex}} | Page background |
|
|
12
|
+
| `--color-surface` | {{hex}} | Card/panel backgrounds |
|
|
13
|
+
| `--color-text` | {{hex}} | Body text |
|
|
14
|
+
| `--color-text-muted` | {{hex}} | Secondary text |
|
|
15
|
+
| `--color-error` | {{hex}} | Error states |
|
|
16
|
+
| `--color-success` | {{hex}} | Success states |
|
|
17
|
+
|
|
18
|
+
### Typography
|
|
19
|
+
|
|
20
|
+
| Level | Font | Size | Weight | Line Height |
|
|
21
|
+
| --- | --- | --- | --- | --- |
|
|
22
|
+
| H1 | {{font}} | {{size}} | {{weight}} | {{lh}} |
|
|
23
|
+
| H2 | {{font}} | {{size}} | {{weight}} | {{lh}} |
|
|
24
|
+
| Body | {{font}} | {{size}} | {{weight}} | {{lh}} |
|
|
25
|
+
| Caption | {{font}} | {{size}} | {{weight}} | {{lh}} |
|
|
26
|
+
|
|
27
|
+
### Spacing Scale
|
|
28
|
+
|
|
29
|
+
`4px, 8px, 12px, 16px, 24px, 32px, 48px, 64px`
|
|
30
|
+
|
|
31
|
+
### Border Radius
|
|
32
|
+
|
|
33
|
+
| Token | Value | Usage |
|
|
34
|
+
| --- | --- | --- |
|
|
35
|
+
| `--radius-sm` | 4px | Inputs, small elements |
|
|
36
|
+
| `--radius-md` | 8px | Cards, panels |
|
|
37
|
+
| `--radius-lg` | 16px | Modals, hero sections |
|
|
38
|
+
| `--radius-full` | 9999px | Pills, avatars |
|
|
39
|
+
|
|
40
|
+
## Pages
|
|
41
|
+
|
|
42
|
+
### {{Page Name}}
|
|
43
|
+
|
|
44
|
+
- **Route:** `{{route}}`
|
|
45
|
+
- **Purpose:** {{what this page does}}
|
|
46
|
+
- **Components:** {{list of components}}
|
|
47
|
+
- **States:** default, loading, empty, error
|
|
48
|
+
|
|
49
|
+
## Component Library
|
|
50
|
+
<!-- List of reusable components -->
|
|
51
|
+
|
|
52
|
+
| Component | Props | Variants |
|
|
53
|
+
| --- | --- | --- |
|
|
54
|
+
| Button | `variant, size, disabled` | primary, secondary, ghost |
|
|
55
|
+
| Input | `type, label, error` | text, email, password |
|
|
56
|
+
| Card | `title, actions` | default, elevated |
|
|
57
|
+
|
|
58
|
+
## Responsive Breakpoints
|
|
59
|
+
|
|
60
|
+
| Name | Width | Layout |
|
|
61
|
+
| --- | --- | --- |
|
|
62
|
+
| Mobile | < 640px | Single column |
|
|
63
|
+
| Tablet | 640-1024px | Two columns |
|
|
64
|
+
| Desktop | > 1024px | Full layout |
|
|
65
|
+
|
|
66
|
+
## Anti-Patterns (avoid these)
|
|
67
|
+
|
|
68
|
+
- No gray text on colored backgrounds
|
|
69
|
+
- No pure black — always tint with brand color
|
|
70
|
+
- No bounce/elastic easing — use ease-out
|
|
71
|
+
- No cards nested inside cards
|
|
72
|
+
- No generic color palettes (plain red, blue, green)
|
|
73
|
+
- No default browser fonts — use curated typography
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Graphify Examples — Anti-patterns vs ContextOS Standard
|
|
2
|
+
|
|
3
|
+
## Example 1: Codebase Exploration & Architecture Mapping
|
|
4
|
+
|
|
5
|
+
### Anti-pattern: Context Window Flooding (Dumping source directories into prompt)
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# BAD: Reading 150 TypeScript files into context to understand system architecture.
|
|
9
|
+
# Burns 200k+ tokens, causes model hallucinations, and loses attention span.
|
|
10
|
+
cat src/**/*.ts | llm "explain the architecture and component connections"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### Best practice: ContextOS Standard (Deterministic Tree-sitter AST Graph)
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# GOOD: Generate queryable AST knowledge graph and compact architecture summary
|
|
17
|
+
graphify run ./src --output .graphify/
|
|
18
|
+
|
|
19
|
+
# Inspect high-level architecture and god nodes with minimal tokens (<2k tokens)
|
|
20
|
+
cat .graphify/GRAPH_REPORT.md
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Example 2: Refactoring Blast-Radius Analysis
|
|
26
|
+
|
|
27
|
+
### Anti-pattern: String Grep Guesswork
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# BAD: Grepping for common symbol names returns hundreds of false positives (comments, logs, unrelated types)
|
|
31
|
+
grep -rn "PaymentService" src/
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Best practice: ContextOS Standard (Inbound Dependency Traversal via graph.json)
|
|
35
|
+
|
|
36
|
+
```javascript
|
|
37
|
+
// GOOD: Precise AST-level callers extracted directly from knowledge graph edges
|
|
38
|
+
const fs = require('fs');
|
|
39
|
+
const graph = JSON.parse(fs.readFileSync('.graphify/graph.json', 'utf8'));
|
|
40
|
+
|
|
41
|
+
const targetNode = 'PaymentService';
|
|
42
|
+
const dependents = graph.edges
|
|
43
|
+
.filter(edge => edge.target === targetNode && edge.type === 'imports')
|
|
44
|
+
.map(edge => edge.source);
|
|
45
|
+
|
|
46
|
+
console.log(`Modules directly broken by modifying ${targetNode}:`, dependents);
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Example 3: Keeping Graph Fresh in CI / Pre-commit
|
|
52
|
+
|
|
53
|
+
### Anti-pattern: Relying on Outdated Graphs
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# BAD: Developing against a graph generated two months ago.
|
|
57
|
+
# Dependencies drift, leading to false safety assumptions.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Best practice: ContextOS Standard (Git Hook & Automated Watch)
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Option A: Active development in watch mode
|
|
64
|
+
graphify watch ./src --output .graphify/
|
|
65
|
+
|
|
66
|
+
# Option B: Pre-commit hook to verify fresh GRAPH_REPORT.md
|
|
67
|
+
#!/bin/sh
|
|
68
|
+
# .git/hooks/pre-commit
|
|
69
|
+
if command -v graphify >/dev/null 2>&1; then
|
|
70
|
+
graphify run ./src --report-only
|
|
71
|
+
git add GRAPH_REPORT.md
|
|
72
|
+
fi
|
|
73
|
+
```
|