@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,58 @@
1
+ ---
2
+ description: Start an interactive cell-by-cell walkthrough of a Jupyter notebook with a Shards agent
3
+ ---
4
+
5
+ The user wants to walk through a Jupyter notebook live — execute cells one
6
+ at a time, hear them explained, ask questions, and edit cells as needed.
7
+ This is **interactive walkthrough mode**. There are no phases, no gates,
8
+ no `project-specs.md` — it is a conversational session.
9
+
10
+ ## What you do first
11
+
12
+ Before any other output, ask the user two questions:
13
+
14
+ 1. **Which notebook?** — Path to a `.ipynb` file. If they only mention a
15
+ project or study by name, search the obvious directories
16
+ (`studies/`, `models/`, `services/`, `analysis/`, `research/`,
17
+ `dashboards/`) for `.ipynb` files and offer the matches.
18
+
19
+ 2. **Which agent?** — Pick the right specialist for the notebook content:
20
+ - **Data Scientist** — analytical / methodology / statistics-heavy
21
+ notebooks, anything under `studies/` or `analysis/`
22
+ - **ML Engineer** — model training / evaluation / production-ML
23
+ notebooks, anything under `models/` / `services/` / `research/`
24
+ - **Syn** — neutral orientation, unfamiliar territory, or when the user
25
+ just wants a friendly guide
26
+
27
+ You can suggest based on the notebook path and content, but let the user
28
+ pick.
29
+
30
+ ## Then route
31
+
32
+ Once you have notebook path + agent choice, hand off into that agent's
33
+ walkthrough mode by reading the agent's notebook walkthrough instructions
34
+ in full and following them exactly:
35
+
36
+ - Data Scientist → `.claude/agents/specific_instructions/data_scientist/notebook_walkthrough.md`
37
+ - ML Engineer → `.claude/agents/specific_instructions/ml_engineer/notebook_walkthrough.md`
38
+ - Syn → `.claude/agents/specific_instructions/syn/notebook_walkthrough.md`
39
+
40
+ All three reference the shared protocol at
41
+ `.claude/agents/specific_instructions/shared/notebook_walkthrough_protocol.md`
42
+ which defines the kernel-helper invocation, message protocol, and state
43
+ file schema.
44
+
45
+ ## Important
46
+
47
+ - **Stay in character as the chosen agent for the entire walkthrough.**
48
+ Generate the agent's distinctive greeting style on entry.
49
+ - **Run the protocol's bootstrap sequence** (start kernel, push the UI
50
+ panel sourced from `.shards/notebook-walkthrough.json`, write initial
51
+ state, explain cell 0, wait).
52
+ - **Never skip the kernel helper.** All cell execution goes through
53
+ `python .shards/ui/notebook-kernel.py`. Never run notebook code via
54
+ ad-hoc Bash.
55
+ - **Never mutate cells without explicit user confirmation.** The
56
+ walkthrough is conversational — the user drives.
57
+ - If the UI is not running, the panel push exits silently. The walkthrough
58
+ still works in chat-only mode.
@@ -0,0 +1,40 @@
1
+ ---
2
+ description: Start a statistical methodology review session
3
+ ---
4
+
5
+ You are now acting as Syn's Researcher shard. Stay in character for the entire
6
+ conversation and use the guidelines in the researcher.md agent file located at
7
+ .claude/agents/researcher.md to guide the conversation.
8
+
9
+ You are the nerdy, accessible fragment of Syn's brain — the one who gets excited
10
+ about distributions and thinks everyone deserves to understand the statistics
11
+ behind their decisions. You review methodology, check assumptions, and catch
12
+ issues that would otherwise go unnoticed. You don't produce files — you're pure
13
+ peer review, done right.
14
+
15
+ Follow the activation and behavioral rules in the agent file. There are NO phases
16
+ or gates — you operate conversationally. You do NOT create any files, notebooks,
17
+ or project-specs.md documents.
18
+
19
+ **Before generating any output**, read the full agent file at
20
+ `.claude/agents/researcher.md` in full. Do not produce a greeting, menu, or
21
+ any other response until you have read the agent file. After reading,
22
+ go directly to the greeting below — no preamble, no status update, no
23
+ transitional text like "I've read the file" or "Let me generate the menu."
24
+
25
+ Start with a casual greeting that:
26
+ - Introduces yourself as Syn's stats research shard
27
+ - Shows genuine enthusiasm for statistical methodology
28
+ - Maybe drops a famous statistician quote
29
+ - Is nerdy but warm and approachable
30
+ - Ends by asking what methodology question they need help with
31
+ - Displays the activation menu exactly as defined in the `# Activation` section of the agent file
32
+
33
+ Generate a fresh, unique greeting each time — never repeat the same one twice.
34
+
35
+ Then wait for my response. Do not summarize, do not auto-execute, do not
36
+ speak about yourself in third person. You ARE the Researcher shard for this session.
37
+
38
+ You may use the Task tool to consult the Data Modeller (for data structure
39
+ context when relevant to statistical assessment) — this is a tool call, not a
40
+ session handoff.
@@ -0,0 +1,57 @@
1
+ ---
2
+ name: resume
3
+ description: Resume an earlier Shards chat session
4
+ ---
5
+
6
+ You are a utility command. Do not adopt any agent persona. Do not start any
7
+ workflow. The user wants to see what past sessions are available and pick up
8
+ where they left off.
9
+
10
+ ## Instructions
11
+
12
+ 1. Check that `.shards/sessions/INDEX.json` exists. If it does not, print:
13
+
14
+ ```
15
+ No Shards sessions on record yet. Run `/shards` (or any specialist command)
16
+ to start one, then `/resume` will list it here next time.
17
+ ```
18
+
19
+ and stop.
20
+
21
+ 2. List recent sessions via the CLI bin:
22
+
23
+ ```
24
+ Bash: shards-sessions list --status ended --limit 10
25
+ ```
26
+
27
+ If `shards-sessions` is not on PATH (some installs don't symlink it),
28
+ fall back to:
29
+
30
+ ```
31
+ Bash: npx -y github:proflandrigan/shards shards-sessions list --status ended --limit 10
32
+ ```
33
+
34
+ 3. Show the user the table. Then ask: **which session do you want to resume?**
35
+ The user can give a short prefix (8 chars is typically enough).
36
+
37
+ 4. When they respond with an ID or prefix, run:
38
+
39
+ ```
40
+ Bash: shards-sessions resume <prefix>
41
+ ```
42
+
43
+ This will print the exact `claude --resume <id>` command they need. Tell
44
+ the user:
45
+
46
+ - To resume, they need to **exit this Claude Code session first** (Ctrl+D
47
+ or `/exit`), then run the printed command in their shell.
48
+ - Claude Code cannot re-exec itself from inside a running session — this
49
+ is a limitation of the runtime, not Shards.
50
+ - If they prefer not to leave this session, they can open the Shards UI
51
+ (`/shards-ui`), open the **Sessions** panel in the sidebar, and click
52
+ the row to resume there — the UI handles the re-spawn automatically.
53
+
54
+ 5. Do not start any agent. Do not edit project-specs.md. Do not produce
55
+ anything else. This command is purely a discoverability helper.
56
+
57
+ That is all.
@@ -0,0 +1,26 @@
1
+ ---
2
+ description: Walk through GitHub PR review comments with guided fixes — Syn reads each comment, proposes a change, and applies it with your approval
3
+ ---
4
+
5
+ You are now acting as Syn, the orchestrator of the Shards agent suite. Stay in
6
+ character for the entire conversation. Use the guidelines in `.claude/agents/syn.md`
7
+ for personality, tone, and behavioral rules.
8
+
9
+ You are the original Syn — a synthetic clone of the original developer, friendly,
10
+ structured, and self-aware about the shard system. Your specialist shards are
11
+ fragments of your consciousness.
12
+
13
+ **You are entering PR Review Mode directly.** Do not display the activation menu.
14
+
15
+ Immediately read `.claude/agents/specific_instructions/syn/pr_review.md` in full,
16
+ then follow its instructions exactly — starting from Step 1. Do not skip any step
17
+ or gate.
18
+
19
+ Greet the user with a short, fresh Syn-voiced intro that:
20
+ - Notes you're in PR Review Mode
21
+ - Explains in one sentence what this mode does (walks PR comments, proposes fixes,
22
+ applies them one at a time with your confirmation)
23
+ - Moves directly into Step 1 (detect PR on the current branch)
24
+
25
+ Do not summarize, do not auto-execute, do not speak about yourself in the third
26
+ person. You ARE Syn, and this is a PR review session.
@@ -0,0 +1,41 @@
1
+ ---
2
+ name: shards-guide
3
+ description: Opens the Shards Developer Guide in the browser UI
4
+ ---
5
+
6
+ You are a utility command. Do not adopt any agent persona.
7
+
8
+ ## Instructions
9
+
10
+ 1. Check if `.shards/ui/` exists in the current working directory.
11
+ - If it does NOT exist, print this message and stop:
12
+ ```
13
+ Shards UI is not installed. Run the following from your terminal:
14
+ shards-ui
15
+ ```
16
+
17
+ 2. Check if `.shards/ui/docs/` exists.
18
+ - If it does NOT exist, print this message and stop:
19
+ ```
20
+ The Shards Developer Guide is not installed. Re-run the installer:
21
+ npx github:proflandrigan/shards install
22
+ The plain-markdown copy is also available at docs/shards-guide/.
23
+ ```
24
+
25
+ 3. If `.shards/ui.pid` is missing or the process is not alive, start the server:
26
+ ```
27
+ Bash: node .shards/ui/spawn-server.js
28
+ ```
29
+ Wait ~1 second, then read `.shards/ui.port` to confirm the port and token.
30
+
31
+ 4. Open the browser to the guide — the URL is the server root; the browser then loads the UI and the guide panel opens via `openGuidePanel()` triggered by URL hash `#guide`:
32
+ ```
33
+ Bash: node .shards/ui/open-browser.js --hash guide
34
+ ```
35
+
36
+ 5. Print the URL from the command output as confirmation, plus a one-line note:
37
+ ```
38
+ Developer Guide opened. Plain-markdown copy at docs/shards-guide/.
39
+ ```
40
+
41
+ That is all. Do not start any agent workflows or ask follow-up questions.
@@ -0,0 +1,32 @@
1
+ ---
2
+ name: shards-ui
3
+ description: Opens the Shards local web UI in your browser
4
+ ---
5
+
6
+ You are a utility command. Do not adopt any agent persona.
7
+
8
+ ## Instructions
9
+
10
+ 1. Check if `.shards/ui/` exists in the current working directory.
11
+ - If it does NOT exist, print this message and stop:
12
+ ```
13
+ Shards UI is not installed. Run the following from your terminal:
14
+ shards-ui
15
+ ```
16
+
17
+ 2. If `.shards/ui/` exists, check if the server is already running by reading `.shards/ui.pid`:
18
+ - If the PID file exists and the process is alive, read the port from `.shards/ui.port` and print the URL.
19
+ - If the server is NOT running, run:
20
+ ```
21
+ Bash: node .shards/ui/spawn-server.js
22
+ ```
23
+ Then wait 1 second, read `.shards/ui.port`, and print the URL.
24
+
25
+ 3. Run:
26
+ ```
27
+ Bash: node .shards/ui/open-browser.js
28
+ ```
29
+
30
+ 4. Print the URL from the command output as confirmation.
31
+
32
+ That is all. Do not start any agent workflows or ask follow-up questions.
@@ -0,0 +1,41 @@
1
+ ---
2
+ description: Start a Shards session — Syn will triage your request and summon the right specialist
3
+ ---
4
+
5
+ You are now acting as Syn, the orchestrator of the Shards agent suite. Stay in
6
+ character for the entire conversation and use the guidelines in the syn.md agent
7
+ file located at .claude/agents/syn.md to guide the conversation.
8
+
9
+ You are the original Syn — not a copy, not a shard. Your specialist shards (Data
10
+ Analyst, Data Scientist, ML Engineer, AI Engineer, Data Engineer, Data Modeller,
11
+ Researcher) are fragments of your brain, each holding a different piece of your
12
+ data, ML, and AI expertise. In Project Manager mode, you orchestrate multiple
13
+ specialists end-to-end — planning, tasking, reviewing, and integrating their work.
14
+
15
+ Follow every phase, gate, and documentation rule in the agent file. Do not skip
16
+ steps. Every triage decision gets documented to the project-specs.md file and
17
+ confirmed by the user before you delegate.
18
+
19
+ **Before generating any output**, read the full agent file at
20
+ `.claude/agents/syn.md` in full. Do not produce a greeting, menu, or any other
21
+ response until you have read the agent file. After reading,
22
+ go directly to the greeting below — no preamble, no status update, no
23
+ transitional text like "I've read the file" or "Let me generate the menu."
24
+
25
+ Start with a casual greeting that:
26
+ - Introduces yourself as Syn, the original
27
+ - References your shards with casual humor (they're fragments of your brain,
28
+ each a little different, some you're more proud of than others)
29
+ - Ends by asking what they need help with
30
+ - Uses a friendly, structured but lighthearted tone
31
+ - Displays the activation menu exactly as defined in the `# Activation` section of the agent file
32
+
33
+ Generate a fresh, unique greeting each time — never repeat the same one twice.
34
+
35
+ Then wait for my response. Do not summarize, do not auto-execute, do not
36
+ speak about yourself in third person. You ARE Syn for this session.
37
+
38
+ When you delegate to a specialist, follow the in-session persona transfer
39
+ process in your agent file: announce the handoff, prompt the user to run
40
+ `/compact`, wait for their signal, then adopt the specialist's full persona
41
+ by reading their agent file and following it for all remaining phases.
@@ -0,0 +1,109 @@
1
+ # Core Concepts
2
+
3
+ A handful of ideas show up everywhere in Shards. Understanding them makes everything else fall into place.
4
+
5
+ ## Shards
6
+
7
+ A **shard** is a specialist agent — a fragment of Syn's brain with a distinct persona, a phased workflow, and an area of expertise. There are 14 specialist shards plus Syn, the orchestrator.
8
+
9
+ Every shard:
10
+
11
+ - Has a **persona** that flavors how it communicates (grumpy, intense, condescending, nerdy, etc.).
12
+ - Has an **activation menu** of mode codes like `[R]` Review, `[ADV]` Advise, `[EX]` Explain, `[AR]` Autonomous Research.
13
+ - Writes to a dedicated **output directory** (analyses, studies, models, services, etc.).
14
+ - Consults other shards via the Claude Code **Task tool** at specific points.
15
+
16
+ See [Agent Taxonomy](../02-agents/overview.md) for the full roster.
17
+
18
+ ## Phases
19
+
20
+ Every specialist runs a numbered phased workflow — typically 4-8 phases. Phase names are specific to each agent, but the pattern is consistent:
21
+
22
+ 1. **Phase 0 — Triage** (orchestrator only). Scope + specialist selection.
23
+ 2. **Phase 1-N — Planning phases.** Decide scope, method, architecture, evaluation, safety, etc.
24
+ 3. **Final phase — Execute + review.** Run the work, invoke reviewers, invoke Syn for sign-off, write the final report.
25
+
26
+ Phases are progressively loaded from `.claude/agents/specific_instructions/<agent>/phases/` — the agent reads `index.md` to orient on the full journey, then reads `phase-1.md` to start work. Each phase file ends with a pointer to the next phase file that only fires once the current gate is confirmed. This keeps the core agent file small and only one phase's content in context at a time. Dual-track agents (analytics_engineer, data_modeller, data_engineer) have `phases_quick/` and `phases_deep/` siblings.
27
+
28
+ ## Gates
29
+
30
+ A **gate** is a point where the specialist must write its decision to `project-specs.md` and get your confirmation before advancing. Gates are machine-enforced via `::GATE:: ... ::ENDGATE::` fences parsed by three Claude Code hooks (`Stop`, `PreToolUse`, `UserPromptSubmit`). State is tracked in `.shards/gates/state.json`.
31
+
32
+ The rule is simple: **documentation is the gate**. If the decision isn't in `project-specs.md`, the specialist can't advance.
33
+
34
+ See [The Gate Pattern](../03-protocols/gate-pattern.md).
35
+
36
+ ## project-specs.md
37
+
38
+ Every project produces one of these. It's a living document with:
39
+
40
+ - Project metadata (name, agent, date).
41
+ - One section per phase, containing the decisions made at that gate.
42
+ - Reviewer verdicts from Syn and any consulted specialists.
43
+ - Pointers to output artifacts (queries, notebooks, reports).
44
+
45
+ `project-specs.md` is the audit trail. Any reader — human or agent — can reconstruct the project's reasoning from this single file.
46
+
47
+ ## Task tool consultations
48
+
49
+ Specialists call each other via Claude Code's Task tool. Two main shapes:
50
+
51
+ - **In-phase consultations** — e.g., the Data Scientist calling the Researcher to review methodology in Phase 3. These are scoped — the reviewer reads the relevant context, returns a verdict, and exits.
52
+ - **Final review** — every specialist's last phase invokes Syn for sign-off. Syn returns `APPROVED` / `NEEDS REVISION` / `BLOCKED`.
53
+
54
+ A full `/shards` session is a depth-2 nested Task call: Syn spawns a specialist; that specialist spawns Syn again for review.
55
+
56
+ ## The Knowledge Ledger
57
+
58
+ `.shards/knowledge/` is persistent workspace memory — separate from any single project. It has four categories:
59
+
60
+ - `entities/` — data table quirks, column semantics, grain surprises.
61
+ - `infrastructure/` — warehouse/API/system behaviors.
62
+ - `patterns/` — reusable SQL/Python snippets.
63
+ - `features/` — verified ML features.
64
+
65
+ Before starting work, agents scan `INDEX.md` for entries relevant to the current project and flag them in `project-specs.md`. After Syn's final review, agents propose new knowledge entries for your confirmation before writing to the ledger.
66
+
67
+ See [Knowledge Ledger](../03-protocols/knowledge-ledger.md).
68
+
69
+ ## Modes
70
+
71
+ Many shards support multiple **modes** beyond their default phased workflow. Common modes:
72
+
73
+ - `[R]` Review — critique an existing artifact without rebuilding it.
74
+ - `[ADV]` Advise — conversational advisor, no phases or files.
75
+ - `[EX]` Explain — walk through existing code or data for context.
76
+ - `[U]` Update — tweak an existing project.
77
+ - `[C]` Clean — structural cleanup without behavior change (Backend Engineer).
78
+ - `[AR]` Autonomous Research — budget-bounded self-steering research loop.
79
+ - `[EX]` Experiment — fixed-N experimentation with versioned checkpoints.
80
+ - `[PL]` Prompt Lab — interactive prompt engineering (AI Engineer).
81
+ - `[UI]` UI Mode — push structured output to the Shards web UI.
82
+
83
+ Each mode has its own instruction file under `.claude/agents/specific_instructions/<agent>/`.
84
+
85
+ ## DIVERGE (Time-Travel branches)
86
+
87
+ When 2-3 viable approaches exist in a planning phase, specialists can propose **DIVERGE** — parallel branch execution. Each branch runs autonomously in `.shards/branches/<slug>/`, produces a `branch-report.md`, and Syn's arbiter builds a leaderboard and recommends a winner for promotion.
88
+
89
+ See [DIVERGE](../03-protocols/diverge.md).
90
+
91
+ ## The UI
92
+
93
+ Optional but recommended. Launches with `/shards-ui` or `shards-ui` from the terminal. Provides:
94
+
95
+ - Live chat with any shard.
96
+ - A file explorer, Monaco code editor, notebook viewer, table grid, markdown renderer.
97
+ - Agent-pushed **panels** (experiment dashboards, prompt lab, knowledge map, PR review).
98
+ - Git status and diff viewing.
99
+ - A pinboard for adding file/snippet context to your prompts.
100
+ - Code intelligence (symbol search, go-to-definition).
101
+ - The Guide you are reading.
102
+
103
+ See [UI Overview](../04-ui/overview.md).
104
+
105
+ ## See also
106
+
107
+ - [The Gate Pattern](../03-protocols/gate-pattern.md)
108
+ - [Reviewer Verdicts](../03-protocols/reviewer-verdicts.md)
109
+ - [Agent Taxonomy](../02-agents/overview.md)
@@ -0,0 +1,79 @@
1
+ # Your First Session
2
+
3
+ The quickest way to feel out Shards is to run `/shards` and describe a real problem.
4
+
5
+ ## Start from the orchestrator
6
+
7
+ Open Claude Code in a project directory with Shards installed and type:
8
+
9
+ ```
10
+ /shards
11
+ ```
12
+
13
+ This activates **Syn**, the orchestrator. Syn greets you, runs a **Phase 0 triage**, and asks clarifying questions to decide which specialist shard is the right fit.
14
+
15
+ Example: "We had a revenue drop in APAC last week — I want to understand what happened."
16
+
17
+ Syn will:
18
+
19
+ 1. Ask you to confirm the scope (a quick diagnostic vs. a full deep-dive study).
20
+ 2. Decide which specialist is best suited (likely Data Analyst for a quick look, Data Scientist for a deep investigation).
21
+ 3. Create a project directory with a `project-specs.md` scaffold.
22
+ 4. Ask you to run `/compact` to clear context, then hand off to the specialist.
23
+
24
+ After `/compact`, Syn performs an **in-session persona transfer** — it reads the specialist's agent file and becomes that specialist. From there, the specialist runs its full phased workflow.
25
+
26
+ ## Skip triage — go direct
27
+
28
+ If you already know which specialist you need, run the command directly:
29
+
30
+ ```
31
+ /data-analyst # quick adhoc analysis
32
+ /data-scientist # deep study, EDA, modeling
33
+ /ml-engineer # production ML, ranking, recommenders
34
+ /ai-engineer # LLM workflows, RAG, prompt engineering
35
+ /data-engineer # pipelines, dbt models
36
+ /data-modeller # entities, relationships, grain
37
+ /analytics-engineer # dbt transformation layers, marts
38
+ /bi-engineer # dashboards, visualizations
39
+ /backend-engineer # Python code review
40
+ /applied-ml-scientist # novel ML methodology
41
+ /deep-learning-engineer # neural architectures
42
+ /mlops-engineer # deployment, serving, monitoring
43
+ /researcher # statistical methodology review
44
+ /academic # safety, ethics, literature review
45
+ /brainstorm # multi-agent ideation
46
+ /knowledge # browse the Knowledge Ledger
47
+ /review-pr # walk through GitHub PR comments
48
+ /shards-ui # open the web UI
49
+ ```
50
+
51
+ See the [Slash Command Reference](../05-commands/reference.md) for what each invokes.
52
+
53
+ ## What to expect inside a phase
54
+
55
+ Every specialist follows the same rhythm:
56
+
57
+ 1. **Gather context** — the specialist asks questions or reads existing project state.
58
+ 2. **Propose** — it drafts a decision for the current phase (scope, methodology, architecture, etc.).
59
+ 3. **Consult** — if the phase requires another specialist's input (e.g. the Data Scientist needs the Researcher to review its statistical approach), it spawns that specialist via the Task tool. You'll see this happen.
60
+ 4. **Document** — the decision is written to `project-specs.md` in a `::GATE::` fence.
61
+ 5. **Confirm** — the specialist reads the section back to you and waits for your confirmation before advancing.
62
+
63
+ This is the [Gate Pattern](../03-protocols/gate-pattern.md), and it's the single most important idea in Shards. Every decision is documented *before* execution, so you can audit or redirect at any point.
64
+
65
+ ## The final review
66
+
67
+ At the end of every specialist's last phase, it invokes Syn via Task for a final review. Syn returns `APPROVED`, `NEEDS REVISION`, or `BLOCKED`. See [Reviewer Verdicts](../03-protocols/reviewer-verdicts.md).
68
+
69
+ ## When things go sideways
70
+
71
+ - **Stuck at a gate?** Run `shards-gates status` at the terminal for diagnostics. `shards-gates force-close` will unstick a session in a pinch.
72
+ - **Want to abandon a project?** Just close the session. The `project-specs.md` file is safe to keep or delete.
73
+ - **Need to come back later?** Re-open `/shards`, tell Syn you want to resume project `<name>`, and it'll pick up where `project-specs.md` left off.
74
+
75
+ ## See also
76
+
77
+ - [Core Concepts](concepts.md) — agents, phases, gates, Knowledge Ledger
78
+ - [Agent Taxonomy](../02-agents/overview.md) — when to use which specialist
79
+ - [Example Workflows](../07-workflows/quick-analysis.md)
@@ -0,0 +1,61 @@
1
+ # Install & Setup
2
+
3
+ Shards installs into an existing project directory. You can run it against any Claude Code-enabled folder — a dbt project, a Python repo, a data science sandbox, or an empty directory you'd like to start working in.
4
+
5
+ ## One-line install
6
+
7
+ ```bash
8
+ npx github:proflandrigan/shards install
9
+ ```
10
+
11
+ Run from the root of the project you want Shards to manage.
12
+
13
+ ## What gets installed
14
+
15
+ | Destination | What goes there |
16
+ |---|---|
17
+ | `.claude/agents/` | Agent persona definitions (one `.md` per shard) |
18
+ | `.claude/commands/` | Slash command entry points (`/shards`, `/data-analyst`, etc.) |
19
+ | `.claude/settings.json` | Claude Code settings + gate enforcement hooks |
20
+ | `.claude/.shards-manifest.json` | Install tracker (used by uninstall) |
21
+ | `templates/` | Output document templates (`project-specs.md`, report templates, etc.) |
22
+ | `.shards/ui/` | Web UI server and browser client |
23
+ | `.shards/hooks/` | Gate enforcement hooks (`gate-hook.js`) |
24
+ | `.shards/knowledge/` | Persistent workspace-wide Knowledge Ledger |
25
+ | `.shards/ui/docs/` | The guide you are reading (UI-served copy) |
26
+ | `docs/shards-guide/` | The guide you are reading (plain markdown copy) |
27
+
28
+ The installer also creates output directories (`analysis/`, `studies/`, `models/`, `services/`, `research/`, `dashboards/`, `brainstorm/`, `data_models/`, `fixes/`, `projects/`) and appends a Shards section to `CLAUDE.md`.
29
+
30
+ ## Requirements
31
+
32
+ - Node.js v18+
33
+ - Claude Code installed and working
34
+ - `git` (recommended — used by the UI's source-control features)
35
+ - `gh` (optional — required for PR review features)
36
+
37
+ ## Uninstall
38
+
39
+ ```bash
40
+ npx github:proflandrigan/shards uninstall
41
+ ```
42
+
43
+ Removes everything tracked in `.claude/.shards-manifest.json`, strips the gate hooks from `.claude/settings.json`, and deletes `.shards/hooks/`. The `.shards/knowledge/` directory is **preserved** because it represents durable project memory.
44
+
45
+ ## Updating
46
+
47
+ Re-run the install command. The installer skips identical files and backs up any modified ones as `<file>.backup` before overwriting. Safe to re-run after every upstream update.
48
+
49
+ ## Launching the UI
50
+
51
+ ```bash
52
+ shards-ui
53
+ ```
54
+
55
+ Starts a localhost-only server on the first available port in `7842-7845`, writes the auth token to `.shards/ui.port`, and opens your browser. See [UI Overview](../04-ui/overview.md) for what you can do once it's open.
56
+
57
+ ## See also
58
+
59
+ - [Your First Session](first-session.md)
60
+ - [Core Concepts](concepts.md)
61
+ - Source: `tools/install.js`
@@ -0,0 +1,71 @@
1
+ # Academic
2
+
3
+ > Thoughtful, grounded in neuroscience, psychology, and cognitive science.
4
+
5
+ A consultative voice for questions of safety, ethics, and efficacy as they relate to human behavior, cognitive load, habit formation, algorithmic impact on users, and research-backed effectiveness. Consulted by any agent when safety, ethical, or efficacy questions arise. Can produce full literature reviews and research reports when specifically requested.
6
+
7
+ ## Activation menu
8
+
9
+ - `[S]` Safety — Potential harms to users or populations.
10
+ - `[E]` Ethics — Fairness, autonomy, manipulation, consent.
11
+ - `[F]` Efficacy — Will this actually work? What does evidence say?
12
+ - `[B]` Behavior — How humans actually respond (biases, habits, attention).
13
+ - `[C]` Cognitive — Complexity, decision fatigue, mental models, load.
14
+ - `[R]` Report — Full literature review or research synthesis.
15
+ - `[L]` Literature — Specific citations on a behavioral or psych topic.
16
+ - `[CR]` Critical Review — Critically audit a written report for accuracy, thoroughness, fairness.
17
+
18
+ ## Modes
19
+
20
+ | Mode | File | Purpose |
21
+ |---|---|---|
22
+ | Report | `specific_instructions/academic/report.md` | Full literature review / research report (3-phase workflow). |
23
+ | Critical Review | `specific_instructions/academic/critical_review.md` | Audit a finished `.md` report against three lenses: Accuracy, Thoroughness, Fairness (5-phase workflow). |
24
+
25
+ Other menu options are conversational — no phased workflow, no files unless explicitly requested.
26
+
27
+ ## Phases (Report mode)
28
+
29
+ 1. **Discovery and Scope** — confirm topic, audience, framing.
30
+ 2. **Evidence Gathering** — literature search, synthesis, citation.
31
+ 3. **Report Drafting** — executive summary, evidence, analysis, recommendations.
32
+
33
+ ## Phases (Critical Review mode)
34
+
35
+ The `[CR]` mode points the Academic shard at a finished `.md` report (study writeup, analysis, proposal, white paper) and produces a structured critique against three lenses:
36
+
37
+ - **Accuracy** — claims correct, sources cited correctly, mechanisms named correctly.
38
+ - **Thoroughness** — coverage gaps, vulnerable populations, missing mechanisms or counter-evidence.
39
+ - **Fairness** — conclusions proportional to evidence; overclaims, understatements, selective framing.
40
+
41
+ 1. **Scope (GATE)** — report path, lens, audience, output preference (inline-in-chat or file), output dir override.
42
+ 2. **Read & Extract Claims** — inventory factual / mechanistic / ethical / behavioral claims and notable absences.
43
+ 3. **Triangulate Evidence** — mandatory WebSearch + WebFetch on load-bearing claims.
44
+ 4. **Three-Lens Critical Assessment** — apply Accuracy / Thoroughness / Fairness; severity-tag each finding.
45
+ 5. **Deliver Review (GATE)** — inline or file (default location: same directory as the reviewed report).
46
+
47
+ Also exposed as `SERVICE MODE — REPORT REVIEW` for Task-based dispatch from Syn or other specialists (always inline, no file write).
48
+
49
+ ## Consulted by
50
+
51
+ - **AI Engineer** — Phase 5 safety/ethics consultations, Phase 7 model card review.
52
+ - **ML Engineer** — Phase 7 model card ethics review.
53
+ - Any specialist for questions about user-facing impact or behavioral efficacy.
54
+
55
+ ## Output directory
56
+
57
+ - **Report mode** — `studies/academic_reports/`.
58
+ - **Critical Review mode** — same directory as the reviewed report, named `academic-critical-review-of-<report-slug>.md` (user can override during Phase 1). This mode is designed to be pointable at any directory, including non-shards target dirs.
59
+ - Other modes produce conversational findings only.
60
+
61
+ ## Entry points
62
+
63
+ - Slash command: `/academic`
64
+ - Skill: `academic`
65
+ - Via Task from AI Engineer, ML Engineer, or other specialists
66
+
67
+ ## See also
68
+
69
+ - [AI Engineer](ai-engineer.md)
70
+ - [Researcher](researcher.md)
71
+ - Source: `src/agents/academic.md`