@ai-coders/context 0.1.0 β†’ 0.3.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.
Files changed (234) hide show
  1. package/README.md +113 -580
  2. package/dist/generators/agents/agentConfig.d.ts +4 -0
  3. package/dist/generators/agents/agentConfig.d.ts.map +1 -0
  4. package/dist/generators/agents/agentConfig.js +138 -0
  5. package/dist/generators/agents/agentConfig.js.map +1 -0
  6. package/dist/generators/agents/agentGenerator.d.ts +10 -0
  7. package/dist/generators/agents/agentGenerator.d.ts.map +1 -0
  8. package/dist/generators/agents/agentGenerator.js +137 -0
  9. package/dist/generators/agents/agentGenerator.js.map +1 -0
  10. package/dist/generators/agents/agentTypes.d.ts +4 -0
  11. package/dist/generators/agents/agentTypes.d.ts.map +1 -0
  12. package/dist/generators/agents/agentTypes.js +22 -0
  13. package/dist/generators/agents/agentTypes.js.map +1 -0
  14. package/dist/generators/agents/contextUtils.d.ts +8 -0
  15. package/dist/generators/agents/contextUtils.d.ts.map +1 -0
  16. package/dist/generators/agents/contextUtils.js +15 -0
  17. package/dist/generators/agents/contextUtils.js.map +1 -0
  18. package/dist/generators/agents/index.d.ts +4 -0
  19. package/dist/generators/agents/index.d.ts.map +1 -0
  20. package/dist/generators/agents/index.js +12 -0
  21. package/dist/generators/agents/index.js.map +1 -0
  22. package/dist/generators/agents/promptFormatter.d.ts +9 -0
  23. package/dist/generators/agents/promptFormatter.d.ts.map +1 -0
  24. package/dist/generators/agents/promptFormatter.js +84 -0
  25. package/dist/generators/agents/promptFormatter.js.map +1 -0
  26. package/dist/generators/agents/templates/index.d.ts +4 -0
  27. package/dist/generators/agents/templates/index.d.ts.map +1 -0
  28. package/dist/generators/agents/templates/index.js +8 -0
  29. package/dist/generators/agents/templates/index.js.map +1 -0
  30. package/dist/generators/agents/templates/indexTemplate.d.ts +3 -0
  31. package/dist/generators/agents/templates/indexTemplate.d.ts.map +1 -0
  32. package/dist/generators/agents/templates/indexTemplate.js +35 -0
  33. package/dist/generators/agents/templates/indexTemplate.js.map +1 -0
  34. package/dist/generators/agents/templates/playbookTemplate.d.ts +4 -0
  35. package/dist/generators/agents/templates/playbookTemplate.d.ts.map +1 -0
  36. package/dist/generators/agents/templates/playbookTemplate.js +63 -0
  37. package/dist/generators/agents/templates/playbookTemplate.js.map +1 -0
  38. package/dist/generators/agents/templates/types.d.ts +14 -0
  39. package/dist/generators/agents/templates/types.d.ts.map +1 -0
  40. package/dist/generators/agents/templates/types.js +3 -0
  41. package/dist/generators/agents/templates/types.js.map +1 -0
  42. package/dist/generators/analyzers/codebaseAnalyzer.d.ts +45 -0
  43. package/dist/generators/analyzers/codebaseAnalyzer.d.ts.map +1 -0
  44. package/dist/generators/analyzers/codebaseAnalyzer.js +293 -0
  45. package/dist/generators/analyzers/codebaseAnalyzer.js.map +1 -0
  46. package/dist/generators/analyzers/index.d.ts +3 -0
  47. package/dist/generators/analyzers/index.d.ts.map +1 -0
  48. package/dist/generators/analyzers/index.js +6 -0
  49. package/dist/generators/analyzers/index.js.map +1 -0
  50. package/dist/generators/documentation/documentationGenerator.d.ts +13 -0
  51. package/dist/generators/documentation/documentationGenerator.d.ts.map +1 -0
  52. package/dist/generators/documentation/documentationGenerator.js +115 -0
  53. package/dist/generators/documentation/documentationGenerator.js.map +1 -0
  54. package/dist/generators/documentation/documentationTemplates.d.ts +21 -0
  55. package/dist/generators/documentation/documentationTemplates.d.ts.map +1 -0
  56. package/dist/generators/documentation/documentationTemplates.js +359 -0
  57. package/dist/generators/documentation/documentationTemplates.js.map +1 -0
  58. package/dist/generators/documentation/documentationTypes.d.ts +11 -0
  59. package/dist/generators/documentation/documentationTypes.d.ts.map +1 -0
  60. package/dist/generators/documentation/documentationTypes.js +22 -0
  61. package/dist/generators/documentation/documentationTypes.js.map +1 -0
  62. package/dist/generators/documentation/documentationUtils.d.ts +7 -0
  63. package/dist/generators/documentation/documentationUtils.d.ts.map +1 -0
  64. package/dist/generators/documentation/documentationUtils.js +28 -0
  65. package/dist/generators/documentation/documentationUtils.js.map +1 -0
  66. package/dist/generators/documentation/guideRegistry.d.ts +6 -0
  67. package/dist/generators/documentation/guideRegistry.d.ts.map +1 -0
  68. package/dist/generators/documentation/guideRegistry.js +82 -0
  69. package/dist/generators/documentation/guideRegistry.js.map +1 -0
  70. package/dist/generators/{incrementalDocumentationGenerator.d.ts β†’ documentation/incrementalDocumentationGenerator.d.ts} +4 -4
  71. package/dist/generators/documentation/incrementalDocumentationGenerator.d.ts.map +1 -0
  72. package/dist/generators/documentation/incrementalDocumentationGenerator.js.map +1 -0
  73. package/dist/generators/documentation/index.d.ts +2 -0
  74. package/dist/generators/documentation/index.d.ts.map +1 -0
  75. package/dist/generators/documentation/index.js +6 -0
  76. package/dist/generators/documentation/index.js.map +1 -0
  77. package/dist/generators/documentation/templates/architectureTemplate.d.ts +3 -0
  78. package/dist/generators/documentation/templates/architectureTemplate.d.ts.map +1 -0
  79. package/dist/generators/documentation/templates/architectureTemplate.js +66 -0
  80. package/dist/generators/documentation/templates/architectureTemplate.js.map +1 -0
  81. package/dist/generators/documentation/templates/common.d.ts +7 -0
  82. package/dist/generators/documentation/templates/common.d.ts.map +1 -0
  83. package/dist/generators/documentation/templates/common.js +58 -0
  84. package/dist/generators/documentation/templates/common.js.map +1 -0
  85. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts +3 -0
  86. package/dist/generators/documentation/templates/dataFlowTemplate.d.ts.map +1 -0
  87. package/dist/generators/documentation/templates/dataFlowTemplate.js +55 -0
  88. package/dist/generators/documentation/templates/dataFlowTemplate.js.map +1 -0
  89. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts +2 -0
  90. package/dist/generators/documentation/templates/developmentWorkflowTemplate.d.ts.map +1 -0
  91. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js +59 -0
  92. package/dist/generators/documentation/templates/developmentWorkflowTemplate.js.map +1 -0
  93. package/dist/generators/documentation/templates/frontMatter.d.ts +11 -0
  94. package/dist/generators/documentation/templates/frontMatter.d.ts.map +1 -0
  95. package/dist/generators/documentation/templates/frontMatter.js +29 -0
  96. package/dist/generators/documentation/templates/frontMatter.js.map +1 -0
  97. package/dist/generators/documentation/templates/glossaryTemplate.d.ts +3 -0
  98. package/dist/generators/documentation/templates/glossaryTemplate.d.ts.map +1 -0
  99. package/dist/generators/documentation/templates/glossaryTemplate.js +55 -0
  100. package/dist/generators/documentation/templates/glossaryTemplate.js.map +1 -0
  101. package/dist/generators/documentation/templates/index.d.ts +11 -0
  102. package/dist/generators/documentation/templates/index.d.ts.map +1 -0
  103. package/dist/generators/documentation/templates/index.js +22 -0
  104. package/dist/generators/documentation/templates/index.js.map +1 -0
  105. package/dist/generators/documentation/templates/indexTemplate.d.ts +3 -0
  106. package/dist/generators/documentation/templates/indexTemplate.d.ts.map +1 -0
  107. package/dist/generators/documentation/templates/indexTemplate.js +56 -0
  108. package/dist/generators/documentation/templates/indexTemplate.js.map +1 -0
  109. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts +3 -0
  110. package/dist/generators/documentation/templates/projectOverviewTemplate.d.ts.map +1 -0
  111. package/dist/generators/documentation/templates/projectOverviewTemplate.js +68 -0
  112. package/dist/generators/documentation/templates/projectOverviewTemplate.js.map +1 -0
  113. package/dist/generators/documentation/templates/securityTemplate.d.ts +2 -0
  114. package/dist/generators/documentation/templates/securityTemplate.d.ts.map +1 -0
  115. package/dist/generators/documentation/templates/securityTemplate.js +53 -0
  116. package/dist/generators/documentation/templates/securityTemplate.js.map +1 -0
  117. package/dist/generators/documentation/templates/testingTemplate.d.ts +2 -0
  118. package/dist/generators/documentation/templates/testingTemplate.d.ts.map +1 -0
  119. package/dist/generators/documentation/templates/testingTemplate.js +59 -0
  120. package/dist/generators/documentation/templates/testingTemplate.js.map +1 -0
  121. package/dist/generators/documentation/templates/toolingTemplate.d.ts +2 -0
  122. package/dist/generators/documentation/templates/toolingTemplate.d.ts.map +1 -0
  123. package/dist/generators/documentation/templates/toolingTemplate.js +56 -0
  124. package/dist/generators/documentation/templates/toolingTemplate.js.map +1 -0
  125. package/dist/generators/documentation/templates/types.d.ts +23 -0
  126. package/dist/generators/documentation/templates/types.d.ts.map +1 -0
  127. package/dist/generators/documentation/templates/types.js +3 -0
  128. package/dist/generators/documentation/templates/types.js.map +1 -0
  129. package/dist/generators/documentation/templates.d.ts +31 -0
  130. package/dist/generators/documentation/templates.d.ts.map +1 -0
  131. package/dist/generators/documentation/templates.js +566 -0
  132. package/dist/generators/documentation/templates.js.map +1 -0
  133. package/dist/generators/guidelines/agentIntegration.d.ts +43 -0
  134. package/dist/generators/guidelines/agentIntegration.d.ts.map +1 -0
  135. package/dist/generators/guidelines/agentIntegration.js +157 -0
  136. package/dist/generators/guidelines/agentIntegration.js.map +1 -0
  137. package/dist/generators/guidelines/guidelineTypes.d.ts +40 -0
  138. package/dist/generators/guidelines/guidelineTypes.d.ts.map +1 -0
  139. package/dist/generators/guidelines/guidelineTypes.js +144 -0
  140. package/dist/generators/guidelines/guidelineTypes.js.map +1 -0
  141. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts +30 -0
  142. package/dist/generators/guidelines/guidelinesAnalyzer.d.ts.map +1 -0
  143. package/dist/generators/guidelines/guidelinesAnalyzer.js +263 -0
  144. package/dist/generators/guidelines/guidelinesAnalyzer.js.map +1 -0
  145. package/dist/generators/guidelines/guidelinesGenerator.d.ts +30 -0
  146. package/dist/generators/guidelines/guidelinesGenerator.d.ts.map +1 -0
  147. package/dist/generators/guidelines/guidelinesGenerator.js +249 -0
  148. package/dist/generators/guidelines/guidelinesGenerator.js.map +1 -0
  149. package/dist/generators/guidelines/guidelinesTemplates.d.ts +23 -0
  150. package/dist/generators/guidelines/guidelinesTemplates.d.ts.map +1 -0
  151. package/dist/generators/guidelines/guidelinesTemplates.js +304 -0
  152. package/dist/generators/guidelines/guidelinesTemplates.js.map +1 -0
  153. package/dist/generators/guidelines/index.d.ts +6 -0
  154. package/dist/generators/guidelines/index.d.ts.map +1 -0
  155. package/dist/generators/guidelines/index.js +16 -0
  156. package/dist/generators/guidelines/index.js.map +1 -0
  157. package/dist/generators/moduleGrouper.d.ts +14 -0
  158. package/dist/generators/moduleGrouper.d.ts.map +1 -0
  159. package/dist/generators/moduleGrouper.js +82 -0
  160. package/dist/generators/moduleGrouper.js.map +1 -0
  161. package/dist/generators/plans/index.d.ts +2 -0
  162. package/dist/generators/plans/index.d.ts.map +1 -0
  163. package/dist/generators/plans/index.js +6 -0
  164. package/dist/generators/plans/index.js.map +1 -0
  165. package/dist/generators/plans/planGenerator.d.ts +22 -0
  166. package/dist/generators/plans/planGenerator.d.ts.map +1 -0
  167. package/dist/generators/plans/planGenerator.js +109 -0
  168. package/dist/generators/plans/planGenerator.js.map +1 -0
  169. package/dist/generators/plans/templates/indexTemplate.d.ts +3 -0
  170. package/dist/generators/plans/templates/indexTemplate.d.ts.map +1 -0
  171. package/dist/generators/plans/templates/indexTemplate.js +36 -0
  172. package/dist/generators/plans/templates/indexTemplate.js.map +1 -0
  173. package/dist/generators/plans/templates/planTemplate.d.ts +3 -0
  174. package/dist/generators/plans/templates/planTemplate.d.ts.map +1 -0
  175. package/dist/generators/plans/templates/planTemplate.js +83 -0
  176. package/dist/generators/plans/templates/planTemplate.js.map +1 -0
  177. package/dist/generators/plans/templates/types.d.ts +19 -0
  178. package/dist/generators/plans/templates/types.d.ts.map +1 -0
  179. package/dist/generators/plans/templates/types.js +3 -0
  180. package/dist/generators/plans/templates/types.js.map +1 -0
  181. package/dist/generators/projectAnalyzer.d.ts +14 -0
  182. package/dist/generators/projectAnalyzer.d.ts.map +1 -0
  183. package/dist/generators/projectAnalyzer.js +217 -0
  184. package/dist/generators/projectAnalyzer.js.map +1 -0
  185. package/dist/generators/shared/contextGenerator.d.ts +7 -0
  186. package/dist/generators/shared/contextGenerator.d.ts.map +1 -0
  187. package/dist/generators/shared/contextGenerator.js +13 -0
  188. package/dist/generators/shared/contextGenerator.js.map +1 -0
  189. package/dist/generators/shared/directoryTemplateHelpers.d.ts +2 -0
  190. package/dist/generators/shared/directoryTemplateHelpers.d.ts.map +1 -0
  191. package/dist/generators/shared/directoryTemplateHelpers.js +12 -0
  192. package/dist/generators/shared/directoryTemplateHelpers.js.map +1 -0
  193. package/dist/generators/shared/generatorUtils.d.ts +16 -0
  194. package/dist/generators/shared/generatorUtils.d.ts.map +1 -0
  195. package/dist/generators/shared/generatorUtils.js +119 -0
  196. package/dist/generators/shared/generatorUtils.js.map +1 -0
  197. package/dist/generators/shared/index.d.ts +4 -0
  198. package/dist/generators/shared/index.d.ts.map +1 -0
  199. package/dist/generators/shared/index.js +10 -0
  200. package/dist/generators/shared/index.js.map +1 -0
  201. package/dist/index.d.ts +6 -3
  202. package/dist/index.d.ts.map +1 -1
  203. package/dist/index.js +1327 -419
  204. package/dist/index.js.map +1 -1
  205. package/dist/utils/cliUI.d.ts +6 -4
  206. package/dist/utils/cliUI.d.ts.map +1 -1
  207. package/dist/utils/cliUI.js +71 -56
  208. package/dist/utils/cliUI.js.map +1 -1
  209. package/dist/utils/i18n.d.ts +181 -0
  210. package/dist/utils/i18n.d.ts.map +1 -0
  211. package/dist/utils/i18n.js +401 -0
  212. package/dist/utils/i18n.js.map +1 -0
  213. package/dist/utils/interactiveMode.d.ts +6 -1
  214. package/dist/utils/interactiveMode.d.ts.map +1 -1
  215. package/dist/utils/interactiveMode.js +375 -70
  216. package/dist/utils/interactiveMode.js.map +1 -1
  217. package/dist/utils/tokenEstimator.d.ts +10 -9
  218. package/dist/utils/tokenEstimator.d.ts.map +1 -1
  219. package/dist/utils/tokenEstimator.js +45 -109
  220. package/dist/utils/tokenEstimator.js.map +1 -1
  221. package/package.json +26 -23
  222. package/prompts/update_plan_prompt.md +42 -0
  223. package/prompts/update_scaffold_prompt.md +48 -0
  224. package/dist/generators/agentGenerator.d.ts +0 -23
  225. package/dist/generators/agentGenerator.d.ts.map +0 -1
  226. package/dist/generators/agentGenerator.js +0 -357
  227. package/dist/generators/agentGenerator.js.map +0 -1
  228. package/dist/generators/documentationGenerator.d.ts +0 -40
  229. package/dist/generators/documentationGenerator.d.ts.map +0 -1
  230. package/dist/generators/documentationGenerator.js +0 -786
  231. package/dist/generators/documentationGenerator.js.map +0 -1
  232. package/dist/generators/incrementalDocumentationGenerator.d.ts.map +0 -1
  233. package/dist/generators/incrementalDocumentationGenerator.js.map +0 -1
  234. /package/dist/generators/{incrementalDocumentationGenerator.js β†’ documentation/incrementalDocumentationGenerator.js} +0 -0
