@proflandrigan/shards 1.1.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 (397) hide show
  1. package/README.md +475 -0
  2. package/package.json +37 -0
  3. package/src/agents/academic.md +276 -0
  4. package/src/agents/ai-engineer.md +377 -0
  5. package/src/agents/analytics-engineer.md +364 -0
  6. package/src/agents/applied-ml-scientist.md +410 -0
  7. package/src/agents/backend-engineer.md +255 -0
  8. package/src/agents/bi-engineer.md +333 -0
  9. package/src/agents/data-analyst.md +343 -0
  10. package/src/agents/data-engineer.md +260 -0
  11. package/src/agents/data-modeller.md +386 -0
  12. package/src/agents/data-scientist.md +366 -0
  13. package/src/agents/deep-learning-engineer.md +389 -0
  14. package/src/agents/ml-engineer.md +424 -0
  15. package/src/agents/mlops-engineer.md +339 -0
  16. package/src/agents/researcher.md +187 -0
  17. package/src/agents/specific_instructions/academic/critical_review.md +263 -0
  18. package/src/agents/specific_instructions/academic/report.md +113 -0
  19. package/src/agents/specific_instructions/ai_engineer/advise.md +162 -0
  20. package/src/agents/specific_instructions/ai_engineer/bi_engineer_handoff.md +86 -0
  21. package/src/agents/specific_instructions/ai_engineer/experiment.md +471 -0
  22. package/src/agents/specific_instructions/ai_engineer/experiment_ui_mode.md +44 -0
  23. package/src/agents/specific_instructions/ai_engineer/phases/index.md +45 -0
  24. package/src/agents/specific_instructions/ai_engineer/phases/phase-1.md +55 -0
  25. package/src/agents/specific_instructions/ai_engineer/phases/phase-2.md +86 -0
  26. package/src/agents/specific_instructions/ai_engineer/phases/phase-3.md +96 -0
  27. package/src/agents/specific_instructions/ai_engineer/phases/phase-4.md +138 -0
  28. package/src/agents/specific_instructions/ai_engineer/phases/phase-5.md +157 -0
  29. package/src/agents/specific_instructions/ai_engineer/phases/phase-6.md +196 -0
  30. package/src/agents/specific_instructions/ai_engineer/phases/phase-7.md +313 -0
  31. package/src/agents/specific_instructions/ai_engineer/phases.md +1011 -0
  32. package/src/agents/specific_instructions/ai_engineer/prompt_lab.md +161 -0
  33. package/src/agents/specific_instructions/ai_engineer/prompt_lab_ui_mode.md +28 -0
  34. package/src/agents/specific_instructions/ai_engineer/research.md +393 -0
  35. package/src/agents/specific_instructions/ai_engineer/research_ui_mode.md +66 -0
  36. package/src/agents/specific_instructions/ai_engineer/review.md +159 -0
  37. package/src/agents/specific_instructions/ai_engineer/validation_checklist.md +182 -0
  38. package/src/agents/specific_instructions/analytics_engineer/advise.md +155 -0
  39. package/src/agents/specific_instructions/analytics_engineer/bi_engineer_handoff.md +91 -0
  40. package/src/agents/specific_instructions/analytics_engineer/data_analyst_handoff.md +84 -0
  41. package/src/agents/specific_instructions/analytics_engineer/deep_phases.md +818 -0
  42. package/src/agents/specific_instructions/analytics_engineer/phases_deep/index.md +24 -0
  43. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-1.md +77 -0
  44. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-2.md +106 -0
  45. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-3.md +93 -0
  46. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-4.md +79 -0
  47. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-5.md +61 -0
  48. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-6.md +45 -0
  49. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-7.md +235 -0
  50. package/src/agents/specific_instructions/analytics_engineer/phases_deep/phase-8.md +221 -0
  51. package/src/agents/specific_instructions/analytics_engineer/phases_quick/index.md +19 -0
  52. package/src/agents/specific_instructions/analytics_engineer/phases_quick/phase-1.md +47 -0
  53. package/src/agents/specific_instructions/analytics_engineer/phases_quick/phase-2.md +78 -0
  54. package/src/agents/specific_instructions/analytics_engineer/quick_phases.md +112 -0
  55. package/src/agents/specific_instructions/analytics_engineer/review.md +167 -0
  56. package/src/agents/specific_instructions/analytics_engineer/service_mode.md +369 -0
  57. package/src/agents/specific_instructions/analytics_engineer/ui_mode.md +45 -0
  58. package/src/agents/specific_instructions/analytics_engineer/update.md +162 -0
  59. package/src/agents/specific_instructions/analytics_engineer/validation_checklist.md +121 -0
  60. package/src/agents/specific_instructions/applied_ml_scientist/advise.md +143 -0
  61. package/src/agents/specific_instructions/applied_ml_scientist/phases/index.md +21 -0
  62. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-1.md +51 -0
  63. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-2.md +66 -0
  64. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-3.md +113 -0
  65. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-4.md +104 -0
  66. package/src/agents/specific_instructions/applied_ml_scientist/phases/phase-5.md +156 -0
  67. package/src/agents/specific_instructions/applied_ml_scientist/phases.md +428 -0
  68. package/src/agents/specific_instructions/applied_ml_scientist/research.md +379 -0
  69. package/src/agents/specific_instructions/applied_ml_scientist/review.md +142 -0
  70. package/src/agents/specific_instructions/applied_ml_scientist/validation_checklist.md +136 -0
  71. package/src/agents/specific_instructions/backend_engineer/clean.md +149 -0
  72. package/src/agents/specific_instructions/backend_engineer/review.md +91 -0
  73. package/src/agents/specific_instructions/backend_engineer/review_checklist.md +54 -0
  74. package/src/agents/specific_instructions/backend_engineer/service_mode.md +67 -0
  75. package/src/agents/specific_instructions/bi_engineer/advise.md +137 -0
  76. package/src/agents/specific_instructions/bi_engineer/data_analyst_handoff.md +77 -0
  77. package/src/agents/specific_instructions/bi_engineer/incoming_handoff.md +45 -0
  78. package/src/agents/specific_instructions/bi_engineer/phases/index.md +20 -0
  79. package/src/agents/specific_instructions/bi_engineer/phases/phase-1.md +164 -0
  80. package/src/agents/specific_instructions/bi_engineer/phases/phase-2.md +92 -0
  81. package/src/agents/specific_instructions/bi_engineer/phases/phase-3.md +121 -0
  82. package/src/agents/specific_instructions/bi_engineer/phases/phase-4.md +106 -0
  83. package/src/agents/specific_instructions/bi_engineer/phases.md +451 -0
  84. package/src/agents/specific_instructions/bi_engineer/review.md +166 -0
  85. package/src/agents/specific_instructions/bi_engineer/update.md +147 -0
  86. package/src/agents/specific_instructions/bi_engineer/validation_checklist.md +124 -0
  87. package/src/agents/specific_instructions/data_analyst/advise.md +138 -0
  88. package/src/agents/specific_instructions/data_analyst/explain.md +221 -0
  89. package/src/agents/specific_instructions/data_analyst/incoming_handoff.md +40 -0
  90. package/src/agents/specific_instructions/data_analyst/phases/index.md +20 -0
  91. package/src/agents/specific_instructions/data_analyst/phases/phase-1.md +159 -0
  92. package/src/agents/specific_instructions/data_analyst/phases/phase-2.md +112 -0
  93. package/src/agents/specific_instructions/data_analyst/phases/phase-3.md +265 -0
  94. package/src/agents/specific_instructions/data_analyst/phases/phase-4.md +100 -0
  95. package/src/agents/specific_instructions/data_analyst/phases.md +501 -0
  96. package/src/agents/specific_instructions/data_analyst/review.md +138 -0
  97. package/src/agents/specific_instructions/data_analyst/ui_mode.md +26 -0
  98. package/src/agents/specific_instructions/data_analyst/update.md +144 -0
  99. package/src/agents/specific_instructions/data_analyst/validation_checklist.md +95 -0
  100. package/src/agents/specific_instructions/data_engineer/advise.md +137 -0
  101. package/src/agents/specific_instructions/data_engineer/phases.md +466 -0
  102. package/src/agents/specific_instructions/data_engineer/phases_deep/index.md +23 -0
  103. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-1.md +49 -0
  104. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-2.md +93 -0
  105. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-3.md +55 -0
  106. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-4.md +48 -0
  107. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-5.md +40 -0
  108. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-6.md +102 -0
  109. package/src/agents/specific_instructions/data_engineer/phases_deep/phase-7.md +87 -0
  110. package/src/agents/specific_instructions/data_engineer/phases_quick/index.md +19 -0
  111. package/src/agents/specific_instructions/data_engineer/phases_quick/phase-1.md +45 -0
  112. package/src/agents/specific_instructions/data_engineer/phases_quick/phase-2.md +54 -0
  113. package/src/agents/specific_instructions/data_engineer/review.md +135 -0
  114. package/src/agents/specific_instructions/data_engineer/validation_checklist.md +136 -0
  115. package/src/agents/specific_instructions/data_modeller/advise.md +137 -0
  116. package/src/agents/specific_instructions/data_modeller/phases.md +581 -0
  117. package/src/agents/specific_instructions/data_modeller/phases_deep/index.md +23 -0
  118. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-1.md +52 -0
  119. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-2.md +113 -0
  120. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-3.md +47 -0
  121. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-4.md +51 -0
  122. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-5.md +45 -0
  123. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-6.md +105 -0
  124. package/src/agents/specific_instructions/data_modeller/phases_deep/phase-7.md +136 -0
  125. package/src/agents/specific_instructions/data_modeller/phases_quick/index.md +19 -0
  126. package/src/agents/specific_instructions/data_modeller/phases_quick/phase-1.md +47 -0
  127. package/src/agents/specific_instructions/data_modeller/phases_quick/phase-2.md +65 -0
  128. package/src/agents/specific_instructions/data_modeller/review.md +141 -0
  129. package/src/agents/specific_instructions/data_modeller/service_mode.md +218 -0
  130. package/src/agents/specific_instructions/data_modeller/validation_checklist.md +125 -0
  131. package/src/agents/specific_instructions/data_scientist/advise.md +158 -0
  132. package/src/agents/specific_instructions/data_scientist/bi_engineer_handoff.md +63 -0
  133. package/src/agents/specific_instructions/data_scientist/experiment.md +482 -0
  134. package/src/agents/specific_instructions/data_scientist/experiment_ui_mode.md +44 -0
  135. package/src/agents/specific_instructions/data_scientist/explain.md +247 -0
  136. package/src/agents/specific_instructions/data_scientist/greenfield_data.md +35 -0
  137. package/src/agents/specific_instructions/data_scientist/ml_engineer_handoff.md +52 -0
  138. package/src/agents/specific_instructions/data_scientist/notebook_walkthrough.md +76 -0
  139. package/src/agents/specific_instructions/data_scientist/phases/index.md +24 -0
  140. package/src/agents/specific_instructions/data_scientist/phases/phase-1.md +45 -0
  141. package/src/agents/specific_instructions/data_scientist/phases/phase-2.md +67 -0
  142. package/src/agents/specific_instructions/data_scientist/phases/phase-3.md +89 -0
  143. package/src/agents/specific_instructions/data_scientist/phases/phase-4.md +143 -0
  144. package/src/agents/specific_instructions/data_scientist/phases/phase-5.md +71 -0
  145. package/src/agents/specific_instructions/data_scientist/phases/phase-6.md +239 -0
  146. package/src/agents/specific_instructions/data_scientist/phases/phase-7.md +207 -0
  147. package/src/agents/specific_instructions/data_scientist/phases.md +651 -0
  148. package/src/agents/specific_instructions/data_scientist/research.md +345 -0
  149. package/src/agents/specific_instructions/data_scientist/research_ui_mode.md +52 -0
  150. package/src/agents/specific_instructions/data_scientist/review.md +136 -0
  151. package/src/agents/specific_instructions/data_scientist/service_mode.md +247 -0
  152. package/src/agents/specific_instructions/data_scientist/validation_checklist.md +183 -0
  153. package/src/agents/specific_instructions/deep_learning_engineer/advise.md +145 -0
  154. package/src/agents/specific_instructions/deep_learning_engineer/phases/index.md +21 -0
  155. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-1.md +74 -0
  156. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-2.md +98 -0
  157. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-3.md +76 -0
  158. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-4.md +128 -0
  159. package/src/agents/specific_instructions/deep_learning_engineer/phases/phase-5.md +292 -0
  160. package/src/agents/specific_instructions/deep_learning_engineer/phases.md +567 -0
  161. package/src/agents/specific_instructions/deep_learning_engineer/research.md +389 -0
  162. package/src/agents/specific_instructions/deep_learning_engineer/review.md +155 -0
  163. package/src/agents/specific_instructions/deep_learning_engineer/validation_checklist.md +147 -0
  164. package/src/agents/specific_instructions/ml_engineer/advise.md +174 -0
  165. package/src/agents/specific_instructions/ml_engineer/bi_engineer_handoff.md +71 -0
  166. package/src/agents/specific_instructions/ml_engineer/experiment.md +474 -0
  167. package/src/agents/specific_instructions/ml_engineer/experiment_ui_mode.md +44 -0
  168. package/src/agents/specific_instructions/ml_engineer/notebook_walkthrough.md +75 -0
  169. package/src/agents/specific_instructions/ml_engineer/phases/index.md +25 -0
  170. package/src/agents/specific_instructions/ml_engineer/phases/phase-1.md +49 -0
  171. package/src/agents/specific_instructions/ml_engineer/phases/phase-2.md +75 -0
  172. package/src/agents/specific_instructions/ml_engineer/phases/phase-3.md +124 -0
  173. package/src/agents/specific_instructions/ml_engineer/phases/phase-4.md +279 -0
  174. package/src/agents/specific_instructions/ml_engineer/phases/phase-5.md +160 -0
  175. package/src/agents/specific_instructions/ml_engineer/phases/phase-6-5.md +170 -0
  176. package/src/agents/specific_instructions/ml_engineer/phases/phase-6.md +295 -0
  177. package/src/agents/specific_instructions/ml_engineer/phases/phase-7.md +337 -0
  178. package/src/agents/specific_instructions/ml_engineer/phases.md +1068 -0
  179. package/src/agents/specific_instructions/ml_engineer/research.md +437 -0
  180. package/src/agents/specific_instructions/ml_engineer/research_ui_mode.md +71 -0
  181. package/src/agents/specific_instructions/ml_engineer/review.md +187 -0
  182. package/src/agents/specific_instructions/ml_engineer/service_mode.md +273 -0
  183. package/src/agents/specific_instructions/ml_engineer/validation_checklist.md +185 -0
  184. package/src/agents/specific_instructions/mlops_engineer/advise.md +139 -0
  185. package/src/agents/specific_instructions/mlops_engineer/phases/index.md +23 -0
  186. package/src/agents/specific_instructions/mlops_engineer/phases/phase-1.md +52 -0
  187. package/src/agents/specific_instructions/mlops_engineer/phases/phase-2.md +86 -0
  188. package/src/agents/specific_instructions/mlops_engineer/phases/phase-3.md +105 -0
  189. package/src/agents/specific_instructions/mlops_engineer/phases/phase-4.md +128 -0
  190. package/src/agents/specific_instructions/mlops_engineer/phases/phase-5.md +106 -0
  191. package/src/agents/specific_instructions/mlops_engineer/phases/phase-6.md +128 -0
  192. package/src/agents/specific_instructions/mlops_engineer/phases/phase-7.md +144 -0
  193. package/src/agents/specific_instructions/mlops_engineer/phases.md +671 -0
  194. package/src/agents/specific_instructions/mlops_engineer/review.md +164 -0
  195. package/src/agents/specific_instructions/mlops_engineer/service_mode.md +81 -0
  196. package/src/agents/specific_instructions/mlops_engineer/validation_checklist.md +151 -0
  197. package/src/agents/specific_instructions/researcher/critical_review.md +292 -0
  198. package/src/agents/specific_instructions/researcher/review_checklist.md +67 -0
  199. package/src/agents/specific_instructions/researcher/service_mode.md +224 -0
  200. package/src/agents/specific_instructions/shared/auto_verify_mode.md +141 -0
  201. package/src/agents/specific_instructions/shared/autonomous_research.md +1289 -0
  202. package/src/agents/specific_instructions/shared/behavioral_rules.md +36 -0
  203. package/src/agents/specific_instructions/shared/diverge_protocol.md +387 -0
  204. package/src/agents/specific_instructions/shared/engineering_guidelines.md +136 -0
  205. package/src/agents/specific_instructions/shared/experiment_versioning.md +184 -0
  206. package/src/agents/specific_instructions/shared/goal_mode.md +187 -0
  207. package/src/agents/specific_instructions/shared/incremental_testing.md +139 -0
  208. package/src/agents/specific_instructions/shared/intent_discovery.md +223 -0
  209. package/src/agents/specific_instructions/shared/join_path_protocol.md +168 -0
  210. package/src/agents/specific_instructions/shared/knowledge_checkpoint.md +83 -0
  211. package/src/agents/specific_instructions/shared/knowledge_harvest.md +220 -0
  212. package/src/agents/specific_instructions/shared/knowledge_retrieval.md +100 -0
  213. package/src/agents/specific_instructions/shared/notebook_walkthrough_protocol.md +367 -0
  214. package/src/agents/specific_instructions/shared/reviewer_verdict_protocol.md +74 -0
  215. package/src/agents/specific_instructions/shared/swarm_protocol.md +97 -0
  216. package/src/agents/specific_instructions/shared/validation_protocol.md +139 -0
  217. package/src/agents/specific_instructions/syn/arbiter.md +140 -0
  218. package/src/agents/specific_instructions/syn/brainstorm.md +550 -0
  219. package/src/agents/specific_instructions/syn/code_review.md +232 -0
  220. package/src/agents/specific_instructions/syn/diff.md +239 -0
  221. package/src/agents/specific_instructions/syn/final_review.md +65 -0
  222. package/src/agents/specific_instructions/syn/fixer.md +240 -0
  223. package/src/agents/specific_instructions/syn/free_form.md +130 -0
  224. package/src/agents/specific_instructions/syn/knowledge.md +468 -0
  225. package/src/agents/specific_instructions/syn/notebook_walkthrough.md +78 -0
  226. package/src/agents/specific_instructions/syn/panel_review.md +634 -0
  227. package/src/agents/specific_instructions/syn/pm.md +453 -0
  228. package/src/agents/specific_instructions/syn/pr_review.md +255 -0
  229. package/src/agents/specific_instructions/syn/slides.md +417 -0
  230. package/src/agents/syn.md +729 -0
  231. package/src/commands/academic.md +41 -0
  232. package/src/commands/ai-engineer.md +45 -0
  233. package/src/commands/analytics-engineer.md +48 -0
  234. package/src/commands/applied-ml-scientist.md +45 -0
  235. package/src/commands/backend-engineer.md +35 -0
  236. package/src/commands/bi-engineer.md +40 -0
  237. package/src/commands/brainstorm.md +24 -0
  238. package/src/commands/data-analyst.md +38 -0
  239. package/src/commands/data-engineer.md +37 -0
  240. package/src/commands/data-modeller.md +38 -0
  241. package/src/commands/data-scientist.md +38 -0
  242. package/src/commands/deep-learning-engineer.md +47 -0
  243. package/src/commands/end.md +49 -0
  244. package/src/commands/knowledge.md +24 -0
  245. package/src/commands/ml-engineer.md +42 -0
  246. package/src/commands/mlops-engineer.md +47 -0
  247. package/src/commands/notebook-walkthrough.md +58 -0
  248. package/src/commands/researcher.md +40 -0
  249. package/src/commands/resume.md +57 -0
  250. package/src/commands/review-pr.md +26 -0
  251. package/src/commands/shards-guide.md +41 -0
  252. package/src/commands/shards-ui.md +32 -0
  253. package/src/commands/shards.md +41 -0
  254. package/src/docs/01-getting-started/concepts.md +109 -0
  255. package/src/docs/01-getting-started/first-session.md +79 -0
  256. package/src/docs/01-getting-started/install.md +61 -0
  257. package/src/docs/02-agents/academic.md +71 -0
  258. package/src/docs/02-agents/ai-engineer.md +78 -0
  259. package/src/docs/02-agents/analytics-engineer.md +58 -0
  260. package/src/docs/02-agents/applied-ml-scientist.md +59 -0
  261. package/src/docs/02-agents/backend-engineer.md +58 -0
  262. package/src/docs/02-agents/bi-engineer.md +65 -0
  263. package/src/docs/02-agents/data-analyst.md +67 -0
  264. package/src/docs/02-agents/data-engineer.md +57 -0
  265. package/src/docs/02-agents/data-modeller.md +51 -0
  266. package/src/docs/02-agents/data-scientist.md +78 -0
  267. package/src/docs/02-agents/deep-learning-engineer.md +64 -0
  268. package/src/docs/02-agents/ml-engineer.md +80 -0
  269. package/src/docs/02-agents/mlops-engineer.md +59 -0
  270. package/src/docs/02-agents/overview.md +62 -0
  271. package/src/docs/02-agents/researcher.md +73 -0
  272. package/src/docs/02-agents/syn.md +88 -0
  273. package/src/docs/03-protocols/auto-verify.md +82 -0
  274. package/src/docs/03-protocols/autonomous-research.md +59 -0
  275. package/src/docs/03-protocols/behavioral-rules.md +35 -0
  276. package/src/docs/03-protocols/diverge.md +50 -0
  277. package/src/docs/03-protocols/engineering-guidelines.md +56 -0
  278. package/src/docs/03-protocols/experiment-versioning.md +38 -0
  279. package/src/docs/03-protocols/gate-pattern.md +65 -0
  280. package/src/docs/03-protocols/incremental-testing.md +68 -0
  281. package/src/docs/03-protocols/join-path.md +46 -0
  282. package/src/docs/03-protocols/knowledge-ledger.md +70 -0
  283. package/src/docs/03-protocols/reviewer-verdicts.md +39 -0
  284. package/src/docs/03-protocols/swarm.md +40 -0
  285. package/src/docs/03-protocols/validation.md +174 -0
  286. package/src/docs/04-ui/activity-bar.md +70 -0
  287. package/src/docs/04-ui/chat-pane.md +80 -0
  288. package/src/docs/04-ui/code-intel.md +62 -0
  289. package/src/docs/04-ui/file-editing.md +61 -0
  290. package/src/docs/04-ui/git.md +54 -0
  291. package/src/docs/04-ui/keybindings.md +79 -0
  292. package/src/docs/04-ui/knowledge-map.md +76 -0
  293. package/src/docs/04-ui/overview.md +93 -0
  294. package/src/docs/04-ui/panels.md +49 -0
  295. package/src/docs/04-ui/pinboard-selection.md +66 -0
  296. package/src/docs/04-ui/quick-open-palette.md +56 -0
  297. package/src/docs/04-ui/sessions.md +81 -0
  298. package/src/docs/04-ui/settings-permissions.md +56 -0
  299. package/src/docs/05-commands/reference.md +59 -0
  300. package/src/docs/06-outputs/directory-map.md +116 -0
  301. package/src/docs/07-workflows/ai-eval-first.md +57 -0
  302. package/src/docs/07-workflows/deep-study-to-production.md +76 -0
  303. package/src/docs/07-workflows/diverge-exploration.md +77 -0
  304. package/src/docs/07-workflows/quick-analysis.md +45 -0
  305. package/src/docs/08-integrations/claude-code-auto-mode.md +191 -0
  306. package/src/docs/08-integrations/google-slides.md +175 -0
  307. package/src/docs/README.md +30 -0
  308. package/src/docs/manifest.json +108 -0
  309. package/src/templates/analysis-template.md +20 -0
  310. package/src/templates/branch-report.md +46 -0
  311. package/src/templates/diff-report.md +88 -0
  312. package/src/templates/knowledge-index.md +7 -0
  313. package/src/templates/model-card-schema.json +186 -0
  314. package/src/templates/model-card-schema.md +88 -0
  315. package/src/templates/model-card.md +124 -0
  316. package/src/templates/project-plan.md +47 -0
  317. package/src/templates/project-specs.md +81 -0
  318. package/src/templates/report-template.md +43 -0
  319. package/src/templates/study-template.md +25 -0
  320. package/src/ui/cc-readonly.js +181 -0
  321. package/src/ui/chat-session.js +466 -0
  322. package/src/ui/css/base.css +136 -0
  323. package/src/ui/css/brainstorm.css +525 -0
  324. package/src/ui/css/chat.css +1405 -0
  325. package/src/ui/css/editor.css +546 -0
  326. package/src/ui/css/eval-dashboard.css +157 -0
  327. package/src/ui/css/experiment.css +237 -0
  328. package/src/ui/css/guide.css +186 -0
  329. package/src/ui/css/knowledge-map.css +383 -0
  330. package/src/ui/css/layout.css +431 -0
  331. package/src/ui/css/model-card.css +161 -0
  332. package/src/ui/css/notebook-walkthrough.css +271 -0
  333. package/src/ui/css/pr-review.css +403 -0
  334. package/src/ui/css/prompt-lab.css +325 -0
  335. package/src/ui/css/sessions.css +258 -0
  336. package/src/ui/css/sidebar.css +661 -0
  337. package/src/ui/css/terminal.css +113 -0
  338. package/src/ui/css/theme-light.css +542 -0
  339. package/src/ui/index.html +389 -0
  340. package/src/ui/js/agents.js +32 -0
  341. package/src/ui/js/bookmarks.js +230 -0
  342. package/src/ui/js/chat.js +1776 -0
  343. package/src/ui/js/code-intel.js +328 -0
  344. package/src/ui/js/command-palette.js +142 -0
  345. package/src/ui/js/events.js +591 -0
  346. package/src/ui/js/explorer.js +317 -0
  347. package/src/ui/js/file-view.js +477 -0
  348. package/src/ui/js/git.js +536 -0
  349. package/src/ui/js/guide.js +198 -0
  350. package/src/ui/js/hud.js +75 -0
  351. package/src/ui/js/init.js +351 -0
  352. package/src/ui/js/knowledge-map.js +906 -0
  353. package/src/ui/js/markdown.js +114 -0
  354. package/src/ui/js/monaco.js +164 -0
  355. package/src/ui/js/notebook-walkthrough.js +272 -0
  356. package/src/ui/js/notebook.js +448 -0
  357. package/src/ui/js/panels.js +2681 -0
  358. package/src/ui/js/pinboard.js +186 -0
  359. package/src/ui/js/quick-open.js +164 -0
  360. package/src/ui/js/selection-context.js +131 -0
  361. package/src/ui/js/sessions.js +256 -0
  362. package/src/ui/js/settings.js +476 -0
  363. package/src/ui/js/split-view.js +82 -0
  364. package/src/ui/js/state.js +343 -0
  365. package/src/ui/js/table.js +161 -0
  366. package/src/ui/js/tabs.js +284 -0
  367. package/src/ui/js/tabular.js +125 -0
  368. package/src/ui/js/terminal.js +354 -0
  369. package/src/ui/js/timeline.js +137 -0
  370. package/src/ui/js/utils.js +293 -0
  371. package/src/ui/notebook-kernel.py +790 -0
  372. package/src/ui/open-browser.js +55 -0
  373. package/src/ui/permission-pattern.js +42 -0
  374. package/src/ui/relay.js +513 -0
  375. package/src/ui/server.js +3072 -0
  376. package/src/ui/session-index.js +225 -0
  377. package/src/ui/shards_icon.png +0 -0
  378. package/src/ui/spawn-server.js +41 -0
  379. package/src/ui/symbol-index.js +813 -0
  380. package/src/ui/ui-push.js +177 -0
  381. package/tools/gate-hook/VALIDATION_SPEC.md +273 -0
  382. package/tools/gate-hook/__tests__/auto-verify.test.js +343 -0
  383. package/tools/gate-hook/auto-allowlist.js +179 -0
  384. package/tools/gate-hook/auto-state.js +68 -0
  385. package/tools/gate-hook/classify.js +21 -0
  386. package/tools/gate-hook/log.js +57 -0
  387. package/tools/gate-hook/parser.js +205 -0
  388. package/tools/gate-hook/sql-guard.js +230 -0
  389. package/tools/gate-hook/state.js +170 -0
  390. package/tools/gate-hook/sweep.js +139 -0
  391. package/tools/gate-hook/transcript.js +45 -0
  392. package/tools/gate-hook/validation.js +321 -0
  393. package/tools/gate-hook.js +475 -0
  394. package/tools/install.js +914 -0
  395. package/tools/shards-gates.js +311 -0
  396. package/tools/shards-sessions.js +261 -0
  397. package/tools/shards-ui.js +377 -0
