@codemieai/code 0.0.33 → 0.0.35

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 (294) hide show
  1. package/README.md +78 -7
  2. package/bin/codemie-claude-acp.js +21 -0
  3. package/bin/codemie-opencode.js +11 -0
  4. package/bin/codemie.js +13 -0
  5. package/dist/agents/codemie-code/agent.d.ts +38 -4
  6. package/dist/agents/codemie-code/agent.d.ts.map +1 -1
  7. package/dist/agents/codemie-code/agent.js +333 -178
  8. package/dist/agents/codemie-code/agent.js.map +1 -1
  9. package/dist/agents/codemie-code/index.d.ts +2 -1
  10. package/dist/agents/codemie-code/index.d.ts.map +1 -1
  11. package/dist/agents/codemie-code/index.js +36 -7
  12. package/dist/agents/codemie-code/index.js.map +1 -1
  13. package/dist/agents/codemie-code/prompts.d.ts +12 -5
  14. package/dist/agents/codemie-code/prompts.d.ts.map +1 -1
  15. package/dist/agents/codemie-code/prompts.js +53 -6
  16. package/dist/agents/codemie-code/prompts.js.map +1 -1
  17. package/dist/agents/codemie-code/toolMetadata.d.ts.map +1 -1
  18. package/dist/agents/codemie-code/toolMetadata.js +9 -8
  19. package/dist/agents/codemie-code/toolMetadata.js.map +1 -1
  20. package/dist/agents/codemie-code/tools/assistant-invocation.d.ts +47 -0
  21. package/dist/agents/codemie-code/tools/assistant-invocation.d.ts.map +1 -0
  22. package/dist/agents/codemie-code/tools/assistant-invocation.js +129 -0
  23. package/dist/agents/codemie-code/tools/assistant-invocation.js.map +1 -0
  24. package/dist/agents/codemie-code/tools/index.d.ts +70 -4
  25. package/dist/agents/codemie-code/tools/index.d.ts.map +1 -1
  26. package/dist/agents/codemie-code/tools/index.js +57 -44
  27. package/dist/agents/codemie-code/tools/index.js.map +1 -1
  28. package/dist/agents/codemie-code/tools/planning.d.ts +6 -5
  29. package/dist/agents/codemie-code/tools/planning.d.ts.map +1 -1
  30. package/dist/agents/codemie-code/tools/planning.js +12 -10
  31. package/dist/agents/codemie-code/tools/planning.js.map +1 -1
  32. package/dist/agents/codemie-code/types.d.ts +27 -3
  33. package/dist/agents/codemie-code/types.d.ts.map +1 -1
  34. package/dist/agents/codemie-code/types.js +24 -0
  35. package/dist/agents/codemie-code/types.js.map +1 -1
  36. package/dist/agents/codemie-code/ui/autocomplete.d.ts +98 -0
  37. package/dist/agents/codemie-code/ui/autocomplete.d.ts.map +1 -0
  38. package/dist/agents/codemie-code/ui/autocomplete.js +145 -0
  39. package/dist/agents/codemie-code/ui/autocomplete.js.map +1 -0
  40. package/dist/agents/codemie-code/ui/keyHandlers.d.ts +112 -0
  41. package/dist/agents/codemie-code/ui/keyHandlers.d.ts.map +1 -0
  42. package/dist/agents/codemie-code/ui/keyHandlers.js +415 -0
  43. package/dist/agents/codemie-code/ui/keyHandlers.js.map +1 -0
  44. package/dist/agents/codemie-code/ui/mentions.d.ts +86 -0
  45. package/dist/agents/codemie-code/ui/mentions.d.ts.map +1 -0
  46. package/dist/agents/codemie-code/ui/mentions.js +122 -0
  47. package/dist/agents/codemie-code/ui/mentions.js.map +1 -0
  48. package/dist/agents/codemie-code/ui/terminalCodes.d.ts +38 -0
  49. package/dist/agents/codemie-code/ui/terminalCodes.d.ts.map +1 -0
  50. package/dist/agents/codemie-code/ui/terminalCodes.js +42 -0
  51. package/dist/agents/codemie-code/ui/terminalCodes.js.map +1 -0
  52. package/dist/agents/codemie-code/ui/todoPanel.d.ts.map +1 -1
  53. package/dist/agents/codemie-code/ui/todoPanel.js +3 -4
  54. package/dist/agents/codemie-code/ui/todoPanel.js.map +1 -1
  55. package/dist/agents/codemie-code/ui.d.ts +8 -7
  56. package/dist/agents/codemie-code/ui.d.ts.map +1 -1
  57. package/dist/agents/codemie-code/ui.js +87 -145
  58. package/dist/agents/codemie-code/ui.js.map +1 -1
  59. package/dist/agents/core/AgentCLI.d.ts +5 -0
  60. package/dist/agents/core/AgentCLI.d.ts.map +1 -1
  61. package/dist/agents/core/AgentCLI.js +25 -1
  62. package/dist/agents/core/AgentCLI.js.map +1 -1
  63. package/dist/agents/core/BaseAgentAdapter.d.ts.map +1 -1
  64. package/dist/agents/core/BaseAgentAdapter.js +90 -27
  65. package/dist/agents/core/BaseAgentAdapter.js.map +1 -1
  66. package/dist/agents/core/extension/BaseExtensionInstaller.d.ts +7 -1
  67. package/dist/agents/core/extension/BaseExtensionInstaller.d.ts.map +1 -1
  68. package/dist/agents/core/extension/BaseExtensionInstaller.js +58 -15
  69. package/dist/agents/core/extension/BaseExtensionInstaller.js.map +1 -1
  70. package/dist/agents/core/session/BaseSessionAdapter.d.ts +25 -0
  71. package/dist/agents/core/session/BaseSessionAdapter.d.ts.map +1 -1
  72. package/dist/agents/core/session/discovery-types.d.ts +53 -0
  73. package/dist/agents/core/session/discovery-types.d.ts.map +1 -0
  74. package/dist/agents/core/session/discovery-types.js +8 -0
  75. package/dist/agents/core/session/discovery-types.js.map +1 -0
  76. package/dist/agents/core/types.d.ts +62 -0
  77. package/dist/agents/core/types.d.ts.map +1 -1
  78. package/dist/agents/plugins/claude/claude-acp.plugin.d.ts +27 -0
  79. package/dist/agents/plugins/claude/claude-acp.plugin.d.ts.map +1 -0
  80. package/dist/agents/plugins/claude/claude-acp.plugin.js +63 -0
  81. package/dist/agents/plugins/claude/claude-acp.plugin.js.map +1 -0
  82. package/dist/agents/plugins/claude/claude-message-types.d.ts +1 -0
  83. package/dist/agents/plugins/claude/claude-message-types.d.ts.map +1 -1
  84. package/dist/agents/plugins/claude/claude.plugin.d.ts +44 -1
  85. package/dist/agents/plugins/claude/claude.plugin.d.ts.map +1 -1
  86. package/dist/agents/plugins/claude/claude.plugin.js +263 -12
  87. package/dist/agents/plugins/claude/claude.plugin.js.map +1 -1
  88. package/dist/agents/plugins/claude/claude.session.d.ts.map +1 -1
  89. package/dist/agents/plugins/claude/claude.session.js +14 -7
  90. package/dist/agents/plugins/claude/claude.session.js.map +1 -1
  91. package/dist/agents/plugins/claude/plugin/.claude-plugin/plugin.json +1 -1
  92. package/dist/agents/plugins/claude/plugin/README.md +40 -2
  93. package/dist/agents/plugins/claude/plugin/claude-templates/README.md +5 -5
  94. package/dist/agents/plugins/claude/plugin/claude-templates/templates/CLAUDE.md.template +177 -436
  95. package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/code-review-agent-template.md.template +49 -82
  96. package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/refactor-cleaner-agent.md.template +337 -0
  97. package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/solution-architect-agent.md.template +129 -419
  98. package/dist/agents/plugins/claude/plugin/claude-templates/templates/agents/unit-tester-agent.md.template +146 -693
  99. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/api/api-patterns.md.template +110 -138
  100. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/architecture.md.template +197 -0
  101. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/data/database-patterns.md.template +171 -91
  102. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/development/development-practices.md.template +219 -131
  103. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/security/security-practices.md.template +223 -98
  104. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/standards/code-quality.md.template +131 -95
  105. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/testing/testing-patterns.md.template +247 -75
  106. package/dist/agents/plugins/claude/plugin/commands/README.md +133 -0
  107. package/dist/agents/plugins/claude/plugin/commands/codemie-init.md +336 -544
  108. package/dist/agents/plugins/claude/plugin/commands/codemie-subagents.md +233 -504
  109. package/dist/agents/plugins/claude/plugin/commands/memory-add.md +311 -30
  110. package/dist/agents/plugins/claude/plugin/commands/memory-refresh.md +218 -39
  111. package/dist/agents/plugins/claude/session/processors/claude.conversations-processor.d.ts.map +1 -1
  112. package/dist/agents/plugins/claude/session/processors/claude.conversations-processor.js +43 -8
  113. package/dist/agents/plugins/claude/session/processors/claude.conversations-processor.js.map +1 -1
  114. package/dist/agents/plugins/claude/session/processors/claude.metrics-processor.d.ts.map +1 -1
  115. package/dist/agents/plugins/claude/session/processors/claude.metrics-processor.js +68 -40
  116. package/dist/agents/plugins/claude/session/processors/claude.metrics-processor.js.map +1 -1
  117. package/dist/agents/plugins/gemini/gemini.plugin.d.ts.map +1 -1
  118. package/dist/agents/plugins/gemini/gemini.plugin.js +0 -3
  119. package/dist/agents/plugins/gemini/gemini.plugin.js.map +1 -1
  120. package/dist/agents/plugins/opencode/index.d.ts +8 -0
  121. package/dist/agents/plugins/opencode/index.d.ts.map +1 -0
  122. package/dist/agents/plugins/opencode/index.js +12 -0
  123. package/dist/agents/plugins/opencode/index.js.map +1 -0
  124. package/dist/agents/plugins/opencode/opencode-message-types.d.ts +207 -0
  125. package/dist/agents/plugins/opencode/opencode-message-types.d.ts.map +1 -0
  126. package/dist/agents/plugins/opencode/opencode-message-types.js +59 -0
  127. package/dist/agents/plugins/opencode/opencode-message-types.js.map +1 -0
  128. package/dist/agents/plugins/opencode/opencode-model-configs.d.ts +65 -0
  129. package/dist/agents/plugins/opencode/opencode-model-configs.d.ts.map +1 -0
  130. package/dist/agents/plugins/opencode/opencode-model-configs.js +184 -0
  131. package/dist/agents/plugins/opencode/opencode-model-configs.js.map +1 -0
  132. package/dist/agents/plugins/opencode/opencode.paths.d.ts +62 -0
  133. package/dist/agents/plugins/opencode/opencode.paths.d.ts.map +1 -0
  134. package/dist/agents/plugins/opencode/opencode.paths.js +148 -0
  135. package/dist/agents/plugins/opencode/opencode.paths.js.map +1 -0
  136. package/dist/agents/plugins/opencode/opencode.plugin.d.ts +35 -0
  137. package/dist/agents/plugins/opencode/opencode.plugin.d.ts.map +1 -0
  138. package/dist/agents/plugins/opencode/opencode.plugin.js +338 -0
  139. package/dist/agents/plugins/opencode/opencode.plugin.js.map +1 -0
  140. package/dist/agents/plugins/opencode/opencode.session.d.ts +77 -0
  141. package/dist/agents/plugins/opencode/opencode.session.d.ts.map +1 -0
  142. package/dist/agents/plugins/opencode/opencode.session.js +424 -0
  143. package/dist/agents/plugins/opencode/opencode.session.js.map +1 -0
  144. package/dist/agents/plugins/opencode/opencode.storage-utils.d.ts +25 -0
  145. package/dist/agents/plugins/opencode/opencode.storage-utils.d.ts.map +1 -0
  146. package/dist/agents/plugins/opencode/opencode.storage-utils.js +96 -0
  147. package/dist/agents/plugins/opencode/opencode.storage-utils.js.map +1 -0
  148. package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.d.ts +30 -0
  149. package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.d.ts.map +1 -0
  150. package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.js +116 -0
  151. package/dist/agents/plugins/opencode/session/processors/opencode.conversations-processor.js.map +1 -0
  152. package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.d.ts +102 -0
  153. package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.d.ts.map +1 -0
  154. package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.js +584 -0
  155. package/dist/agents/plugins/opencode/session/processors/opencode.metrics-processor.js.map +1 -0
  156. package/dist/agents/registry.d.ts +1 -1
  157. package/dist/agents/registry.d.ts.map +1 -1
  158. package/dist/agents/registry.js +5 -1
  159. package/dist/agents/registry.js.map +1 -1
  160. package/dist/cli/commands/assistants/chat.d.ts +11 -0
  161. package/dist/cli/commands/assistants/chat.d.ts.map +1 -0
  162. package/dist/cli/commands/assistants/chat.js +201 -0
  163. package/dist/cli/commands/assistants/chat.js.map +1 -0
  164. package/dist/cli/commands/assistants/constants.d.ts +81 -0
  165. package/dist/cli/commands/assistants/constants.d.ts.map +1 -0
  166. package/dist/cli/commands/assistants/constants.js +75 -0
  167. package/dist/cli/commands/assistants/constants.js.map +1 -0
  168. package/dist/cli/commands/assistants/generators/claude-agent-generator.d.ts +26 -0
  169. package/dist/cli/commands/assistants/generators/claude-agent-generator.d.ts.map +1 -0
  170. package/dist/cli/commands/assistants/generators/claude-agent-generator.js +115 -0
  171. package/dist/cli/commands/assistants/generators/claude-agent-generator.js.map +1 -0
  172. package/dist/cli/commands/assistants/index.d.ts +11 -0
  173. package/dist/cli/commands/assistants/index.d.ts.map +1 -0
  174. package/dist/cli/commands/assistants/index.js +28 -0
  175. package/dist/cli/commands/assistants/index.js.map +1 -0
  176. package/dist/cli/commands/assistants/list.d.ts +11 -0
  177. package/dist/cli/commands/assistants/list.d.ts.map +1 -0
  178. package/dist/cli/commands/assistants/list.js +323 -0
  179. package/dist/cli/commands/assistants/list.js.map +1 -0
  180. package/dist/cli/commands/doctor/checks/AgentsCheck.d.ts +5 -0
  181. package/dist/cli/commands/doctor/checks/AgentsCheck.d.ts.map +1 -1
  182. package/dist/cli/commands/doctor/checks/AgentsCheck.js +29 -0
  183. package/dist/cli/commands/doctor/checks/AgentsCheck.js.map +1 -1
  184. package/dist/cli/commands/install.d.ts.map +1 -1
  185. package/dist/cli/commands/install.js +104 -13
  186. package/dist/cli/commands/install.js.map +1 -1
  187. package/dist/cli/commands/opencode-metrics.d.ts +13 -0
  188. package/dist/cli/commands/opencode-metrics.d.ts.map +1 -0
  189. package/dist/cli/commands/opencode-metrics.js +200 -0
  190. package/dist/cli/commands/opencode-metrics.js.map +1 -0
  191. package/dist/cli/commands/self-update.d.ts +3 -0
  192. package/dist/cli/commands/self-update.d.ts.map +1 -0
  193. package/dist/cli/commands/self-update.js +55 -0
  194. package/dist/cli/commands/self-update.js.map +1 -0
  195. package/dist/cli/commands/setup.d.ts.map +1 -1
  196. package/dist/cli/commands/setup.js +113 -0
  197. package/dist/cli/commands/setup.js.map +1 -1
  198. package/dist/cli/commands/skill.d.ts +6 -0
  199. package/dist/cli/commands/skill.d.ts.map +1 -0
  200. package/dist/cli/commands/skill.js +196 -0
  201. package/dist/cli/commands/skill.js.map +1 -0
  202. package/dist/cli/commands/update.d.ts.map +1 -1
  203. package/dist/cli/commands/update.js +34 -6
  204. package/dist/cli/commands/update.js.map +1 -1
  205. package/dist/cli/index.d.ts.map +1 -1
  206. package/dist/cli/index.js +12 -4
  207. package/dist/cli/index.js.map +1 -1
  208. package/dist/env/types.d.ts +13 -0
  209. package/dist/env/types.d.ts.map +1 -1
  210. package/dist/env/types.js +1 -1
  211. package/dist/env/types.js.map +1 -1
  212. package/dist/migrations/003-remove-hooks-node.migration.d.ts +22 -0
  213. package/dist/migrations/003-remove-hooks-node.migration.d.ts.map +1 -0
  214. package/dist/migrations/003-remove-hooks-node.migration.js +103 -0
  215. package/dist/migrations/003-remove-hooks-node.migration.js.map +1 -0
  216. package/dist/migrations/index.d.ts +1 -0
  217. package/dist/migrations/index.d.ts.map +1 -1
  218. package/dist/migrations/index.js +1 -1
  219. package/dist/migrations/index.js.map +1 -1
  220. package/dist/providers/plugins/sso/sso.http-client.js +2 -2
  221. package/dist/providers/plugins/sso/sso.http-client.js.map +1 -1
  222. package/dist/providers/plugins/sso/sso.setup-steps.d.ts.map +1 -1
  223. package/dist/providers/plugins/sso/sso.setup-steps.js +14 -10
  224. package/dist/providers/plugins/sso/sso.setup-steps.js.map +1 -1
  225. package/dist/skills/core/SkillDiscovery.d.ts +83 -0
  226. package/dist/skills/core/SkillDiscovery.d.ts.map +1 -0
  227. package/dist/skills/core/SkillDiscovery.js +237 -0
  228. package/dist/skills/core/SkillDiscovery.js.map +1 -0
  229. package/dist/skills/core/SkillManager.d.ts +86 -0
  230. package/dist/skills/core/SkillManager.d.ts.map +1 -0
  231. package/dist/skills/core/SkillManager.js +155 -0
  232. package/dist/skills/core/SkillManager.js.map +1 -0
  233. package/dist/skills/core/types.d.ts +120 -0
  234. package/dist/skills/core/types.d.ts.map +1 -0
  235. package/dist/skills/core/types.js +20 -0
  236. package/dist/skills/core/types.js.map +1 -0
  237. package/dist/skills/index.d.ts +12 -0
  238. package/dist/skills/index.d.ts.map +1 -0
  239. package/dist/skills/index.js +12 -0
  240. package/dist/skills/index.js.map +1 -0
  241. package/dist/skills/utils/content-loader.d.ts +25 -0
  242. package/dist/skills/utils/content-loader.d.ts.map +1 -0
  243. package/dist/skills/utils/content-loader.js +161 -0
  244. package/dist/skills/utils/content-loader.js.map +1 -0
  245. package/dist/skills/utils/frontmatter.d.ts +60 -0
  246. package/dist/skills/utils/frontmatter.d.ts.map +1 -0
  247. package/dist/skills/utils/frontmatter.js +114 -0
  248. package/dist/skills/utils/frontmatter.js.map +1 -0
  249. package/dist/skills/utils/pattern-matcher.d.ts +60 -0
  250. package/dist/skills/utils/pattern-matcher.d.ts.map +1 -0
  251. package/dist/skills/utils/pattern-matcher.js +97 -0
  252. package/dist/skills/utils/pattern-matcher.js.map +1 -0
  253. package/dist/utils/auth.d.ts +22 -0
  254. package/dist/utils/auth.d.ts.map +1 -0
  255. package/dist/utils/auth.js +50 -0
  256. package/dist/utils/auth.js.map +1 -0
  257. package/dist/utils/cli-updater.d.ts +70 -0
  258. package/dist/utils/cli-updater.d.ts.map +1 -0
  259. package/dist/utils/cli-updater.js +339 -0
  260. package/dist/utils/cli-updater.js.map +1 -0
  261. package/dist/utils/config.d.ts +6 -1
  262. package/dist/utils/config.d.ts.map +1 -1
  263. package/dist/utils/config.js +13 -0
  264. package/dist/utils/config.js.map +1 -1
  265. package/dist/utils/installation-detector.d.ts +22 -0
  266. package/dist/utils/installation-detector.d.ts.map +1 -0
  267. package/dist/utils/installation-detector.js +49 -0
  268. package/dist/utils/installation-detector.js.map +1 -0
  269. package/dist/utils/native-installer.d.ts +49 -0
  270. package/dist/utils/native-installer.d.ts.map +1 -0
  271. package/dist/utils/native-installer.js +225 -0
  272. package/dist/utils/native-installer.js.map +1 -0
  273. package/dist/utils/processes.js +1 -1
  274. package/dist/utils/profile.d.ts +2 -0
  275. package/dist/utils/profile.d.ts.map +1 -1
  276. package/dist/utils/profile.js +5 -0
  277. package/dist/utils/profile.js.map +1 -1
  278. package/dist/utils/sdk-client.d.ts +15 -0
  279. package/dist/utils/sdk-client.d.ts.map +1 -0
  280. package/dist/utils/sdk-client.js +92 -0
  281. package/dist/utils/sdk-client.js.map +1 -0
  282. package/dist/utils/version-utils.d.ts +50 -0
  283. package/dist/utils/version-utils.d.ts.map +1 -0
  284. package/dist/utils/version-utils.js +92 -0
  285. package/dist/utils/version-utils.js.map +1 -0
  286. package/package.json +11 -3
  287. package/scripts/copy-mr-skill-to-global.ts +252 -0
  288. package/scripts/demo-hooks.sh +125 -0
  289. package/scripts/test-hooks.sh +196 -0
  290. package/dist/agents/plugins/claude/plugin/claude-templates/templates/INDEX.md +0 -205
  291. package/dist/agents/plugins/claude/plugin/claude-templates/templates/TEMPLATE_SIZES.md +0 -74
  292. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/layered-architecture.md.template +0 -143
  293. package/dist/agents/plugins/claude/plugin/claude-templates/templates/guides/architecture/project-structure.md.template +0 -127
  294. package/dist/agents/plugins/claude/plugin/commands/codemie-pr.md +0 -25