package/README.md CHANGED
@@ -4,655 +4,188 @@
4
4
  [![CI](https://github.com/vinilana/ai-coders-context/actions/workflows/ci.yml/badge.svg)](https://github.com/vinilana/ai-coders-context/actions/workflows/ci.yml)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
 
7
- > ⚠️ **Beta Release**: This tool is in early development (v0.x). APIs and features may change.
7
+ A lightweight CLI that scaffolds living documentation and AI-agent playbooks for any repositoryβ€”no LLMs or API keys required. The generated structure gives teams a consistent starting point for knowledge sharing while keeping everything under version control.
8
8
 
9
- A powerful CLI tool that analyzes your codebase and generates comprehensive documentation and AI agent prompts using LLM APIs. Features intelligent incremental updates, cost estimation, and support for multiple LLM providers.
9
+ ## βš™οΈ Requirements
10
10
 
11
- ## ✨ Features
11
+ - Node.js 20+ (we currently test on 20, 22, 23, and 24)
12
12
 
13
- - πŸ” **Repository Analysis**: Maps and analyzes your entire codebase structure with token estimation
14
- - πŸ“š **Documentation Generation**: Creates comprehensive, module-based documentation
15
- - πŸ”„ **Incremental Updates**: Smart git-based updates that only process changed files
16
- - πŸ‘€ **Preview Mode**: See what would change before running expensive operations
17
- - πŸ€– **AI Agent Prompts**: Generates specialized prompts for different development tasks
18
- - 🌐 **Multi-Provider Support**: Works with OpenRouter, OpenAI, Anthropic, Google AI, and Grok
19
- - πŸ’° **Cost Tracking**: Real-time token usage and precise cost estimation across models
20
- - 🎯 **Smart Filtering**: Intelligent file filtering and module organization
21
- - πŸš€ **CI/CD Ready**: Perfect for automated documentation workflows and pre-commit hooks
13
+ ## ✨ What You Get
22
14
 
23
- ## πŸ“¦ Installation
24
-
25
- ### Using npx (Recommended)
15
+ - πŸ“š `docs/` folder with a documentation index plus ready-to-edit guides (overview, architecture, workflow, testing)
16
+ - πŸ€– `agents/` folder containing playbooks for common engineering agents and a handy index
17
+ - πŸ” Repeatable scaffolding that you can re-run as the project evolves
18
+ - 🧭 Repository-aware templates that highlight top-level directories for quick orientation
19
+ - 🧠 AI-ready front matter and `ai-task` markers so assistants know exactly what to refresh
26
20
 
27
- ```bash
28
- # Run directly without installation
29
- npx @ai-coders/context analyze /path/to/your/repo
30
- ```
21
+ ## πŸ“¦ Installation
31
22
 
32
- ### Global Installation
23
+ Use `npx` to run the CLI without installing globally:
33
24
 
34
25
  ```bash
35
- npm install -g @ai-coders/context
26
+ npx @ai-coders/context init /path/to/repo
36
27
  ```
37
28
 
38
- ### Local Development
29
+ Or add it to your dev dependencies:
39
30
 
40
31
  ```bash
41
- git clone https://github.com/vinilana/ai-coders-context.git
42
- cd ai-coders-context
43
- npm install
44
- npm run build
45
- npm link
32
+ npm install --save-dev @ai-coders/context
46
33
  ```
47
34
 
48
35
  ## πŸš€ Quick Start
49
36
 
50
- ### 1. Set Up API Key
51
-
52
- Choose your preferred LLM provider and set the API key:
53
-
54
- ```bash
55
- # OpenRouter (Recommended - access to 100+ models)
56
- export OPENROUTER_API_KEY=your_key_here
57
-
58
- # Or use other providers
59
- export OPENAI_API_KEY=your_key_here
60
- export ANTHROPIC_API_KEY=your_key_here
61
- export GOOGLE_AI_API_KEY=your_key_here
62
- export GROK_API_KEY=your_key_here
63
- ```
64
-
65
- ### 2. Analyze Your Repository
66
-
67
- ```bash
68
- # Get cost estimates and repository analysis
69
- npx @ai-coders/context analyze /path/to/your/repo
70
- ```
71
-
72
- ### 3. Generate Initial Documentation
73
-
74
- ```bash
75
- # Create comprehensive documentation and agent prompts
76
- npx @ai-coders/context generate /path/to/your/repo
77
- ```
78
-
79
- ### 4. Update Documentation (Incremental)
80
-
81
- ```bash
82
- # Update only changed files since last run
83
- npx @ai-coders/context update /path/to/your/repo
84
-
85
- # Preview changes before updating
86
- npx @ai-coders/context preview /path/to/your/repo
87
- ```
88
-
89
- ## πŸ“‹ Commands
90
-
91
- ### `analyze` - Repository Analysis & Cost Estimation
92
-
93
- Analyzes your repository structure and provides detailed cost estimates for documentation generation.
94
-
95
- ```bash
96
- npx @ai-coders/context analyze /path/to/repo [options]
97
-
98
- Options:
99
- --exclude <patterns...> Patterns to exclude from analysis
100
- --include <patterns...> Patterns to include in analysis
101
- -v, --verbose Show detailed file breakdown
102
- ```
103
-
104
- **Example Output:**
105
- ```
106
- πŸ“Š Token Usage Estimate for Full Documentation Generation:
107
- ═══════════════════════════════════════════════════════════
108
-
109
- πŸ“ Files to Process: 247
110
- πŸ”€ Estimated Input Tokens: 156,500
111
- πŸ“ Estimated Output Tokens: 62,600
112
- 🎯 Total Estimated Tokens: 219,100
113
-
114
- πŸ’° Cost Estimates by Model:
115
- Llama 3.1 8B (OpenRouter) | Input: $0.01 | Output: $0.01 | Total: $0.02
116
- Gemini 1.5 Flash (Google AI) | Input: $0.01 | Output: $0.02 | Total: $0.03
117
- GPT-4o Mini (OpenRouter) | Input: $0.02 | Output: $0.04 | Total: $0.06
118
- Claude 3 Haiku (OpenRouter) | Input: $0.04 | Output: $0.08 | Total: $0.12
119
- ```
120
-
121
- ### `generate` - Initial Documentation Generation
122
-
123
- Creates comprehensive documentation and AI agent prompts for your entire repository.
124
-
125
- ```bash
126
- npx @ai-coders/context generate /path/to/repo [options]
127
-
128
- Options:
129
- -o, --output <dir> Output directory (default: "./.context")
130
- -k, --api-key <key> API key for the LLM provider
131
- -m, --model <model> LLM model to use (default: "google/gemini-2.5-flash-preview-05-20")
132
- -p, --provider <provider> LLM provider (openrouter, openai, anthropic, gemini, grok)
133
- --exclude <patterns...> Patterns to exclude from analysis
134
- --include <patterns...> Patterns to include in analysis
135
- --docs-only Generate only documentation (skip agent prompts)
136
- --agents-only Generate only agent prompts (skip documentation)
137
- -v, --verbose Verbose output with detailed progress
138
- ```
139
-
140
- ### `update` - Incremental Documentation Updates
141
-
142
- Updates documentation only for files that have changed since the last documented commit.
143
-
144
37
  ```bash
145
- npx @ai-coders/context update /path/to/repo [options]
38
+ # Scaffold docs and agents into ./.context
39
+ npx @ai-coders/context init ./my-repo
146
40
 
147
- Options:
148
- -o, --output <dir> Output directory (default: "./.context")
149
- -k, --api-key <key> API key for the LLM provider
150
- -m, --model <model> LLM model to use
151
- -p, --provider <provider> LLM provider
152
- --since <commit> Compare against specific commit/branch
153
- --staged Only process staged files (for pre-commit hooks)
154
- --force Force regeneration even if no changes detected
155
- --exclude <patterns...> Patterns to exclude from analysis
156
- --include <patterns...> Patterns to include in analysis
157
- -v, --verbose Verbose output with commit tracking info
158
- ```
41
+ # Only generate docs
42
+ npx @ai-coders/context init ./my-repo docs
159
43
 
160
- ### `preview` - Preview Changes
44
+ # Only generate agent playbooks, with a custom output directory
45
+ npx @ai-coders/context init ./my-repo agents --output ./knowledge-base
161
46
 
162
- Shows what documentation updates would be made without actually making changes. Includes cost estimates for the affected files.
47
+ # Fill docs and agents with the repo context (preview the first 3 updates)
48
+ npx @ai-coders/context fill ./my-repo --output ./.context --dry-run --limit 3
163
49
 
164
- ```bash
165
- npx @ai-coders/context preview /path/to/repo [options]
50
+ # Draft a collaboration plan seeded with agent and doc touchpoints
51
+ npx @ai-coders/context plan release-readiness --output ./.context
166
52
 
167
- Options:
168
- --since <commit> Compare against specific commit/branch
169
- --staged Only analyze staged files
170
- --exclude <patterns...> Patterns to exclude from analysis
171
- --include <patterns...> Patterns to include in analysis
172
- -v, --verbose Show detailed file change lists and debug info
53
+ # Let the LLM enrich an existing plan with the latest context
54
+ npx @ai-coders/context plan release-readiness --output ./.context --fill --dry-run
173
55
  ```
174
56
 
175
- ## 🎯 Workflow Examples
176
-
177
- ### Initial Setup Workflow
178
-
179
- ```bash
180
- # 1. Analyze repository and get cost estimates
181
- npx @ai-coders/context analyze ./my-project
182
-
183
- # 2. Generate initial documentation
184
- npx @ai-coders/context generate ./my-project
185
-
186
- # 3. Check what the output looks like
187
- ls .context/
188
- ```
189
-
190
- ### Daily Development Workflow
191
-
192
- ```bash
193
- # Preview what would be updated
194
- npx @ai-coders/context preview ./my-project
195
-
196
- # Update documentation for changed files
197
- npx @ai-coders/context update ./my-project -v
198
-
199
- # Or update since a specific commit
200
- npx @ai-coders/context update ./my-project --since HEAD~3
201
- ```
202
-
203
- ### Pre-commit Hook Integration
204
-
205
- ```bash
206
- # Update only staged files (perfect for pre-commit hooks)
207
- npx @ai-coders/context update ./my-project --staged
208
-
209
- # Preview staged changes
210
- npx @ai-coders/context preview ./my-project --staged
211
- ```
212
-
213
- ### CI/CD Integration
214
-
215
- ```bash
216
- # Update documentation in CI for main branch changes
217
- npx @ai-coders/context update . \
218
- --provider openrouter \
219
- --model google/gemini-2.5-flash-preview-05-20 \
220
- --verbose
221
- ```
222
-
223
- ## πŸ—οΈ Output Structure
224
-
225
- The tool generates documentation in the `.context` directory:
57
+ After running the command, inspect the generated structure:
226
58
 
227
59
  ```
228
60
  .context/
229
- β”œβ”€β”€ docs/ # Generated documentation
230
- β”‚ β”œβ”€β”€ README.md # Project overview
231
- β”‚ β”œβ”€β”€ STRUCTURE.md # Repository structure
232
- β”‚ β”œβ”€β”€ DEVELOPMENT.md # Development guide
233
- β”‚ β”œβ”€β”€ API.md # API documentation
234
- β”‚ β”œβ”€β”€ DEPLOYMENT.md # Deployment guide
235
- β”‚ β”œβ”€β”€ TROUBLESHOOTING.md # Troubleshooting guide
236
- β”‚ └── modules/ # Module-specific documentation
237
- β”‚ β”œβ”€β”€ auth/ # Auth module docs
238
- β”‚ β”œβ”€β”€ api/ # API module docs
239
- β”‚ └── utils/ # Utils module docs
240
- └── agents/ # AI agent prompts
241
- β”œβ”€β”€ README.md # Agent index
242
- β”œβ”€β”€ code-reviewer.md # Code review specialist
243
- β”œβ”€β”€ bug-fixer.md # Bug fixing specialist
244
- β”œβ”€β”€ feature-developer.md # Feature development specialist
245
- β”œβ”€β”€ refactoring-specialist.md
246
- β”œβ”€β”€ test-writer.md
247
- β”œβ”€β”€ documentation-writer.md
248
- β”œβ”€β”€ performance-optimizer.md
249
- └── security-auditor.md
250
-
251
- # State tracking
252
- context-log.json # Tracks last processed commit
253
- ```
254
-
255
- ## πŸ”§ LLM Provider Configuration
256
-
257
- ### OpenRouter (Recommended)
258
-
259
- Access to 100+ models from different providers with competitive pricing:
260
-
261
- ```bash
262
- export OPENROUTER_API_KEY=your_api_key_here
263
-
264
- # Use specific models
265
- npx @ai-coders/context generate . -m google/gemini-2.5-flash-preview-05-20 # Fast & cheap
266
- npx @ai-coders/context generate . -m anthropic/claude-3-sonnet # Balanced
267
- npx @ai-coders/context generate . -m openai/gpt-4 # High quality
268
- ```
269
-
270
- ### Direct Provider Access
271
-
272
- ```bash
273
- # OpenAI
274
- export OPENAI_API_KEY=your_key
275
- npx @ai-coders/context generate . -p openai -m gpt-4o
276
-
277
- # Anthropic
278
- export ANTHROPIC_API_KEY=your_key
279
- npx @ai-coders/context generate . -p anthropic -m claude-3-sonnet-20240229
280
-
281
- # Google AI
282
- export GOOGLE_AI_API_KEY=your_key
283
- npx @ai-coders/context generate . -p gemini -m gemini-1.5-pro
284
-
285
- # Grok
286
- export GROK_API_KEY=your_key
287
- npx @ai-coders/context generate . -p grok -m grok-beta
61
+ β”œβ”€β”€ agents/
62
+ β”‚ β”œβ”€β”€ README.md
63
+ β”‚ β”œβ”€β”€ code-reviewer.md
64
+ β”‚ └── ...
65
+ └── docs/
66
+ β”œβ”€β”€ README.md
67
+ β”œβ”€β”€ architecture.md
68
+ └── ...
288
69
  ```
289
70
 
290
- ## πŸ’° Cost Management
71
+ Customize the Markdown files to reflect your project’s specifics and commit them alongside the code.
291
72
 
292
- ### Model Selection by Cost
73
+ ## 🧠 Guided Updates for AI Assistants
293
74
 
294
- **Ultra Low Cost:**
295
- - Llama 3.1 8B (OpenRouter): ~$0.05 per 1M tokens
296
- - Gemini 1.5 Flash: ~$0.075 per 1M tokens
75
+ Need help filling in the scaffold? Use [`prompts/update_scaffold_prompt.md`](./prompts/update_scaffold_prompt.md) as the canonical instruction set for any LLM or CLI agent. It walks through:
297
76
 
298
- **Low Cost:**
299
- - GPT-4o Mini: ~$0.15 per 1M tokens
300
- - Claude 3 Haiku: ~$0.25 per 1M tokens
77
+ - Gathering repository context and locating `ai-task`/`ai-slot` markers.
78
+ - Updating documentation sections while satisfying the YAML front matter criteria.
79
+ - Aligning agent playbooks with the refreshed docs and recording evidence for maintainers.
301
80
 
302
- **Balanced:**
303
- - Gemini 1.5 Pro: ~$1.25 per 1M tokens
304
- - GPT-4o: ~$2.50 per 1M tokens
305
- - Claude 3.5 Sonnet: ~$3.00 per 1M tokens
81
+ Share that prompt verbatim with your assistant to keep updates consistent across teams.
306
82
 
307
- **High Quality:**
308
- - GPT-4 Turbo: ~$10.00 per 1M tokens
309
- - Grok Beta: ~$5.00 per 1M tokens
83
+ ### Available Doc Keys & Agent Types
310
84
 
311
- ### Cost Estimation Features
85
+ Pass these values to `--docs` / `--agents` (or pick them interactively):
312
86
 
313
- - **Pre-generation estimates**: Always run `analyze` first to see costs
314
- - **Preview mode**: See exactly what files will be processed
315
- - **Incremental updates**: Only pay for changed files
316
- - **Provider comparison**: Compare costs across all supported models
87
+ - Docs: `project-overview`, `architecture`, `development-workflow`, `testing-strategy`, `glossary`, `data-flow`, `security`, `tooling`
88
+ - Agents: `code-reviewer`, `bug-fixer`, `feature-developer`, `refactoring-specialist`, `test-writer`, `documentation-writer`, `performance-optimizer`, `security-auditor`, `backend-specialist`, `frontend-specialist`, `architect-specialist`
317
89
 
318
- ## πŸŽ›οΈ Advanced Configuration
90
+ ## πŸ›  Commands
319
91
 
320
- ### Filtering Options
92
+ ### `init`
93
+ Scaffold documentation and/or agent playbooks.
321
94
 
322
- ```bash
323
- # Exclude specific file types and directories
324
- npx @ai-coders/context generate . \
325
- --exclude "**/*.test.*" "node_modules/**" "dist/**" "*.log"
326
-
327
- # Include only source code
328
- npx @ai-coders/context generate . \
329
- --include "src/**" "lib/**" "packages/**"
330
-
331
- # Complex filtering
332
- npx @ai-coders/context generate . \
333
- --include "src/**" \
334
- --exclude "src/**/*.test.*" "src/legacy/**"
335
95
  ```
96
+ Usage: ai-context init <repo-path> [type]
336
97
 
337
- ### Environment Configuration
338
-
339
- Create a `.env` file in your project:
340
-
341
- ```bash
342
- # .env
343
- OPENROUTER_API_KEY=your_key_here
344
- DEFAULT_MODEL=google/gemini-2.5-flash-preview-05-20
345
- OUTPUT_DIR=./.context
346
- ```
98
+ Arguments:
99
+ repo-path Path to the repository you want to scan
100
+ type "docs", "agents", or "both" (default)
347
101
 
348
- ### Model-Specific Options
349
-
350
- ```bash
351
- # Use high-quality model for important documentation
352
- npx @ai-coders/context generate . \
353
- --model anthropic/claude-3-opus \
354
- --docs-only
355
-
356
- # Use fast model for regular updates
357
- npx @ai-coders/context update . \
358
- --model google/gemini-2.5-flash-preview-05-20
102
+ Options:
103
+ -o, --output <dir> Output directory (default: ./.context)
104
+ --docs <keys...> Doc keys to scaffold (e.g., project-overview, security)
105
+ --agents <keys...> Agent types to scaffold (e.g., code-reviewer, feature-developer)
106
+ --exclude <patterns...> Glob patterns to skip during the scan
107
+ --include <patterns...> Glob patterns to explicitly include
108
+ -v, --verbose Print detailed progress information
109
+ -h, --help Display help for command
359
110
  ```
360
111
 
361
- ## πŸ”„ Git Integration & State Tracking
362
-
363
- ### How It Works
112
+ ### `scaffold`
113
+ Alias for `init`. Use whichever verb fits your workflow.
364
114
 
365
- The tool uses Git to track which commits have been documented:
115
+ ### `fill`
116
+ Use an LLM to refresh scaffolded docs and agent playbooks automatically.
366
117
 
367
- 1. **State File**: `context-log.json` tracks the last processed commit
368
- 2. **Change Detection**: Compares current HEAD with last processed commit
369
- 3. **Smart Updates**: Only processes files affected by changes
370
- 4. **Commit Validation**: Handles rebases and history changes gracefully
371
-
372
- ### Commit Tracking Features
373
-
374
- ```bash
375
- # See commit tracking info in verbose mode
376
- npx @ai-coders/context update . -v
377
-
378
- # Output includes:
379
- # πŸ” Commit Tracking Information:
380
- # Last documented: abc1234 - feat: add user authentication
381
- # Current commit: def5678 - fix: handle edge case in validation
382
- # Commits to process: 3
383
118
  ```
119
+ Usage: ai-context fill <repo-path>
384
120
 
385
- ### Handling Different Scenarios
386
-
387
- ```bash
388
- # Update from specific commit
389
- npx @ai-coders/context update . --since abc1234
390
-
391
- # Force full regeneration
392
- npx @ai-coders/context update . --force
393
-
394
- # Work with staged files (pre-commit)
395
- npx @ai-coders/context update . --staged
396
- ```
397
-
398
- ## πŸš€ Pre-commit Hook Setup
399
-
400
- Automatically update documentation when committing code changes:
401
-
402
- ### 1. Create Pre-commit Hook
403
-
404
- ```bash
405
- # Create the hook file
406
- cat > .git/hooks/pre-commit << 'EOF'
407
- #!/bin/bash
408
- set -e
409
-
410
- echo "πŸ” AI Coders Context: Checking for documentation updates..."
411
-
412
- # Check if there are staged files that need documentation updates
413
- STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(ts|js|py|java|cpp|c|h|css|scss|html|xml|json|yaml|yml|md|txt|sql|sh|bat|ps1|php|rb|go|rs|swift|kt|scala|r|m|pl|lua|vim)$' || true)
414
-
415
- if [ -z "$STAGED_FILES" ]; then
416
- echo "βœ… No relevant files staged for commit"
417
- exit 0
418
- fi
419
-
420
- echo "πŸ“ Found staged files that may need documentation updates:"
421
- echo "$STAGED_FILES" | sed 's/^/ - /'
422
-
423
- # Update documentation for staged files only
424
- echo "πŸ“š Updating documentation for staged files..."
425
- npx @ai-coders/context update . \
426
- --staged \
427
- --model google/gemini-2.5-flash-preview-05-20 \
428
- --verbose || {
429
- echo "❌ Documentation update failed. Commit aborted."
430
- exit 1
431
- }
432
-
433
- # Check if documentation was updated
434
- if git diff --quiet .context/docs/; then
435
- echo "βœ… Documentation is up to date"
436
- else
437
- echo "πŸ“ Documentation updated. Adding to commit..."
438
- git add .context/docs/
439
- echo "βœ… Documentation changes added to commit"
440
- fi
441
-
442
- echo "πŸŽ‰ Pre-commit documentation check complete!"
443
- exit 0
444
- EOF
445
-
446
- # Make it executable
447
- chmod +x .git/hooks/pre-commit
121
+ Options:
122
+ -o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
123
+ -k, --api-key <key> API key for the selected LLM provider
124
+ -m, --model <model> LLM model to use (default: google/gemini-2.5-flash-preview-05-20)
125
+ -p, --provider <name> Provider (openrouter, openai, anthropic, gemini, grok)
126
+ --prompt <file> Instruction prompt to follow (default: prompts/update_scaffold_prompt.md)
127
+ --docs <keys...> Doc keys to update (default: all)
128
+ --agents <keys...> Agent types to update (default: all)
129
+ --dry-run Preview changes without writing files
130
+ --all Process every Markdown file even if no TODO markers remain
131
+ --limit <number> Maximum number of files to update in one run
132
+ -h, --help Display help for command
448
133
  ```
449
134
 
450
- ### 2. Test the Hook
135
+ Under the hood, the command loads the prompt above, scans for `ai-task` or `ai-slot` markers, and asks the LLM to produce the fully updated Markdown. Combine it with `--dry-run` to review responses before committing.
451
136
 
452
- ```bash
453
- # Stage some files and commit
454
- git add src/my-changes.ts
455
- git commit -m "feat: add new feature"
456
-
457
- # The hook will automatically:
458
- # 1. Detect staged files
459
- # 2. Update relevant documentation
460
- # 3. Add updated docs to the commit
461
- ```
137
+ ### `plan`
138
+ Create a collaboration plan that links documentation guides and agent playbooks, or fill an existing plan with LLM assistance.
462
139
 
463
- ## 🏒 CI/CD Integration
464
-
465
- ### GitHub Actions Example
466
-
467
- ```yaml
468
- # .github/workflows/docs-update.yml
469
- name: Update Documentation
470
-
471
- on:
472
- push:
473
- branches: [ main, develop ]
474
- paths:
475
- - 'src/**'
476
- - 'lib/**'
477
- - '*.md'
478
- - '*.json'
479
- - '*.ts'
480
- - '*.js'
481
-
482
- jobs:
483
- update-docs:
484
- runs-on: ubuntu-latest
485
-
486
- steps:
487
- - uses: actions/checkout@v4
488
- with:
489
- fetch-depth: 0 # Need full history for git diff
490
-
491
- - name: Use Node.js
492
- uses: actions/setup-node@v4
493
- with:
494
- node-version: '20.x'
495
- cache: 'npm'
496
-
497
- - name: Update Documentation
498
- run: |
499
- npx @ai-coders/context update . \
500
- --provider openrouter \
501
- --model google/gemini-2.5-flash-preview-05-20 \
502
- --verbose
503
- env:
504
- OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
505
-
506
- - name: Commit documentation updates
507
- run: |
508
- git config user.name "docs-bot"
509
- git config user.email "docs-bot@github.com"
510
-
511
- if ! git diff --quiet .context/docs/; then
512
- git add .context/docs/
513
- git commit -m "docs: update documentation for changed files
514
-
515
- Auto-generated by AI Coders Context"
516
- git push
517
- fi
518
140
  ```
141
+ Usage: ai-context plan <plan-name>
519
142
 
520
- ## πŸ› οΈ Troubleshooting
521
-
522
- ### Common Issues
523
-
524
- **"No documentation context found"**
525
- ```bash
526
- # Run these commands in order:
527
- npx @ai-coders/context analyze .
528
- npx @ai-coders/context generate .
529
- npx @ai-coders/context preview . # Now this will work
143
+ Options:
144
+ -o, --output <dir> Scaffold directory containing docs/ and agents/ (default: ./.context)
145
+ --title <title> Custom title for the plan document
146
+ --summary <text> Seed the plan with a short summary or goal statement
147
+ --agents <types...> Agent playbooks to highlight (default: all)
148
+ --docs <keys...> Documentation guides to reference (default: all)
149
+ -f, --force Overwrite the plan if it already exists (scaffold mode)
150
+ --fill Use an LLM to fill or update the plan instead of scaffolding
151
+ -r, --repo <path> Repository root to summarize for additional context (fill mode)
152
+ -k, --api-key <key> API key for the selected LLM provider (fill mode)
153
+ -m, --model <model> LLM model to use (default: x-ai/grok-4-fast:free)
154
+ -p, --provider <name> Provider (openrouter, openai, anthropic, gemini, grok)
155
+ --base-url <url> Custom base URL for provider APIs
156
+ --prompt <file> Instruction prompt to follow (default: prompts/update_plan_prompt.md)
157
+ --dry-run Preview changes without writing files
158
+ --include <patterns...> Glob patterns to include during repository analysis
159
+ --exclude <patterns...> Glob patterns to exclude from repository analysis
160
+ -h, --help Display help for command
530
161
  ```
531
162
 
532
- **"API key not found"**
533
- ```bash
534
- # Set your API key
535
- export OPENROUTER_API_KEY=your_key_here
163
+ In scaffold mode the command creates `.context/plans/<plan-name>.md`, keeps a `plans/README.md` index, and reminds contributors to consult the agent handbook before delegating work to an AI assistant. In fill mode it will scaffold the plan automatically if it does not exist, then read the plan plus its referenced docs and agent playbooks, send that context to the LLM, and either preview or write the updated Markdown.
536
164
 
537
- # Or pass it directly
538
- npx @ai-coders/context generate . --api-key your_key_here
539
- ```
165
+ πŸ’‘ Tip: run `npx @ai-coders/context` with no arguments to enter an interactive mode that guides you through scaffold and LLM-fill options.
540
166
 
541
- **"No changes detected"**
542
- ```bash
543
- # Force regeneration
544
- npx @ai-coders/context update . --force
167
+ Prefer driving the update elsewhere? Just grab [`prompts/update_scaffold_prompt.md`](./prompts/update_scaffold_prompt.md) and run it in your favorite playground or agent host. When you’re ready to automate, drop your API key in `.env` (for example `OPENROUTER_API_KEY` and `OPENROUTER_MODEL`) and let `fill` handle the edits inline.
545
168
 
546
- # Or check what's being tracked
547
- npx @ai-coders/context update . -v
548
- ```
169
+ ## 🧰 Local Development
549
170
 
550
- **High costs**
551
171
  ```bash
552
- # Use cost-effective models
553
- npx @ai-coders/context generate . --model google/gemini-2.5-flash-preview-05-20
554
-
555
- # Preview costs first
556
- npx @ai-coders/context analyze .
557
-
558
- # Use incremental updates
559
- npx @ai-coders/context update . # Only processes changed files
172
+ git clone https://github.com/vinilana/ai-coders-context.git
173
+ cd ai-coders-context
174
+ npm install
175
+ npm run build
176
+ npm run test
560
177
  ```
561
178
 
562
- ### Debug Mode
179
+ During development you can run the CLI directly against TypeScript sources:
563
180
 
564
181
  ```bash
565
- # Enable verbose output for detailed debugging
566
- npx @ai-coders/context update . -v
567
-
568
- # This shows:
569
- # - Commit tracking information
570
- # - File change analysis
571
- # - Token estimation details
572
- # - Processing progress
182
+ npm run dev -- ./path/to/repo
573
183
  ```
574
184
 
575
- ## πŸ“š Available Agent Types
576
-
577
- The tool generates specialized AI agent prompts for different development tasks:
578
-
579
- - **πŸ” Code Reviewer**: Reviews code for quality, best practices, and potential issues
580
- - **πŸ› Bug Fixer**: Analyzes and fixes bugs with step-by-step debugging
581
- - **⚑ Feature Developer**: Implements new features following project patterns
582
- - **πŸ”§ Refactoring Specialist**: Improves code structure and maintainability
583
- - **πŸ§ͺ Test Writer**: Creates comprehensive test suites
584
- - **πŸ“ Documentation Writer**: Maintains and improves documentation
585
- - **πŸš€ Performance Optimizer**: Identifies and fixes performance bottlenecks
586
- - **πŸ”’ Security Auditor**: Identifies security vulnerabilities and fixes
587
-
588
- ## πŸ“Š Supported File Types
589
-
590
- The tool automatically detects and processes these file types:
591
-
592
- **Programming Languages:**
593
- - JavaScript/TypeScript (`.js`, `.ts`, `.jsx`, `.tsx`)
594
- - Python (`.py`)
595
- - Java (`.java`)
596
- - C/C++ (`.c`, `.cpp`, `.h`)
597
- - Go (`.go`)
598
- - Rust (`.rs`)
599
- - Swift (`.swift`)
600
- - Kotlin (`.kt`)
601
- - Scala (`.scala`)
602
- - PHP (`.php`)
603
- - Ruby (`.rb`)
604
-
605
- **Configuration & Data:**
606
- - JSON (`.json`)
607
- - YAML (`.yaml`, `.yml`)
608
- - XML (`.xml`)
609
- - SQL (`.sql`)
610
-
611
- **Web Technologies:**
612
- - HTML (`.html`)
613
- - CSS/SCSS (`.css`, `.scss`, `.sass`)
614
-
615
- **Documentation:**
616
- - Markdown (`.md`)
617
- - Text files (`.txt`)
618
-
619
- **Scripts:**
620
- - Shell scripts (`.sh`)
621
- - Batch files (`.bat`)
622
- - PowerShell (`.ps1`)
623
-
624
185
  ## 🀝 Contributing
625
186
 
626
- 1. Fork the repository
627
- 2. Create a feature branch: `git checkout -b feature/amazing-feature`
628
- 3. Make your changes
629
- 4. Add tests if applicable
630
- 5. Commit your changes: `git commit -m 'feat: add amazing feature'`
631
- 6. Push to the branch: `git push origin feature/amazing-feature`
632
- 7. Submit a pull request
633
-
634
- ### Development Setup
635
-
636
- ```bash
637
- git clone https://github.com/vinilana/ai-coders-context.git
638
- cd ai-coders-context
639
- npm install
640
- npm run dev # Development mode with auto-reload
641
- npm run build # Build for production
642
- npm test # Run tests
643
- ```
187
+ See [`AGENTS.md`](./AGENTS.md) for contributor guidelines, coding standards, and release tips. Pull requests are welcome!
644
188
 
645
189
  ## πŸ“„ License
646
190
 
647
- MIT License - see [LICENSE](LICENSE) file for details.
648
-
649
- ## πŸ†˜ Support
650
-
651
- - πŸ› [Report bugs](https://github.com/vinilana/ai-coders-context/issues)
652
- - πŸ’‘ [Request features](https://github.com/vinilana/ai-coders-context/issues)
653
- - πŸ“– [Documentation](https://github.com/vinilana/ai-coders-context/wiki)
654
- - πŸ’¬ [Discussions](https://github.com/vinilana/ai-coders-context/discussions)
655
-
656
- ---
657
-
658
- Made with ❀️ by the AI Coders Academy - https://aicoders.academy
191
+ MIT Β© VinΓ­cius Lana