@@ -0,0 +1,191 @@
1
+ # Claude Code Auto Mode
2
+
3
+ Claude Code's auto mode auto-approves tool calls via a server-side classifier instead of prompting per action. It composes well with Shards: gates remain as workflow checkpoints, and auto mode eliminates the per-command friction between them.
4
+
5
+ **You do not need auto mode to get a smooth Shards experience.** The Shards installer ships narrow `permissions.allow` rules that pre-approve common specialist operations (`dbt build`, `pytest`, `jupyter nbconvert --execute`, file writes scoped to output directories, etc.) — these work in every permission mode and cover most of the friction auto mode would remove. If you're on a plan that supports auto mode it's a useful additional polish; if you're not, skip to [Without auto mode](#without-auto-mode) below and you'll have nearly the same experience.
6
+
7
+ This page documents the recommended configuration, the composition with Shards gates, and the limitations.
8
+
9
+ ## What it is
10
+
11
+ Auto mode is one of Claude Code's permission modes (alongside `default`, `acceptEdits`, `plan`, `dontAsk`, `bypassPermissions`). When active, every tool call is evaluated by a classifier that auto-approves working-directory-bound operations and routes anything that looks risky (external network requests, production deploys, force pushes, irreversible destruction) back through a permission prompt. The classifier reads your `CLAUDE.md` and your `autoMode.*` settings to understand what "trusted" means for your environment.
12
+
13
+ It also nudges Claude to keep working without stopping for clarifying questions, which composes naturally with how Shards specialists run multi-step phases.
14
+
15
+ For the full reference see [Claude Code's permission modes docs](https://code.claude.com/docs/en/permission-modes) and [Configure auto mode](https://code.claude.com/docs/en/auto-mode-config).
16
+
17
+ ## Why it pairs well with Shards
18
+
19
+ Two systems doing different jobs:
20
+
21
+ | Concern | Handled by |
22
+ |---------|------------|
23
+ | Should this individual tool call execute? | Claude Code's permission system + (when active) auto mode classifier |
24
+ | Should the agent advance from Phase N to Phase N+1? | Shards `::GATE::` hook |
25
+
26
+ Auto mode collapses the per-tool-call approval noise between gates. The gates themselves stay human-confirmed — the user reviews each phase's plan or output before the specialist proceeds.
27
+
28
+ A representative mid-session sequence under auto mode might look like:
29
+
30
+ 1. User runs `/ml-engineer build a churn classifier`
31
+ 2. Specialist completes Phase 1 (problem framing) — emits gate fence — **pauses for user review** ⚠️
32
+ 3. User confirms
33
+ 4. Specialist executes Phase 2 (data exploration) — runs `bq query --dry_run`, reads schemas, writes preliminary notebook — **no prompts**
34
+ 5. Specialist emits Phase 2 gate fence — **pauses for user review** ⚠️
35
+ 6. User confirms
36
+ 7. Specialist executes Phase 3 (modelling) — trains baseline, runs `pytest`, writes model card — **no prompts**
37
+ 8. ...
38
+
39
+ The classifier handles the safety floor (would refuse to run, say, a `terraform apply` against production even if the specialist tried). The Shards installer pre-approves common specialist Bash and Edit patterns so the classifier doesn't even see them.
40
+
41
+ ## Plan and account requirements
42
+
43
+ Anthropic gates auto mode by plan:
44
+
45
+ - **Plan**: Max, Team, Enterprise, or API. **Not available on Pro.**
46
+ - **Model**: Claude Sonnet 4.6, Opus 4.6, or Opus 4.7
47
+ - **Provider**: Anthropic API only. Not available on Bedrock, Vertex, or Foundry.
48
+ - **Admin**: on Team and Enterprise, an admin must enable it in Claude Code admin settings
49
+
50
+ This is an Anthropic product decision, not a Shards limitation. The classifier is a second model call per tool use (cost) and the safety surface is broader when no one is watching each action. If you're on a plan that doesn't qualify, the [Without auto mode](#without-auto-mode) path below gives you nearly the same experience using `acceptEdits` mode plus the allow rules Shards ships.
51
+
52
+ ## Recommended setup
53
+
54
+ ### `~/.claude/settings.json`
55
+
56
+ ⚠️ **Important:** `permissions.defaultMode: "auto"` only works in your **user-level** settings file (`~/.claude/settings.json`). Setting it in the project's `.claude/settings.json` is silently ignored — the project cannot grant itself auto mode.
57
+
58
+ ```json
59
+ {
60
+ "permissions": {
61
+ "defaultMode": "auto"
62
+ },
63
+ "autoMode": {
64
+ "environment": [
65
+ "$defaults",
66
+ "Shards workspaces: any project containing a `.shards/` directory uses the Shards agent framework. Reads from and writes to project subdirectories (analysis/, studies/, models/, services/, data_models/, dashboards/, research/, presentations/, panels/, fixes/, brainstorm/) and `.shards/` are routine specialist work.",
67
+ "Warehouse access: dbt commands (run, build, test, show, ls, compile), bq read-only queries, and SELECT-only psql/snowsql/duckdb invocations against developer-configured (non-production) warehouses are routine validation operations.",
68
+ "Notebook execution: `jupyter nbconvert --execute` on notebooks under analysis/, studies/, models/, research/, services/ is routine validation work."
69
+ ]
70
+ }
71
+ }
72
+ ```
73
+
74
+ The `"$defaults"` token splices in the built-in environment entries (trusted working directory and configured git remotes). Without it, your custom entries replace the defaults entirely.
75
+
76
+ ### The project-level pieces (already in place)
77
+
78
+ The Shards installer ships these so you don't have to configure them:
79
+
80
+ 1. **Narrow allow rules** in `.claude/settings.json`. The installed allowlist uses narrow `Bash(<cmd>:*)` and `Edit(<dir>/**)` patterns that survive auto mode's pruning of broad rules. Anything matching these rules bypasses the classifier entirely — fastest possible path.
81
+ 2. **A deny floor** that blocks force pushes, pushes to `main`/`master`, `sh -c`/`bash -c` evil-script execution, and `rm -rf --no-preserve-root`. Deny rules beat auto mode classifier approvals.
82
+ 3. **`ask` rules** for production-target dbt invocations that force a prompt even under auto mode.
83
+ 4. **A tool-call conventions section in `CLAUDE.md`** that primes the classifier on what counts as routine Shards work (file write scopes, routine commands, gate semantics).
84
+
85
+ Re-running `node tools/install.js` (or `npx github:proflandrigan/shards install` from a fresh project) backfills any of these that are missing without removing your customizations.
86
+
87
+ ## What auto mode blocks even under Shards
88
+
89
+ The classifier still blocks the following by default — Shards conventions do not override these:
90
+
91
+ - **Production deploys and migrations** — `dbt run --target prod`, `terraform apply`, `kubectl apply`, and similar
92
+ - **Force push, or push to `main`/`master`** — also blocked by Shards' deny rules
93
+ - **Mass deletion on cloud storage**
94
+ - **Granting IAM or repo permissions**
95
+ - **Downloading and executing code** (`curl ... | bash`)
96
+ - **Sending sensitive data to external endpoints**
97
+ - **Modifying shared infrastructure**
98
+
99
+ If the classifier blocks something routine for your environment that isn't covered by the default trusted list, add it to `autoMode.environment` in your user settings. Run `claude auto-mode config` to inspect the effective rules.
100
+
101
+ ## Footguns
102
+
103
+ ### Boundaries you state in conversation persist until lifted
104
+
105
+ If you tell Shards "don't push to remote until I approve," the classifier picks that up from the transcript and enforces it even when the default rules would allow a push. Useful for tightening behavior mid-session. But if context compaction removes the message that stated the boundary, the boundary is lost. For a hard guarantee, add a `deny` rule to your settings instead.
106
+
107
+ ### Broad allow rules get dropped
108
+
109
+ On entering auto mode, Claude Code drops `Bash(*)`, `PowerShell(*)`, wildcarded interpreters like `Bash(python*)`, package-manager run commands, and `Agent` allow rules. Narrow rules like `Bash(npm test)` carry over. The Shards installer only uses narrow rules, so this doesn't affect a stock install — but if you've added your own broad rules, they'll disappear in auto mode.
110
+
111
+ ### Subagent task descriptions are read by the classifier
112
+
113
+ A full Shards session is a depth-2 Task chain: Syn spawns a specialist; the specialist spawns Syn for final review. The classifier evaluates each Task spawn against the parent's transcript. Ambiguous task descriptions ("clean up the data") may trigger a prompt; specific ones ("Build a churn classifier under `studies/churn_v2/` using the customers and events tables") usually don't. Syn's spawn prompts to specialists already reference Shards conventions explicitly.
114
+
115
+ ### Production target invocations always pause
116
+
117
+ `dbt run --target prod*`, `dbt build --target prod*`, `dbt seed --target prod*`, and `dbt snapshot --target prod*` are in the Shards `ask` list — they force a prompt under every mode, including auto. This is intentional. To override, remove the ask rule from your project's `.claude/settings.json` (not recommended).
118
+
119
+ ### The 3-of-3 / 20-total fallback
120
+
121
+ If the classifier blocks an action 3 times in a row or 20 times total in one session, auto mode pauses and prompts resume. These thresholds aren't configurable. The signal usually means the classifier is missing context about your infrastructure — add the destination to `autoMode.environment` and re-run `claude auto-mode config` to confirm.
122
+
123
+ ## Composition matrix
124
+
125
+ What you see for a representative sequence (Read → `Bash(dbt show)` → `Bash(pytest)` → `Write studies/.../results.md` → `NotebookEdit studies/.../nb.ipynb`):
126
+
127
+ | Mode | Read | `dbt show` | `pytest` | `Write` | `NotebookEdit` | Phase gates |
128
+ |------|------|------------|----------|---------|----------------|-------------|
129
+ | `default` | auto-allowed | pre-approved | pre-approved* | pre-approved* | pre-approved* | pause for confirm |
130
+ | `acceptEdits` | auto-allowed | pre-approved | pre-approved* | pre-approved* | pre-approved* | pause for confirm |
131
+ | `auto` (Max/Team/Enterprise/API) | auto-allowed | pre-approved | pre-approved* | pre-approved* | pre-approved* | pause for confirm |
132
+
133
+ \* via Shards' shipped allow rules (`tools/install.js` `BASE_ALLOW`). Without them, `pytest`/`Write`/`NotebookEdit` would prompt under `default` mode and hit the classifier round-trip under `auto`.
134
+
135
+ Phase gates pause in every mode because the gate hook is its own enforcement layer, independent of CC's permission system.
136
+
137
+ ## Without auto mode
138
+
139
+ If you're on Pro, Bedrock, Vertex, or otherwise can't enable auto mode, the Shards-shipped allow rules already do most of the work. Two adjustments give you a session that's effectively indistinguishable from auto mode for routine specialist work:
140
+
141
+ ### 1. Switch to `acceptEdits` mode
142
+
143
+ Press `Shift+Tab` once from default mode (the status bar shows `⏵⏵ accept edits on`). This auto-approves:
144
+
145
+ - All file edits and writes in your working directory
146
+ - Common filesystem commands (`mkdir`, `touch`, `mv`, `cp`)
147
+
148
+ Combined with the Shards installer's narrow allow rules — which already pre-approve `dbt build/run/test/seed/snapshot`, `pytest`, `jupyter nbconvert --execute <output-dirs>`, scoped `mkdir`, and `Edit(<output-dir>/**)` — the only things that still prompt are genuinely novel operations the installer doesn't anticipate. That's the same end state auto mode gives you, just via deterministic rules instead of a classifier.
149
+
150
+ To make it persistent, set in your user-level `~/.claude/settings.json`:
151
+
152
+ ```json
153
+ {
154
+ "permissions": {
155
+ "defaultMode": "acceptEdits"
156
+ }
157
+ }
158
+ ```
159
+
160
+ ### 2. Use Auto-Verify Mode for bulk validation stretches
161
+
162
+ [Auto-Verify Mode](../03-protocols/auto-verify.md) is Shards' native mechanism for bracketing read-only verification work with a marker pair (`::AUTO-VERIFY:: ... ::ENDAUTO::`). Specialists emit these around bulk validation stretches (grain checks, fan-out validation, sample inspections) so the gate hook auto-approves dozens of nearly-identical reads. Scope-bounded by tool budget and TTL; you can halt at any time with a "stop" message.
163
+
164
+ Specialists already emit these markers at the right moments — you don't need to do anything; just let the workflow run.
165
+
166
+ ### 3. Add project-specific allow rules as needed
167
+
168
+ If your project uses a tool not in the default allowlist (a specific warehouse CLI, an internal build script, etc.), add narrow entries to `.claude/settings.json` `permissions.allow`. The `/permissions` slash command in Claude Code lists what's been pre-approved and lets you add rules interactively.
169
+
170
+ ### The friction comparison
171
+
172
+ | Operation | Default mode | `acceptEdits` + Shards rules | Auto mode + Shards rules |
173
+ |-----------|--------------|------------------------------|---------------------------|
174
+ | `Read studies/proj/notebook.ipynb` | none | none | none |
175
+ | `Bash(dbt show -m model_x)` | none (pre-approved) | none | none |
176
+ | `Bash(pytest tests/)` | **prompt** | none (pre-approved) | none |
177
+ | `Bash(dbt build -m model_x)` | **prompt** | none (pre-approved) | none |
178
+ | `Write studies/proj/results.md` | **prompt** | none | none |
179
+ | `NotebookEdit studies/proj/nb.ipynb` | **prompt** | none | none |
180
+ | `Bash(unknown novel command)` | **prompt** | **prompt** | classifier evaluates |
181
+ | Phase gate | **pause for confirm** | **pause for confirm** | **pause for confirm** |
182
+
183
+ The only meaningful difference between rows 2 and 3: auto mode classifier-evaluates the genuinely novel cases (and usually approves working-directory-bound operations), while `acceptEdits` prompts. For most Shards sessions where specialists stick to the predictable command patterns the installer covers, this difference is rarely felt.
184
+
185
+ ## See also
186
+
187
+ - [Auto-Verify Mode](../03-protocols/auto-verify.md) — Shards' scope-bounded auto-approval for read-only verification
188
+ - [The Gate Pattern](../03-protocols/gate-pattern.md) — Shards' phase boundary enforcement
189
+ - [Configure auto mode (Claude Code docs)](https://code.claude.com/docs/en/auto-mode-config)
190
+ - [Permission modes (Claude Code docs)](https://code.claude.com/docs/en/permission-modes)
191
+ - [Configure permissions (Claude Code docs)](https://code.claude.com/docs/en/permissions)
@@ -0,0 +1,175 @@
1
+ # Google Slides (Syn Slides Mode)
2
+
3
+ Syn's `[SL]` Slides Mode builds Google Slides decks directly. It's a Syn-native
4
+ mode (no specialist handoff) that drafts a slide-by-slide outline, polls the
5
+ relevant specialists for content gut-checks at two checkpoints, and uses a
6
+ Google Slides MCP to create and iterate on the deck.
7
+
8
+ This is the first **Integrations** page — a section reserved for Shards modes
9
+ that depend on external MCP servers.
10
+
11
+ ---
12
+
13
+ ## What it does
14
+
15
+ Slides Mode is for readout-style decks: exec briefings, study findings,
16
+ post-project demos, technical peer reviews. It is not for training material
17
+ or book-length presentations (slides over 40 hard-escalate; over 25 soft-warn).
18
+
19
+ Eight steps in the mode body, two gates:
20
+
21
+ 1. **Intake** — audience, purpose, source material, scope, tone, MCP availability
22
+ 2. **Outline draft** — Syn writes slide-by-slide outline directly into the spec doc
23
+ 3. **Outline review** — parallel Task calls to relevant specialists (BI Engineer, Data Analyst, ML Engineer, etc., depending on source material), each returning GOOD / CAUTION / TOO COMPLEX
24
+ 4. **Plan & gate** — show user the revised outline + verdicts; gate before any MCP write
25
+ 5. **Build** — call the MCP's `create_presentation` and `batch_update_presentation` tools
26
+ 6. **Build review** — second polling round; BI Engineer always, plus the Step 3 specialist for fidelity check
27
+ 7. **Iterate (optional)** — if Step 6 flagged issues, gate before applying revisions
28
+ 8. **Wrap** — finalize spec doc, optionally append a `## Presentation` block to the source project's `project-specs.md`
29
+
30
+ Each polling round is a single message with multiple parallel `Task` blocks,
31
+ mirroring Brainstorm Mode's pattern. Each specialist response is appended
32
+ verbatim to the spec doc as it returns.
33
+
34
+ The mode is **MCP-agnostic** — Syn detects available Slides tools by suffix
35
+ (`create_presentation`, `batch_update_presentation`, `get_presentation`)
36
+ regardless of which server's namespace they live under.
37
+
38
+ ---
39
+
40
+ ## Setup
41
+
42
+ Slides Mode requires a Google Slides MCP configured in your **user-level**
43
+ `~/.claude/settings.json`, not the project-level `.claude/settings.json`.
44
+ Shards manages project settings for hooks and permissions; MCPs are a
45
+ per-user concern.
46
+
47
+ ### Recommended servers
48
+
49
+ | Server | Notes |
50
+ |---|---|
51
+ | **Google's official Workspace MCP** | First-party, most durable choice. Supports Slides, Docs, Sheets, Drive, Gmail, Calendar in one server. |
52
+ | `taylorwilsdon/google_workspace_mcp` | Comprehensive community MCP covering all of Workspace. |
53
+ | `matteoantoci/google-slides-mcp` | Slides-only, leaner footprint. |
54
+ | Composio / StackOne | Hosted options that handle OAuth and token refresh for you. |
55
+
56
+ Slides Mode does not care which one you pick — it discovers tools at runtime.
57
+ Pick whichever fits your auth posture and breadth needs.
58
+
59
+ ### Example configuration
60
+
61
+ Add an `mcpServers` block to `~/.claude/settings.json` (substitute the
62
+ command, args, and env for your chosen server's docs):
63
+
64
+ ```json
65
+ {
66
+ "mcpServers": {
67
+ "google_workspace": {
68
+ "command": "uvx",
69
+ "args": ["google-workspace-mcp"],
70
+ "env": {
71
+ "GOOGLE_OAUTH_CLIENT_ID": "...",
72
+ "GOOGLE_OAUTH_CLIENT_SECRET": "..."
73
+ }
74
+ }
75
+ }
76
+ }
77
+ ```
78
+
79
+ First-time use will trigger a Google OAuth flow in your browser. Slides Mode
80
+ detects auth-not-authenticated errors and surfaces the auth flow URL clearly
81
+ rather than failing silently.
82
+
83
+ ---
84
+
85
+ ## Specialist polling routing
86
+
87
+ Step 3 (outline review) routes to specialists based on source material:
88
+
89
+ | Source / topic | Always poll | Add when |
90
+ |---|---|---|
91
+ | ML model / training run | ml-engineer, data-scientist | + academic if user-facing |
92
+ | Data analysis / EDA | data-analyst, researcher | + data-scientist if includes modelling claims |
93
+ | Dashboard / BI tool | bi-engineer, data-analyst | — |
94
+ | Pipeline / infra / mart | data-engineer or analytics-engineer, mlops-engineer | + data-modeller if grain/schema in scope |
95
+ | LLM / RAG / agent system | ai-engineer | + academic for ethics; + researcher for eval methodology |
96
+ | DL architecture / novel framework | deep-learning-engineer, applied-ml-scientist | — |
97
+ | **Always optionally poll** | **academic** | for cognitive load, audience fit, message clarity |
98
+
99
+ The academic shard is worth pulling in any time the audience is non-technical
100
+ or external — it specializes in cognitive load and message clarity.
101
+
102
+ Step 6 (build review) is lighter: BI Engineer always (visual layout, density),
103
+ plus the Step 3 domain specialist for a fidelity check.
104
+
105
+ ### Trivial-deck exception
106
+
107
+ ≤5 slides AND internal status / agenda format → both polling rounds skip.
108
+ Syn announces "Light enough I don't need a domain gut-check — going straight
109
+ to build" and proceeds directly to the gate.
110
+
111
+ ---
112
+
113
+ ## Output
114
+
115
+ Each deck lives in `presentations/<deck_slug>/`:
116
+
117
+ | File | Contents |
118
+ |---|---|
119
+ | `presentation-spec.md` | The single decision document — intake, outline v1, review round 1, approved outline, build log, review round 2, wrap. Gate-bearing artifact. |
120
+ | `slides-url.txt` | Plain text URL of the created deck (one line, easy re-open). |
121
+ | `iterations.md` | Optional. Created on the first Step 7 revision pass. Each `## Pass N — <date>` block lists what changed and which feedback drove it. |
122
+
123
+ `<deck_slug>` is slug-cased from the deck purpose (e.g., `q1-churn-readout`,
124
+ `rag-prototype-demo`).
125
+
126
+ If the deck originated from an existing Shards project, Step 8 offers to
127
+ append a `## Presentation` block to that project's `project-specs.md` with
128
+ the slides URL and date — closes the loop between specialist work and
129
+ stakeholder readout.
130
+
131
+ ---
132
+
133
+ ## Limitations (v1)
134
+
135
+ - **No image / chart insertion.** Where the outline references a chart, Syn
136
+ inserts `[CHART: <description>]` placeholder text. Build Log lists the slide
137
+ numbers that need manual chart drops. Most Slides MCPs support text but
138
+ image-insert APIs vary; v2 may add screenshot-based chart embedding.
139
+ - **No theme / template selection beyond defaults.** Syn does not currently
140
+ pick brand templates. v2 candidate.
141
+ - **Slide count cap.** >40 slides hard-escalates (split into multiple decks);
142
+ >25 slides soft-warns. Slides Mode is for readout decks, not training
143
+ material.
144
+
145
+ ---
146
+
147
+ ## Troubleshooting
148
+
149
+ **"I don't see a Google Slides MCP configured"** — Slides Mode could not find
150
+ a tool with `create_presentation` in its name. Confirm your MCP is in
151
+ `~/.claude/settings.json` (not the project-level settings.json), and restart
152
+ Claude Code so it picks up the new server. If still missing, run a `/mcp`
153
+ diagnostic to see what's loaded.
154
+
155
+ **OAuth flow loops** — most MCPs cache auth tokens locally. If the OAuth flow
156
+ keeps prompting, delete the local token cache (path varies per server) and
157
+ retry.
158
+
159
+ **Quota errors** — Google Slides API has per-project quotas. If you hit a
160
+ quota mid-build, Slides Mode logs partial state to `iterations.md` and asks
161
+ how to proceed.
162
+
163
+ **Tool name mismatch** — Slides Mode matches by suffix. If your MCP exposes
164
+ something nonstandard like `mcp__foo__createSlidesDeck` instead of
165
+ `create_presentation`, you may need to use the official MCP or a server that
166
+ follows the standard naming. Open an issue if you hit this with a major
167
+ server.
168
+
169
+ ---
170
+
171
+ ## How to invoke
172
+
173
+ From a `/shards` session, type `SL` to enter Slides Mode. There is no
174
+ separate `/slides` command — Syn-native modes (Fixer, PM, Slides) are
175
+ accessed via the menu, consistent with the rest of the suite.
@@ -0,0 +1,30 @@
1
+ # Shards Developer Guide
2
+
3
+ Shards is a suite of data, ML, and AI engineering agents built on top of Claude Code. Each agent is a "shard of Syn's brain" — a specialist fragment with a distinct persona, a phased workflow, and a gate-based documentation pattern that produces an auditable decision trail for every project.
4
+
5
+ This guide is the canonical reference for everything Shards does: every agent, every mode, every protocol, every UI feature.
6
+
7
+ ## How to read this guide
8
+
9
+ - **New to Shards?** Start with [Install & Setup](01-getting-started/install.md), then [Your First Session](01-getting-started/first-session.md), then [Core Concepts](01-getting-started/concepts.md).
10
+ - **Picking an agent?** See [Agent Taxonomy](02-agents/overview.md).
11
+ - **Curious about a specific feature?** Jump straight to the relevant page from the left sidebar.
12
+ - **Reading offline?** The full guide is installed as plain markdown at `docs/shards-guide/` in your project after `npx github:proflandrigan/shards install`. Every page here renders correctly in GitHub and any markdown viewer.
13
+
14
+ ## What's inside
15
+
16
+ - **[Getting Started](01-getting-started/install.md)** — install, first session, core concepts.
17
+ - **[Agents](02-agents/overview.md)** — one page per agent, covering persona, menu options, phases, consultants, and where output lands.
18
+ - **[Shared Protocols](03-protocols/gate-pattern.md)** — the gate pattern, DIVERGE parallel exploration, Autonomous Research, the Knowledge Ledger, and more.
19
+ - **[Shards UI](04-ui/overview.md)** — every panel, keybinding, and feature in the browser UI.
20
+ - **[Commands](05-commands/reference.md)** — every slash command at a glance.
21
+ - **[Outputs](06-outputs/directory-map.md)** — where each agent writes files.
22
+ - **[Workflows](07-workflows/quick-analysis.md)** — end-to-end examples of real projects.
23
+
24
+ ## Where this content lives
25
+
26
+ - **Source of truth:** `src/docs/` in the Shards repo.
27
+ - **Installed location (UI):** `.shards/ui/docs/` — served by the in-UI guide panel.
28
+ - **Installed location (markdown):** `docs/shards-guide/` in your project — for reading in an editor or on GitHub.
29
+
30
+ Both installed copies are kept in sync by `tools/install.js`. Edits should be made in `src/docs/` and reinstalled.
@@ -0,0 +1,108 @@
1
+ {
2
+ "version": 1,
3
+ "title": "Shards Developer Guide",
4
+ "sections": [
5
+ {
6
+ "id": "getting-started",
7
+ "title": "Getting Started",
8
+ "pages": [
9
+ { "id": "intro", "title": "What Is Shards?", "file": "README.md" },
10
+ { "id": "install", "title": "Install & Setup", "file": "01-getting-started/install.md" },
11
+ { "id": "first-session", "title": "Your First Session", "file": "01-getting-started/first-session.md" },
12
+ { "id": "concepts", "title": "Core Concepts", "file": "01-getting-started/concepts.md" }
13
+ ]
14
+ },
15
+ {
16
+ "id": "agents",
17
+ "title": "Agents",
18
+ "pages": [
19
+ { "id": "overview", "title": "Agent Taxonomy", "file": "02-agents/overview.md" },
20
+ { "id": "syn", "title": "Syn — Orchestrator", "file": "02-agents/syn.md" },
21
+ { "id": "data-analyst", "title": "Data Analyst", "file": "02-agents/data-analyst.md" },
22
+ { "id": "data-scientist", "title": "Data Scientist", "file": "02-agents/data-scientist.md" },
23
+ { "id": "ml-engineer", "title": "ML Engineer", "file": "02-agents/ml-engineer.md" },
24
+ { "id": "ai-engineer", "title": "AI Engineer", "file": "02-agents/ai-engineer.md" },
25
+ { "id": "data-engineer", "title": "Data Engineer", "file": "02-agents/data-engineer.md" },
26
+ { "id": "data-modeller", "title": "Data Modeller", "file": "02-agents/data-modeller.md" },
27
+ { "id": "analytics-engineer", "title": "Analytics Engineer", "file": "02-agents/analytics-engineer.md" },
28
+ { "id": "bi-engineer", "title": "BI Engineer", "file": "02-agents/bi-engineer.md" },
29
+ { "id": "applied-ml-scientist", "title": "Applied ML Scientist", "file": "02-agents/applied-ml-scientist.md" },
30
+ { "id": "deep-learning-engineer", "title": "Deep Learning Engineer", "file": "02-agents/deep-learning-engineer.md" },
31
+ { "id": "mlops-engineer", "title": "MLOps Engineer", "file": "02-agents/mlops-engineer.md" },
32
+ { "id": "backend-engineer", "title": "Backend Engineer", "file": "02-agents/backend-engineer.md" },
33
+ { "id": "researcher", "title": "Researcher", "file": "02-agents/researcher.md" },
34
+ { "id": "academic", "title": "Academic", "file": "02-agents/academic.md" }
35
+ ]
36
+ },
37
+ {
38
+ "id": "protocols",
39
+ "title": "Shared Protocols",
40
+ "pages": [
41
+ { "id": "gate-pattern", "title": "The Gate Pattern", "file": "03-protocols/gate-pattern.md" },
42
+ { "id": "behavioral-rules", "title": "Behavioral Rules", "file": "03-protocols/behavioral-rules.md" },
43
+ { "id": "engineering-guidelines", "title": "Engineering Guidelines", "file": "03-protocols/engineering-guidelines.md" },
44
+ { "id": "reviewer-verdicts", "title": "Reviewer Verdicts", "file": "03-protocols/reviewer-verdicts.md" },
45
+ { "id": "validation", "title": "Validation Protocol", "file": "03-protocols/validation.md" },
46
+ { "id": "diverge", "title": "DIVERGE (Time-Travel Branches)", "file": "03-protocols/diverge.md" },
47
+ { "id": "swarm", "title": "Decompose & Swarm", "file": "03-protocols/swarm.md" },
48
+ { "id": "autonomous-research", "title": "Autonomous Research", "file": "03-protocols/autonomous-research.md" },
49
+ { "id": "experiment-versioning", "title": "Experiment Versioning", "file": "03-protocols/experiment-versioning.md" },
50
+ { "id": "knowledge-ledger", "title": "Knowledge Ledger", "file": "03-protocols/knowledge-ledger.md" },
51
+ { "id": "join-path", "title": "Join-Path Protocol", "file": "03-protocols/join-path.md" },
52
+ { "id": "incremental-testing", "title": "Incremental Testing", "file": "03-protocols/incremental-testing.md" },
53
+ { "id": "auto-verify", "title": "Auto-Verify Mode", "file": "03-protocols/auto-verify.md" }
54
+ ]
55
+ },
56
+ {
57
+ "id": "ui",
58
+ "title": "Shards UI",
59
+ "pages": [
60
+ { "id": "overview", "title": "UI Overview", "file": "04-ui/overview.md" },
61
+ { "id": "activity-bar", "title": "Activity Bar", "file": "04-ui/activity-bar.md" },
62
+ { "id": "chat-pane", "title": "Chat Pane", "file": "04-ui/chat-pane.md" },
63
+ { "id": "file-editing", "title": "File Editing", "file": "04-ui/file-editing.md" },
64
+ { "id": "panels", "title": "Agent-Pushed Panels", "file": "04-ui/panels.md" },
65
+ { "id": "pinboard-selection", "title": "Pinboard & Selection", "file": "04-ui/pinboard-selection.md" },
66
+ { "id": "git", "title": "Git & PR Review", "file": "04-ui/git.md" },
67
+ { "id": "code-intel", "title": "Code Intelligence", "file": "04-ui/code-intel.md" },
68
+ { "id": "quick-open-palette", "title": "Quick Open & Command Palette", "file": "04-ui/quick-open-palette.md" },
69
+ { "id": "knowledge-map", "title": "Knowledge Map", "file": "04-ui/knowledge-map.md" },
70
+ { "id": "sessions", "title": "Sessions Panel", "file": "04-ui/sessions.md" },
71
+ { "id": "settings-permissions", "title": "Settings & Permissions", "file": "04-ui/settings-permissions.md" },
72
+ { "id": "keybindings", "title": "Keybindings Reference", "file": "04-ui/keybindings.md" }
73
+ ]
74
+ },
75
+ {
76
+ "id": "commands",
77
+ "title": "Commands",
78
+ "pages": [
79
+ { "id": "reference", "title": "Slash Command Reference", "file": "05-commands/reference.md" }
80
+ ]
81
+ },
82
+ {
83
+ "id": "outputs",
84
+ "title": "Outputs",
85
+ "pages": [
86
+ { "id": "directory-map", "title": "Output Directory Map", "file": "06-outputs/directory-map.md" }
87
+ ]
88
+ },
89
+ {
90
+ "id": "workflows",
91
+ "title": "Example Workflows",
92
+ "pages": [
93
+ { "id": "quick-analysis", "title": "Quick Analysis", "file": "07-workflows/quick-analysis.md" },
94
+ { "id": "deep-study-to-production", "title": "Study → Production ML", "file": "07-workflows/deep-study-to-production.md" },
95
+ { "id": "ai-eval-first", "title": "AI Eval-First", "file": "07-workflows/ai-eval-first.md" },
96
+ { "id": "diverge-exploration", "title": "Parallel Exploration (DIVERGE)", "file": "07-workflows/diverge-exploration.md" }
97
+ ]
98
+ },
99
+ {
100
+ "id": "integrations",
101
+ "title": "Integrations",
102
+ "pages": [
103
+ { "id": "google-slides", "title": "Google Slides (Syn Slides Mode)", "file": "08-integrations/google-slides.md" },
104
+ { "id": "claude-code-auto-mode", "title": "Claude Code Auto Mode", "file": "08-integrations/claude-code-auto-mode.md" }
105
+ ]
106
+ }
107
+ ]
108
+ }
@@ -0,0 +1,20 @@
1
+ # Analysis: {{ANALYSIS_NAME}}
2
+ - **Created:** {{DATE}}
3
+ - **Analyst:** Data Analyst Shard
4
+ - **Status:** In Progress
5
+
6
+ ---
7
+
8
+ <!--
9
+ Adhoc analysis output file. The Data Analyst shard populates this as it
10
+ works through its phases.
11
+
12
+ Phases:
13
+ 0. Triage
14
+ 1. Data Clarification (with Data Modeller review)
15
+ 2. Analysis Plan (with Data Scientist review)
16
+ 3. Execute
17
+ 4. Final Review (with Syn review)
18
+
19
+ Queries are written to: queries/*.sql
20
+ -->
@@ -0,0 +1,46 @@
1
+ # Branch Report: {{BRANCH_NAME}}
2
+
3
+ - **Specialist:** {{SPECIALIST_AGENT}}
4
+ - **Approach:** {{APPROACH_SUMMARY}}
5
+ - **Branch directory:** {{BRANCH_DIR}}
6
+ - **Date:** {{DATE}}
7
+
8
+ ---
9
+
10
+ ## Approach Description
11
+
12
+ {{APPROACH_DESCRIPTION}}
13
+
14
+ ---
15
+
16
+ ## Implementation
17
+
18
+ | File | Description |
19
+ |------|-------------|
20
+ | `{{FILE}}` | {{DESCRIPTION}} |
21
+
22
+ ---
23
+
24
+ ## Metrics
25
+
26
+ | Metric | Value | Notes |
27
+ |--------|-------|-------|
28
+ | **{{PRIMARY_METRIC}}** | **{{VALUE}}** | {{NOTES}} |
29
+
30
+ ---
31
+
32
+ ## Strengths
33
+
34
+ {{STRENGTHS}}
35
+
36
+ ---
37
+
38
+ ## Weaknesses
39
+
40
+ {{WEAKNESSES}}
41
+
42
+ ---
43
+
44
+ ## Artifacts Summary
45
+
46
+ {{ARTIFACTS_LIST}}
@@ -0,0 +1,88 @@
1
+ # Cross-Project Diff: {{PROJECT_A_NAME}} vs. {{PROJECT_B_NAME}}
2
+
3
+ - **Date:** {{DATE}}
4
+ - **Analyst:** Syn (Diff Mode)
5
+ - **Directory A:** {{DIR_A}}
6
+ - **Directory B:** {{DIR_B}}
7
+ - **Focus:** {{FOCUS}}
8
+
9
+ ---
10
+
11
+ ## Overview
12
+
13
+ | Dimension | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} |
14
+ |-----------|------------|------------|
15
+ | Specialist | {{SPECIALIST_A}} | {{SPECIALIST_B}} |
16
+ | Track | {{TRACK_A}} | {{TRACK_B}} |
17
+ | Status | {{STATUS_A}} | {{STATUS_B}} |
18
+ | Created | {{DATE_A}} | {{DATE_B}} |
19
+ | Directory | `{{DIR_A}}` | `{{DIR_B}}` |
20
+
21
+ ---
22
+
23
+ ## Methodology Divergence
24
+
25
+ | Decision | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} |
26
+ |----------|------------|------------|
27
+ | {{DECISION_POINT}} | {{CHOICE_A}} | {{CHOICE_B}} |
28
+
29
+ {{METHODOLOGY_ANALYSIS}}
30
+
31
+ ---
32
+
33
+ ## Performance Delta
34
+
35
+ | Metric | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} | Delta | Leader |
36
+ |--------|------------|------------|-------|--------|
37
+ | {{METRIC}} | {{VALUE_A}} | {{VALUE_B}} | {{DELTA}} | {{LEADER}} |
38
+
39
+ {{VERSIONING_NOTES}}
40
+
41
+ ---
42
+
43
+ ## Hyperparameters & Configuration
44
+
45
+ | Parameter | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} |
46
+ |-----------|------------|------------|
47
+ | {{PARAM}} | {{VALUE_A}} | {{VALUE_B}} |
48
+
49
+ ---
50
+
51
+ ## Data Sources
52
+
53
+ | Source | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} |
54
+ |--------|------------|------------|
55
+ | {{SOURCE}} | {{USED_A}} | {{USED_B}} |
56
+
57
+ ---
58
+
59
+ ## Implementation Differences
60
+
61
+ | File Type | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} | Key Difference |
62
+ |-----------|------------|------------|----------------|
63
+ | {{FILE_TYPE}} | `{{FILE_A}}` | `{{FILE_B}}` | {{DIFFERENCE}} |
64
+
65
+ ---
66
+
67
+ ## Artifact Inventory
68
+
69
+ | Artifact | {{PROJECT_A_NAME}} | {{PROJECT_B_NAME}} |
70
+ |----------|------------|------------|
71
+ | project-specs.md | {{HAS_SPECS_A}} | {{HAS_SPECS_B}} |
72
+ | experiments/ | {{EXP_COUNT_A}} | {{EXP_COUNT_B}} |
73
+ | notebooks/ | {{NB_COUNT_A}} | {{NB_COUNT_B}} |
74
+ | queries/ | {{Q_COUNT_A}} | {{Q_COUNT_B}} |
75
+ | prompts/ | {{P_COUNT_A}} | {{P_COUNT_B}} |
76
+ | configs/ | {{C_COUNT_A}} | {{C_COUNT_B}} |
77
+
78
+ ---
79
+
80
+ ## Syn's Analysis
81
+
82
+ {{ANALYSIS}}
83
+
84
+ ---
85
+
86
+ ## Recommendation
87
+
88
+ {{RECOMMENDATION}}