@@ -1,304 +1,166 @@
1
1
  # CLAUDE.md
2
2
 
3
- **Purpose**: AI-optimized execution guide for Claude Code agents working with the [PROJECT_NAME] codebase
4
-
5
- ---
6
-
7
- ## 📚 GUIDE IMPORTS
8
-
9
- This document references detailed guides stored in `.codemie/guides/`. Key references:
10
-
11
- ### 🚨 MANDATORY RULE: Check Guides First
3
+ <!--
4
+ ═══════════════════════════════════════════════════════════════════════════════
5
+ TEMPLATE INSTRUCTIONS FOR LLM/AI
6
+ ═══════════════════════════════════════════════════════════════════════════════
7
+ PURPOSE: Generate project-specific CLAUDE.md execution guide from this template.
8
+
9
+ POPULATION RULES:
10
+ 1. ANALYZE codebase: structure, configs, existing patterns
11
+ 2. DISCOVER guides in .codemie/guides/ - read each and extract purpose
12
+ 3. EXTRACT technology stack from package.json/requirements.txt/pom.xml/go.mod
13
+ 4. REPLACE all [PLACEHOLDER] values with discovered information
14
+ 5. DELETE sections marked with [OPTIONAL] if not applicable
15
+ 6. REMOVE all <!-- INSTRUCTION --> comments after populating
16
+
17
+ PLACEHOLDERS FORMAT:
18
+ - [PLACEHOLDER] = Required, must be replaced
19
+ - [PLACEHOLDER?] = Optional, delete row/section if not applicable
20
+
21
+ OUTPUT: Clean, actionable reference file without any template artifacts.
22
+ ═══════════════════════════════════════════════════════════════════════════════
23
+ -->
12
24
 
13
- **BEFORE searching files or codebase for information, you MUST:**
25
+ **Purpose**: AI-optimized execution guide for Claude Code agents working with [PROJECT_NAME] codebase
14
26
 
15
- 1. **Always check** if the guides referenced below contain relevant information for the prompt or task
16
- 2. **Use the Task Classifier** in [Instant Start](#-instant-start-read-first) to identify which guides are relevant
17
- 3. **Load and review** the appropriate P0 (required) guides BEFORE performing direct file searches
18
- 4. **Only proceed** to codebase searches after confirming guides don't contain the needed patterns/information
27
+ <!-- INSTRUCTION: Extract project name from package.json "name", pom.xml artifactId, pyproject.toml, or root folder name -->
19
28
 
20
- **This rule is MANDATORY and must be followed without exceptions.**
29
+ ---
21
30
 
22
- **Why**: Guides contain curated patterns, best practices, and architectural decisions. Checking them first:
23
- - Prevents reinventing existing patterns
24
- - Ensures consistency with established conventions
25
- - Saves time by providing direct answers to common questions
26
- - Reduces risk of introducing anti-patterns
31
+ ## 🚨 CRITICAL RULES (Check Every Task)
32
+
33
+ | Rule | Trigger | Action |
34
+ |------|---------|--------|
35
+ | **Check Guides First** | ANY task/prompt | ALWAYS check relevant guides BEFORE searching codebase |
36
+ | **Testing** | User says "test", "write tests", "run tests" | ONLY then work on tests |
37
+ | **Git Ops** | User says "commit", "push", "PR", "branch" | ONLY then do git operations |
38
+ | **[ENV_RULE_NAME?]** | [TRIGGER_CONDITION?] | [REQUIRED_ACTION?] |
39
+ | **Shell** | ANY shell command | ONLY bash/Linux syntax |
40
+
41
+ <!--
42
+ INSTRUCTION: Populate environment rule based on project type:
43
+ - Python with venv: "Virtualenv" | "ANY Python command" | "Activate first: `source .venv/bin/activate`"
44
+ - Node with nvm: "Node Version" | "ANY npm/node command" | "Run: `nvm use`"
45
+ - Docker: "Container" | "ANY app command" | "Run inside container"
46
+ - If no special env requirement, delete the [ENV_RULE_NAME?] row
47
+ -->
27
48
 
28
- **Workflow**: Prompt Task Classifier Load Relevant Guides → Check Guide Content → Then Search Codebase (if needed)
49
+ **Recovery**: If stuck → Check [Troubleshooting](#-troubleshooting)
29
50
 
30
51
  ---
31
52
 
32
- ### 📖 Guide References by Category
33
-
34
- <!-- FILL IN: Add references to your project-specific guides -->
53
+ ## 📚 GUIDE IMPORTS
35
54
 
36
- **[CATEGORY_1]**:
37
- - [Pattern name]: .codemie/guides/[category]/[pattern-name].md
55
+ <!--
56
+ INSTRUCTION:
57
+ 1. List all .md files in .codemie/guides/ directory recursively
58
+ 2. Read first 10-20 lines of each guide to understand its purpose
59
+ 3. Group by parent folder (category)
60
+ 4. Populate table with actual paths and extracted purposes
61
+ -->
38
62
 
39
- **[CATEGORY_2]**:
40
- - [Pattern name]: .codemie/guides/[category]/[pattern-name].md
63
+ | Category | Guide Path | Purpose |
64
+ |----------|------------|---------|
65
+ | [CATEGORY] | .codemie/guides/[category]/[filename].md | [Brief description extracted from guide] |
41
66
 
42
- <!-- Common categories to consider:
43
- - Agents & Tools (if using LLM agents)
44
- - API Development (REST/GraphQL patterns)
45
- - Architecture (layered architecture, service patterns)
46
- - Data & Database (database patterns, repositories)
47
- - Development Practices (error handling, logging, security)
48
- - Testing (testing patterns, frameworks)
49
- - Integrations (external services, cloud providers)
50
- - Standards (code quality, git workflow)
51
- - Workflows (business workflows, state machines)
67
+ <!--
68
+ EXAMPLE after population:
69
+ | Architecture | .codemie/guides/architecture/layers.md | Service-repository-controller pattern |
70
+ | API | .codemie/guides/api/rest-conventions.md | REST endpoint naming and response formats |
71
+ | Testing | .codemie/guides/testing/unit-tests.md | Unit testing patterns and mocking |
72
+ | Data | .codemie/guides/data/repository-pattern.md | Database access patterns |
52
73
  -->
53
74
 
54
75
  ---
55
76
 
56
- ## ⚡ INSTANT START (Read First)
57
-
58
- ### 1. Critical Rules (MANDATORY - Always Check)
59
-
60
- | Rule | Trigger | Action Required |
61
- |------|---------|-----------------|
62
- | 🚨 **Check Guides First** | ANY new prompt/task | ALWAYS check relevant guides BEFORE searching codebase → [Guide Imports](#-guide-imports) |
63
- | 🚨 **Testing** | User says "write tests", "run tests" | ONLY then work on tests → [Testing Policy](#testing-policy) |
64
- | 🚨 **Git Ops** | User says "commit", "push", "create PR" | ONLY then do git operations → [Git Policy](#git-operations-policy) |
65
- | 🚨 **[ENV_NAME]** | ANY [language/tool] command | ALWAYS [activation step] → [Env Policy](#environment-policy) |
66
- | 🚨 **Shell** | ANY shell command | ONLY bash/Linux syntax → [Shell Policy](#shell-environment-policy) |
67
-
68
- <!-- FILL IN: Add project-specific critical rules -->
77
+ ## ⚡ TASK CLASSIFIER
69
78
 
70
- **Emergency Recovery**: If commands failCheck [Troubleshooting](#-troubleshooting-quick-reference)
79
+ **Analyze request intent Match category Load appropriate guides**
71
80
 
72
- ### 2. Task Classifier (What am I doing?)
73
-
74
- **Scan user request for keywords Load guides → Execute**
75
-
76
- <!-- FILL IN: Customize based on your project's technology stack and patterns -->
81
+ <!--
82
+ INSTRUCTION:
83
+ 1. For each guide category discovered above, define:
84
+ - User Intent: What is the user trying to ACCOMPLISH (semantic meaning, not keywords)
85
+ - Example Requests: 2-3 realistic prompts that would match this category
86
+ - P0 Guide: Primary required guide
87
+ - P1 Guide: Optional secondary guide (if exists)
88
+ 2. Keep only categories that have actual guides
89
+ -->
77
90
 
78
- | Keywords | Complexity | Load Guide (P0=Required) | Also Load (P1=Optional) |
79
- |----------|-----------|--------------------------|-------------------------|
80
- | **[keyword1, keyword2]** | Medium-High | .codemie/guides/[category]/[guide].md | .codemie/guides/[category]/[optional-guide].md |
81
- | **[keyword3, keyword4]** | Medium | .codemie/guides/[category]/[guide].md | - |
91
+ | Category | User Intent / Purpose | Example Requests | P0 Guide | P1 Guide |
92
+ |----------|----------------------|------------------|----------|----------|
93
+ | **[CATEGORY]** | [What user is trying to accomplish] | "[Example 1]", "[Example 2]" | .codemie/guides/[path] | .codemie/guides/[path?] |
82
94
 
83
- <!-- Example entries:
84
- | **api, endpoint, router** | Medium | .codemie/guides/api/rest-api-patterns.md | .codemie/guides/api/endpoint-conventions.md |
85
- | **test, pytest** | Medium | .codemie/guides/testing/testing-patterns.md | .codemie/guides/testing/testing-api-patterns.md |
86
- | **database, sql** | Medium-High | .codemie/guides/data/database-patterns.md | .codemie/guides/data/database-optimization.md |
95
+ <!--
96
+ EXAMPLE after population:
97
+ | **Architecture** | Design decisions, system structure, planning features | "How should I structure?", "Where should this go?" | .codemie/guides/architecture/layers.md | - |
98
+ | **API** | Creating/modifying endpoints, routing, validation | "Create endpoint for...", "Add API to..." | .codemie/guides/api/rest-conventions.md | - |
99
+ | **Data** | Database operations, queries, models, migrations | "Query database", "Add new table" | .codemie/guides/data/repository-pattern.md | - |
100
+ | **Testing** | Writing tests, fixing tests, coverage | "Write tests for...", "Fix failing test" | .codemie/guides/testing/unit-tests.md | - |
87
101
  -->
88
102
 
89
- **Guide Path**: All guides in `.codemie/guides/<category>/`
90
-
91
- **Complexity Guide**:
92
- - **Simple**: 1 file, < 5 min, obvious pattern → Use direct tools (Grep/Glob/Read)
93
- - **Medium**: 2-5 files, 5-15 min, standard patterns → Use direct tools + guide reference
94
- - **High**: 6+ files, 15+ min, architectural decisions → Consider EnterPlanMode or Task tool
103
+ ### Intent Detection
95
104
 
96
- ### 3. Self-Check Before Starting
105
+ ```
106
+ USER REQUEST
107
+ ├─> What is the PRIMARY deliverable? → Primary Category (load P0)
108
+ ├─> What standards must be followed? → Secondary Categories (load P0s)
109
+ └─> How many files affected? → Complexity (1-2: Simple, 3-5: Medium, 6+: High)
110
+ ```
97
111
 
98
- Before any action:
99
- - [ ] Did I check relevant guides FIRST (before searching codebase)?
100
- - [ ] Which critical rules apply? (guides/testing/git/env/shell)
101
- - [ ] What keywords did I identify?
102
- - [ ] What's the complexity level?
103
- - [ ] Which guides do I need to load (P0 first)?
104
- - [ ] Am I 80%+ confident about approach?
112
+ ### Complexity Guide
105
113
 
106
- **Decision Gates**:
107
- - ❌ **NO to any above** → ASK USER or READ MORE before proceeding
108
- - **Confidence < 80%** Load P0 guides, then re-assess
109
- - **YES to all + Confidence 80%+** Proceed to execution
114
+ | Level | Indicators | Action |
115
+ |-------|------------|--------|
116
+ | **Simple** | 1-2 files, clear pattern | P0 guide if unsure |
117
+ | **Medium** | 3-5 files, standard scope | Load P0 guides |
118
+ | **High** | 6+ files, architectural impact | All P0+P1 guides, consider planning mode |
110
119
 
111
120
  ---
112
121
 
113
- ## 🔄 EXECUTION WORKFLOW (Step-by-Step)
114
-
115
- Follow this sequence for every task:
122
+ ## 🔄 EXECUTION WORKFLOW
116
123
 
117
124
  ```
118
125
  START
119
-
120
126
  ├─> STEP 1: Parse Request
121
- ├─ Identify task keywords (see Task Classifier above)
122
- │ ├─ Check which Critical Rules apply
123
- │ ├─ Assess complexity level
124
- │ └─ Gate: Can I identify 1+ relevant guides? NO → Ask user | YES → Continue
125
-
126
- ├─> STEP 2: Confidence Check
127
- │ ├─ Am I 80%+ confident about approach?
128
- │ ├─ YES → Continue | NO → Load P0 guides
129
- │ └─ Gate: After reading, confidence 80%+? NO → Load P1 guides or ask user | YES → Continue
127
+ └─ Match intent to Category Assess complexity
130
128
 
131
- ├─> STEP 3: Load Documentation (Selective, Not Everything)
132
- ├─ Load P0 guides from Task Classifier (REQUIRED for Medium/High complexity)
133
- │ ├─ Scan P1 guides - load only if confidence still < 80% (OPTIONAL)
134
- │ └─ Gate: Do I have enough context? NO → Load more or ask user | YES → Continue
129
+ ├─> STEP 2: Load Guides
130
+ └─ Load P0 guides Confidence < 80%? Load P1 or ask user
135
131
 
136
- ├─> STEP 4: Pattern Match (Use Quick References)
137
- ├─ Check Pattern Tables below (error handling, logging, architecture)
138
- │ ├─ Check Common Pitfalls table
139
- │ └─ Gate: Do I know the correct pattern? NO → Read guide detail | YES → Continue
132
+ ├─> STEP 3: Execute
133
+ └─ Apply patterns from guides Follow Critical Rules
140
134
 
141
- ├─> STEP 5: Execute (Apply Patterns)
142
- │ ├─ Apply patterns from loaded guides
143
- │ ├─ Follow Critical Rules (test/git/env/shell)
144
- │ ├─ Track progress with success indicators
145
- │ └─ Cross-check with Quick Validation (below)
146
-
147
- └─> STEP 6: Validate (Before Delivery)
148
- ├─ Run through Quick Validation checklist
149
- ├─ Check Success Indicators
150
- ├─ Gate: All checks pass? NO → Fix issues | YES → Deliver
151
- └─ END
135
+ └─> STEP 4: Validate & Deliver
136
+ └─ Run checklist All pass? → Deliver
152
137
  ```
153
138
 
154
- ### Success Indicators (Am I on track?)
155
-
156
- | Stage | Good Signs | Warning Signs |
157
- |-------|-----------|---------------|
158
- | **Parse Request** | Keywords match Task Classifier | No matching keywords → ask user |
159
- | **Confidence Check** | 80%+ confident after reading | Still confused after P0 guides → need clarification |
160
- | **Load Docs** | Patterns clear, examples match task | Multiple conflicting patterns → ask user preference |
161
- | **Pattern Match** | Found exact pattern in quick ref | No matching pattern → read full guide |
162
- | **Execute** | Code compiles, follows architecture | Errors, missing imports → check guide again |
163
- | **Validate** | All checks pass, tests work | Any check fails → fix before delivery |
164
-
165
- ### Quick Validation (Run Before Delivery)
166
-
167
- <!-- FILL IN: Customize based on your project's quality standards -->
168
-
169
- | Priority | Check | How to Verify | Fix If Failed |
170
- |----------|-------|---------------|---------------|
171
- | 🚨 | **Functionality** | Does it meet user request? | Re-read requirements |
172
- | 🚨 | **Critical Rules** | Did I follow test/git/env/shell rules? | Review policies below |
173
- | 🚨 | **Security** | No hardcoded secrets? Input validated? | See [Security Patterns](#security-patterns-mandatory) |
174
- | 🚨 | **Error Handling** | Using proper exceptions? | See [Error Handling](#error-handling-use-these-patterns) |
175
- | 🚨 | **Logging** | Following logging patterns? | See [Logging Patterns](#logging-patterns-mandatory) |
176
- | ⚠️ | **Architecture** | Followed project architecture? | See guides in .codemie/guides/architecture/ |
177
- | ⚠️ | **Async/Concurrency** | Used appropriate patterns? | See [Common Pitfalls](#common-pitfalls-avoid-these) |
178
- | ✅ | **Type Safety** | All functions typed? | See code quality guide |
179
- | ✅ | **Code Quality** | No TODOs, unused imports? | Run linter |
180
-
181
- ---
182
-
183
- ## 📊 PATTERN QUICK REFERENCE
184
-
185
- <!-- FILL IN: Add quick reference tables for your most common patterns -->
139
+ ### Pre-Delivery Checklist
186
140
 
187
- ### Error Handling (Use These Patterns)
188
-
189
- <!-- Example structure - customize for your project -->
190
-
191
- | When | Pattern/Exception | Import From | Related Patterns |
192
- |------|-------------------|-------------|------------------|
193
- | Validation failed | `[ValidationError]` | `[module.path]` | [Logging](#logging-patterns-mandatory) |
194
- | Not found | `[NotFoundException]` | `[module.path]` | [API Patterns](#api-patterns) |
195
- | Business logic | `[BusinessError]` | `[module.path]` | [Service Layer](#service-layer) |
196
-
197
- **Detail**: .codemie/guides/development/error-handling.md
198
-
199
- ### Logging Patterns (MANDATORY)
200
-
201
- <!-- Example structure - customize for your project -->
202
-
203
- | ✅ DO | ❌ DON'T | Why | Related |
204
- |-------|----------|-----|---------|
205
- | [Best practice 1] | [Anti-pattern 1] | [Reason] | [Related pattern] |
206
- | [Best practice 2] | [Anti-pattern 2] | [Reason] | [Related pattern] |
207
-
208
- **Detail**: .codemie/guides/development/logging-patterns.md
209
-
210
- ### Architecture Patterns (Core Rules)
211
-
212
- <!-- FILL IN: Document your project's architectural layers -->
213
-
214
- | Layer | Responsibility | Example Path | Related Guide |
215
- |-------|----------------|--------------|---------------|
216
- | **[Layer 1]** | [Responsibility] | `[path/to/layer]` | .codemie/guides/[guide].md |
217
- | **[Layer 2]** | [Responsibility] | `[path/to/layer]` | .codemie/guides/[guide].md |
218
-
219
- **Flow**: `[Layer1] → [Layer2] → [Layer3]` (Never skip layers)
220
-
221
- **Detail**: .codemie/guides/architecture/layered-architecture.md
222
-
223
- ### Security Patterns (MANDATORY)
224
-
225
- <!-- FILL IN: Document security requirements -->
226
-
227
- | Rule | Implementation | Related Guide |
228
- |------|----------------|---------------|
229
- | No hardcoded credentials | [How to handle] | .codemie/guides/development/security-patterns.md |
230
- | Input validation | [Validation approach] | .codemie/guides/[guide].md |
231
- | Authentication | [Auth pattern] | .codemie/guides/[guide].md |
232
-
233
- **Detail**: .codemie/guides/development/security-patterns.md
234
-
235
- ### Common Pitfalls (Avoid These)
236
-
237
- <!-- FILL IN: Document common mistakes and anti-patterns -->
238
-
239
- | Category | 🚨 Never Do This | ✅ Do This Instead | Guide Reference |
240
- |----------|------------------|---------------------|-----------------|
241
- | **[Language]** | [Anti-pattern] | [Correct pattern] | .codemie/guides/[guide].md |
242
- | **[Framework]** | [Anti-pattern] | [Correct pattern] | .codemie/guides/[guide].md |
243
- | **[Tool]** | [Anti-pattern] | [Correct pattern] | .codemie/guides/[guide].md |
141
+ - [ ] Meets user's request requirements?
142
+ - [ ] Follows patterns from loaded guides?
143
+ - [ ] Critical Rules followed? (testing/git/env)
144
+ - [ ] No hardcoded secrets or credentials?
244
145
 
245
146
  ---
246
147
 
247
- ## 🛠️ DEVELOPMENT COMMANDS
248
-
249
- <!-- FILL IN: Document your project's common commands -->
250
-
251
- **🚨 CRITICAL**: [Environment setup instructions, e.g., "Activate virtualenv before ALL Python commands"]
148
+ ## 🛠️ COMMANDS
252
149
 
253
- ### Common Commands
254
-
255
- | Task | Command | Env? | Notes |
256
- |------|---------|------|-------|
257
- | **Setup** | `[setup command]` | [Y/N] | First time setup |
258
- | **Run Server** | `[run command]` | [Y/N] | Dev server |
259
- | **Lint** | `[lint command]` | [Y/N] | Check code quality |
260
- | **Format** | `[format command]` | [Y/N] | Format code |
261
- | **Test** ⚠️ | `[test command]` | [Y/N] | ONLY if user requests |
262
- | **Build** | `[build command]` | [Y/N] | Build project |
263
-
264
- <!-- Example entries:
265
- | **Setup** | `npm install` | N/A | First time setup |
266
- | **Run Server** | `npm run dev` | N/A | Dev server (port 3000) |
267
- | **Lint** | `npm run lint` | N/A | ESLint check |
268
- | **Format** | `npm run format` | N/A | Prettier format |
269
- | **Test** ⚠️ | `npm test` | N/A | ONLY if user requests |
270
- | **Build** | `npm run build` | N/A | Production build |
150
+ <!--
151
+ INSTRUCTION:
152
+ 1. Extract from package.json scripts, Makefile, pyproject.toml, or build configs
153
+ 2. Document commonly used development commands
271
154
  -->
272
155
 
273
- **[Additional Info]**: [URLs, ports, documentation links]
274
-
275
- ---
276
-
277
- ## 🔧 TROUBLESHOOTING QUICK REFERENCE
278
-
279
- ### Common Issues & Fixes
280
-
281
- <!-- FILL IN: Document common issues and solutions -->
282
-
283
- | Symptom | Likely Cause | Fix | Prevention |
284
- |---------|--------------|-----|------------|
285
- | [Error message/symptom] | [Root cause] | [Solution steps] | [How to prevent] |
286
- | [Error message/symptom] | [Root cause] | [Solution steps] | [How to prevent] |
287
-
288
- ### Diagnostic Commands
289
-
290
- | Need to Check | Command | What to Look For |
291
- |---------------|---------|------------------|
292
- | [System status] | `[diagnostic command]` | [Expected output] |
293
- | [Dependency status] | `[diagnostic command]` | [Expected output] |
294
-
295
- ### Emergency Recovery
296
-
297
- | Situation | Action |
298
- |-----------|--------|
299
- | **Commands failing** | 1. [First recovery step]<br>2. [Second recovery step]<br>3. [Escalation step] |
300
- | **Build errors** | 1. [First recovery step]<br>2. [Second recovery step] |
301
- | **Pattern unclear** | 1. Search .codemie/guides/ for pattern<br>2. Check related patterns<br>3. Ask user if ambiguous |
156
+ | Task | Command | Notes |
157
+ |------|---------|-------|
158
+ | **Setup** | `[SETUP_COMMAND]` | First-time setup |
159
+ | **Run Dev** | `[RUN_COMMAND]` | Development server |
160
+ | **Lint** | `[LINT_COMMAND]` | Code quality check |
161
+ | **Format** | `[FORMAT_COMMAND?]` | Auto-format code |
162
+ | **Build** | `[BUILD_COMMAND?]` | Production build |
163
+ | **Test** ⚠️ | `[TEST_COMMAND]` | ONLY when user requests |
302
164
 
303
165
  ---
304
166
 
@@ -306,206 +168,85 @@ START
306
168
 
307
169
  ### Technology Stack
308
170
 
309
- <!-- FILL IN: Document your technology stack -->
171
+ <!--
172
+ INSTRUCTION: Extract from package.json, requirements.txt, pom.xml, go.mod, etc.
173
+ -->
310
174
 
311
- | Component | Tool | Version | Purpose |
312
- |-----------|------|---------|---------|
313
- | Language | [Language] | [Version] | Core language |
314
- | Framework | [Framework] | [Version] | [Purpose] |
315
- | Database | [Database] | [Version] | [Purpose] |
316
- | Testing | [Test framework] | [Version] | Test framework |
317
- | Linting | [Linter] | [Version] | Code quality |
318
- | [Other] | [Tool] | [Version] | [Purpose] |
175
+ | Component | Technology | Version |
176
+ |-----------|------------|---------|
177
+ | Language | [LANGUAGE] | [VERSION] |
178
+ | Framework | [FRAMEWORK] | [VERSION] |
179
+ | Database | [DATABASE?] | [VERSION?] |
180
+ | Testing | [TEST_FRAMEWORK] | [VERSION] |
181
+ | Linting | [LINTER?] | [VERSION?] |
319
182
 
320
- ### Core Components
183
+ ### Project Structure
321
184
 
322
- <!-- FILL IN: Document your project's main components -->
185
+ <!--
186
+ INSTRUCTION: Document main directories developer will work with. Keep concise.
187
+ -->
323
188
 
324
- | Component | Path | Purpose | Guide |
325
- |-----------|------|---------|-------|
326
- | [Component 1] | `[path/]` | [Description] | .codemie/guides/[guide].md |
327
- | [Component 2] | `[path/]` | [Description] | .codemie/guides/[guide].md |
189
+ ```
190
+ [PROJECT_ROOT]/
191
+ ├── [DIR_1]/ # [Purpose]
192
+ ├── [DIR_2]/ # [Purpose]
193
+ ├── .codemie/guides/ # Architecture and pattern guides
194
+ └── [DIR_3]/ # [Purpose]
195
+ ```
328
196
 
329
- ### Key Integrations
197
+ ### Key Integrations [OPTIONAL]
330
198
 
331
- <!-- FILL IN: Document external integrations -->
199
+ <!--
200
+ INSTRUCTION: Document external services if any exist. DELETE section if none.
201
+ -->
332
202
 
333
203
  | Integration | Purpose | Guide |
334
204
  |-------------|---------|-------|
335
- | [Service 1] | [Purpose] | .codemie/guides/integration/[guide].md |
336
- | [Service 2] | [Purpose] | .codemie/guides/integration/[guide].md |
337
-
338
- ### Architecture Overview
339
-
340
- <!-- FILL IN: Brief architecture description -->
341
-
342
- **[Architecture Pattern Name]**:
343
- - [Key characteristic 1]
344
- - [Key characteristic 2]
345
- - [Key characteristic 3]
346
- - **Detail**: .codemie/guides/architecture/[guide].md
347
-
348
- ---
349
-
350
- ## 📝 CODING STANDARDS
351
-
352
- ### [Language] Features (Use These)
353
-
354
- <!-- FILL IN: Document language-specific features to use -->
355
-
356
- | Feature | Use For | Guide Reference |
357
- |---------|---------|-----------------|
358
- | [Feature 1] | [Use case] | .codemie/guides/standards/code-quality.md |
359
- | [Feature 2] | [Use case] | .codemie/guides/standards/code-quality.md |
360
-
361
- **Detail**: .codemie/guides/standards/code-quality.md
362
-
363
- ### Type Safety (REQUIRED/OPTIONAL)
364
-
365
- <!-- FILL IN: Document type safety requirements -->
366
-
367
- [Type safety requirements and patterns]
368
-
369
- ### Async/Concurrency Patterns (CRITICAL)
370
-
371
- <!-- FILL IN: Document async patterns if applicable -->
372
-
373
- | ✅ DO | ❌ DON'T | Guide |
374
- |-------|----------|-------|
375
- | [Best practice] | [Anti-pattern] | .codemie/guides/[guide].md |
205
+ | [SERVICE?] | [Purpose] | .codemie/guides/[path?] |
376
206
 
377
207
  ---
378
208
 
379
- ## 📚 DETAILED POLICIES
380
-
381
- ### Testing Policy
382
-
383
- **MANDATORY RULE**: Tests ONLY when user EXPLICITLY requests
209
+ ## 🔧 TROUBLESHOOTING
384
210
 
385
- **Triggers** (work on tests ONLY if user says):
386
- - "write tests"
387
- - ✅ "run the tests"
388
- - ✅ "create unit tests"
389
- - ✅ "add test coverage"
390
- - ✅ `[test command]`
391
-
392
- **Never Do**:
393
- - ❌ Proactively write tests
394
- - ❌ Suggest running tests
395
- - ❌ Run tests unless asked
396
-
397
- **Framework**: [Test framework and tools]
398
-
399
- **Rationale**: Testing requires time and context. Only implement when explicitly needed.
400
-
401
- **If Unsure**: Ask user for clarification
402
-
403
- **Testing Details**: .codemie/guides/testing/testing-patterns.md
404
-
405
- ### Git Operations Policy
406
-
407
- **MANDATORY RULE**: Git operations ONLY when user EXPLICITLY requests
408
-
409
- **Triggers** (do git ops ONLY if user says):
410
- - ✅ "commit these changes"
411
- - ✅ "create a commit"
412
- - ✅ "push to remote"
413
- - ✅ "create a branch"
414
- - ✅ "create a pull request"
415
-
416
- **Never Do**:
417
- - ❌ Proactively commit/push/branch
418
- - ❌ Suggest git operations
419
-
420
- **Branch Pattern**: [Branch naming convention]
421
-
422
- **Rationale**: Git affects version control history. Only perform when explicitly requested.
423
-
424
- **If Unsure**: Ask user for clarification
425
-
426
- **Git Details**: .codemie/guides/standards/git-workflow.md
427
-
428
- ### Environment Policy
429
-
430
- <!-- FILL IN: Document environment setup requirements -->
431
-
432
- **MANDATORY RULE**: [Environment requirement, e.g., "ALWAYS activate virtualenv BEFORE Python commands"]
433
-
434
- **Why**: [Reason]
435
-
436
- **How to Activate**: `[activation command]`
437
-
438
- **Alternative**: [Alternative approach if applicable]
439
-
440
- **Rule of Thumb**: [When to know environment is not set up correctly]
441
-
442
- **Recovery**: See [Troubleshooting](#-troubleshooting-quick-reference)
443
-
444
- **Detail**: .codemie/guides/development/setup-guide.md
445
-
446
- ### Shell Environment Policy
447
-
448
- **MANDATORY RULE**: Use bash/Linux commands ONLY
449
-
450
- **Requirements**:
451
- - ✅ Bash/shell syntax for all commands
452
- - ✅ Linux-compatible commands
453
- - ❌ No Windows commands (PowerShell, cmd.exe)
211
+ <!--
212
+ INSTRUCTION: Document known issues specific to this project. Include common setup problems.
213
+ -->
454
214
 
455
- **Rationale**: Ensures consistency across development environments
215
+ | Symptom | Cause | Solution |
216
+ |---------|-------|----------|
217
+ | [ERROR_OR_SYMPTOM] | [ROOT_CAUSE] | [FIX] |
218
+ | Commands fail | Environment not set | [ACTIVATION_COMMAND] |
456
219
 
457
220
  ---
458
221
 
459
222
  ## 🎯 REMEMBER
460
223
 
461
- ### Critical Workflow
462
- 1. Read [Instant Start](#-instant-start-read-first)
463
- 2. Run [Self-Check](#3-self-check-before-starting) (check confidence level)
464
- 3. 🔄 Follow [Execution Workflow](#-execution-workflow-step-by-step) (step-by-step with gates)
465
- 4. 📊 Use [Pattern Quick Reference](#-pattern-quick-reference) (fast lookups)
466
- 5. 🔍 Track [Success Indicators](#success-indicators-am-i-on-track) (am I on track?)
467
- 6. ✅ [Validate before delivery](#quick-validation-run-before-delivery) (all checks must pass)
468
-
469
- ### Critical Rules (Check EVERY Time)
470
- - 🚨 **Check Guides First**: ALWAYS check relevant guides BEFORE searching codebase
471
- - 🚨 **Testing**: Only when explicitly requested
472
- - 🚨 **Git**: Only when explicitly requested
473
- - 🚨 **Environment**: [Environment requirement]
474
- - 🚨 **Shell**: Bash/Linux only
475
-
476
- ### Decision Making Framework
477
- 1. **Parse**: Use Task Classifier to identify keywords → guides → complexity
478
- 2. **Confidence**: Am I 80%+ confident? NO → Load P0 guides
479
- 3. **Load**: P0 (required) first, then P1 (optional) only if needed
480
- 4. **Execute**: Apply patterns, follow critical rules, track success indicators
481
- 5. **Validate**: All checks must pass before delivery
482
- 6. **Stuck?**: Check [Troubleshooting](#-troubleshooting-quick-reference), load more guides, or ask user
483
-
484
- ### Quality Standards (Non-Negotiable)
485
-
486
- <!-- FILL IN: Document quality requirements -->
487
-
488
- - No hardcoded secrets (use environment variables)
489
- - No placeholders/TODOs in delivered code
490
- - [Security requirement]
491
- - [Architecture requirement]
492
- - [Performance requirement]
493
- - Type safety on all functions (if applicable)
494
- - Specific exception handling (no bare catches)
224
+ ### Workflow
225
+ 1. **Parse** Match intent to Category (Task Classifier)
226
+ 2. **Load** Read P0 guides for matched categories
227
+ 3. **Check** Confidence 80%? No → load more or ask user
228
+ 4. **Execute** Apply patterns from guides
229
+ 5. **Validate** Checklist must pass
230
+ 6. **Deliver**
495
231
 
496
232
  ### When to Ask User
497
- - **Ambiguous requirements**: Multiple valid approaches possible
498
- - **Low confidence**: < 80% after reading P0+P1 guides
499
- - **Missing information**: Need clarification on scope/approach
500
- - **High complexity**: Task involves architectural decisions
501
- - **Policy unclear**: Unsure if testing/git/other policy applies
502
-
503
- ### Confidence Calibration
504
- - **90%+ confident**: Proceed with execution, minimal guide lookup
505
- - **80-89% confident**: Review quick reference tables, proceed
506
- - **70-79% confident**: Load P0 guides, then re-assess
507
- - **< 70% confident**: Load P0+P1 guides, ask user if still unclear
233
+ - Ambiguous requirements
234
+ - Low confidence after reading guides
235
+ - Missing information
236
+ - Unsure if policy applies
508
237
 
509
- **Production Ready**: Deliver complete, tested, secure solutions without shortcuts.
238
+ ---
510
239
 
511
- **Questions?** Always better to ask than assume - ask for clarification when unsure.
240
+ <!--
241
+ ═══════════════════════════════════════════════════════════════════════════════
242
+ FINAL CHECKLIST BEFORE DELIVERING POPULATED CLAUDE.md:
243
+ ═══════════════════════════════════════════════════════════════════════════════
244
+ [ ] All [PLACEHOLDER] values replaced with actual project data
245
+ [ ] All [PLACEHOLDER?] either replaced or deleted with their rows/sections
246
+ [ ] All <!-- INSTRUCTION --> comments removed
247
+ [ ] Guide paths verified to exist
248
+ [ ] Commands verified from config files
249
+ [ ] Empty/optional sections deleted if not applicable
250
+ [ ] No template artifacts remain
251
+ ═══════════════════════════════════════════════════════════════════════════════
252
+ -->