@hivehub/rulebook 5.4.1 → 5.5.1

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 (418) hide show
  1. package/.claude/commands/analysis.md +35 -35
  2. package/.claude/commands/continue.md +33 -33
  3. package/.claude/commands/ralph-config.md +112 -112
  4. package/.claude/commands/ralph-history.md +110 -110
  5. package/.claude/commands/ralph-init.md +72 -72
  6. package/.claude/commands/ralph-pause-resume.md +105 -105
  7. package/.claude/commands/ralph-run.md +101 -101
  8. package/.claude/commands/ralph-status.md +76 -76
  9. package/.claude/commands/rulebook-decision-create.md +55 -55
  10. package/.claude/commands/rulebook-decision-list.md +15 -15
  11. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  12. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  13. package/.claude/commands/rulebook-learn-capture.md +48 -48
  14. package/.claude/commands/rulebook-learn-list.md +13 -13
  15. package/.claude/commands/rulebook-memory-save.md +48 -48
  16. package/.claude/commands/rulebook-memory-search.md +47 -47
  17. package/.claude/commands/rulebook-task-apply.md +67 -67
  18. package/.claude/commands/rulebook-task-archive.md +94 -94
  19. package/.claude/commands/rulebook-task-create.md +93 -93
  20. package/.claude/commands/rulebook-task-list.md +42 -42
  21. package/.claude/commands/rulebook-task-show.md +52 -52
  22. package/.claude/commands/rulebook-task-validate.md +53 -53
  23. package/.claude-plugin/marketplace.json +28 -28
  24. package/.claude-plugin/plugin.json +8 -8
  25. package/README.md +394 -393
  26. package/dist/core/generator.d.ts +1 -1
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +1 -0
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/hooks/terse-activate.d.ts +59 -0
  31. package/dist/hooks/terse-activate.d.ts.map +1 -0
  32. package/dist/hooks/terse-activate.js +149 -0
  33. package/dist/hooks/terse-activate.js.map +1 -0
  34. package/dist/hooks/terse-config.d.ts +51 -0
  35. package/dist/hooks/terse-config.d.ts.map +1 -0
  36. package/dist/hooks/terse-config.js +130 -0
  37. package/dist/hooks/terse-config.js.map +1 -0
  38. package/dist/hooks/terse-mode-tracker.d.ts +78 -0
  39. package/dist/hooks/terse-mode-tracker.d.ts.map +1 -0
  40. package/dist/hooks/terse-mode-tracker.js +213 -0
  41. package/dist/hooks/terse-mode-tracker.js.map +1 -0
  42. package/dist/index.js +0 -0
  43. package/dist/mcp/rulebook-server.js +0 -0
  44. package/package.json +21 -22
  45. package/templates/agents/accessibility-reviewer.md +43 -43
  46. package/templates/agents/api-designer.md +42 -42
  47. package/templates/agents/architect.md +51 -51
  48. package/templates/agents/build-engineer.md +36 -36
  49. package/templates/agents/code-reviewer.md +47 -47
  50. package/templates/agents/compiler/codegen-debugger.md +34 -34
  51. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  52. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  53. package/templates/agents/context-intelligence.md +52 -52
  54. package/templates/agents/database-architect.md +41 -41
  55. package/templates/agents/devops-engineer.md +42 -42
  56. package/templates/agents/docs-writer.md +38 -38
  57. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  58. package/templates/agents/game-engine/render-engineer.md +22 -22
  59. package/templates/agents/game-engine/shader-engineer.md +38 -38
  60. package/templates/agents/game-engine/systems-integration.md +43 -43
  61. package/templates/agents/generic/code-reviewer.md +41 -41
  62. package/templates/agents/generic/docs-writer.md +25 -25
  63. package/templates/agents/generic/project-manager.md +36 -36
  64. package/templates/agents/generic/researcher.md +34 -34
  65. package/templates/agents/generic/test-engineer.md +41 -41
  66. package/templates/agents/i18n-engineer.md +42 -42
  67. package/templates/agents/implementer.md +42 -42
  68. package/templates/agents/migration-engineer.md +42 -42
  69. package/templates/agents/mobile/platform-specialist.md +22 -22
  70. package/templates/agents/mobile/ui-engineer.md +22 -22
  71. package/templates/agents/performance-engineer.md +49 -49
  72. package/templates/agents/refactoring-agent.md +41 -41
  73. package/templates/agents/researcher.md +38 -38
  74. package/templates/agents/security-reviewer.md +40 -40
  75. package/templates/agents/team-lead.md +37 -37
  76. package/templates/agents/tester.md +48 -48
  77. package/templates/agents/ux-reviewer.md +43 -43
  78. package/templates/agents/web-app/api-designer.md +22 -22
  79. package/templates/agents/web-app/backend-engineer.md +30 -30
  80. package/templates/agents/web-app/database-engineer.md +22 -22
  81. package/templates/agents/web-app/frontend-engineer.md +29 -29
  82. package/templates/agents/web-app/security-reviewer.md +32 -32
  83. package/templates/ci/rulebook-review.yml +26 -26
  84. package/templates/cli/AIDER.md +49 -49
  85. package/templates/cli/AMAZON_Q.md +25 -25
  86. package/templates/cli/AUGGIE.md +32 -32
  87. package/templates/cli/CLAUDE.md +117 -117
  88. package/templates/cli/CLINE.md +99 -99
  89. package/templates/cli/CODEBUDDY.md +20 -20
  90. package/templates/cli/CODEIUM.md +20 -20
  91. package/templates/cli/CODEX.md +21 -21
  92. package/templates/cli/CONTINUE.md +34 -34
  93. package/templates/cli/CURSOR_CLI.md +62 -62
  94. package/templates/cli/FACTORY.md +18 -18
  95. package/templates/cli/GEMINI.md +35 -35
  96. package/templates/cli/KILOCODE.md +18 -18
  97. package/templates/cli/OPENCODE.md +18 -18
  98. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  99. package/templates/commands/rulebook-decision-create.md +55 -55
  100. package/templates/commands/rulebook-decision-list.md +15 -15
  101. package/templates/commands/rulebook-knowledge-add.md +41 -41
  102. package/templates/commands/rulebook-knowledge-list.md +15 -15
  103. package/templates/commands/rulebook-learn-capture.md +48 -48
  104. package/templates/commands/rulebook-learn-list.md +13 -13
  105. package/templates/commands/rulebook-memory-save.md +48 -48
  106. package/templates/commands/rulebook-memory-search.md +47 -47
  107. package/templates/commands/rulebook-task-apply.md +67 -67
  108. package/templates/commands/rulebook-task-archive.md +94 -94
  109. package/templates/commands/rulebook-task-create.md +93 -93
  110. package/templates/commands/rulebook-task-list.md +42 -42
  111. package/templates/commands/rulebook-task-show.md +52 -52
  112. package/templates/commands/rulebook-task-validate.md +53 -53
  113. package/templates/compact-context/_default.md +23 -23
  114. package/templates/compact-context/cpp.md +26 -26
  115. package/templates/compact-context/go.md +26 -26
  116. package/templates/compact-context/python.md +26 -26
  117. package/templates/compact-context/rust.md +28 -28
  118. package/templates/compact-context/typescript.md +29 -29
  119. package/templates/core/AGENTS_LEAN.md +26 -1
  120. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  121. package/templates/core/AGENT_AUTOMATION.md +296 -296
  122. package/templates/core/CLAUDE_MD_v2.md +90 -71
  123. package/templates/core/DAG.md +304 -304
  124. package/templates/core/DECISIONS.md +38 -38
  125. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  126. package/templates/core/KNOWLEDGE.md +49 -49
  127. package/templates/core/MULTI_AGENT.md +74 -74
  128. package/templates/core/PLANS.md +28 -28
  129. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  130. package/templates/core/RALPH.md +471 -471
  131. package/templates/core/RULEBOOK.md +1947 -1947
  132. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  133. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  134. package/templates/frameworks/ANGULAR.md +36 -36
  135. package/templates/frameworks/DJANGO.md +83 -83
  136. package/templates/frameworks/ELECTRON.md +147 -147
  137. package/templates/frameworks/FLASK.md +38 -38
  138. package/templates/frameworks/FLUTTER.md +55 -55
  139. package/templates/frameworks/JQUERY.md +32 -32
  140. package/templates/frameworks/LARAVEL.md +38 -38
  141. package/templates/frameworks/NESTJS.md +43 -43
  142. package/templates/frameworks/NEXTJS.md +127 -127
  143. package/templates/frameworks/NUXT.md +40 -40
  144. package/templates/frameworks/RAILS.md +66 -66
  145. package/templates/frameworks/REACT.md +38 -38
  146. package/templates/frameworks/REACT_NATIVE.md +47 -47
  147. package/templates/frameworks/SPRING.md +39 -39
  148. package/templates/frameworks/SYMFONY.md +36 -36
  149. package/templates/frameworks/VUE.md +36 -36
  150. package/templates/frameworks/ZEND.md +35 -35
  151. package/templates/git/CI_CD_PATTERNS.md +661 -661
  152. package/templates/git/GITHUB_ACTIONS.md +728 -728
  153. package/templates/git/GITLAB_CI.md +730 -730
  154. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  155. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  156. package/templates/hooks/COMMIT_MSG.md +530 -530
  157. package/templates/hooks/POST_CHECKOUT.md +546 -546
  158. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  159. package/templates/hooks/PRE_COMMIT.md +414 -414
  160. package/templates/hooks/PRE_PUSH.md +601 -601
  161. package/templates/hooks/check-context-and-handoff.ps1 +58 -58
  162. package/templates/hooks/check-context-and-handoff.sh +76 -76
  163. package/templates/hooks/enforce-team-for-background-agents.ps1 +63 -63
  164. package/templates/hooks/enforce-team-for-background-agents.sh +55 -55
  165. package/templates/hooks/on-compact-reinject.sh +34 -34
  166. package/templates/hooks/resume-from-handoff.ps1 +40 -40
  167. package/templates/hooks/resume-from-handoff.sh +61 -61
  168. package/templates/hooks/terse-activate.ps1 +143 -143
  169. package/templates/hooks/terse-activate.sh +197 -197
  170. package/templates/hooks/terse-mode-tracker.ps1 +153 -153
  171. package/templates/hooks/terse-mode-tracker.sh +187 -187
  172. package/templates/ides/CONTINUE_RULES.md +16 -16
  173. package/templates/ides/COPILOT.md +37 -37
  174. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  175. package/templates/ides/CURSOR.md +43 -43
  176. package/templates/ides/GEMINI_RULES.md +17 -17
  177. package/templates/ides/JETBRAINS_AI.md +35 -35
  178. package/templates/ides/REPLIT.md +36 -36
  179. package/templates/ides/TABNINE.md +29 -29
  180. package/templates/ides/VSCODE.md +40 -40
  181. package/templates/ides/WINDSURF.md +36 -36
  182. package/templates/ides/WINDSURF_RULES.md +14 -14
  183. package/templates/ides/ZED.md +32 -32
  184. package/templates/ides/cursor-mdc/go.mdc +24 -24
  185. package/templates/ides/cursor-mdc/python.mdc +24 -24
  186. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  187. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  188. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  189. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  190. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  191. package/templates/languages/C.md +333 -333
  192. package/templates/languages/CPP.md +743 -743
  193. package/templates/languages/CSHARP.md +417 -417
  194. package/templates/languages/ELIXIR.md +454 -454
  195. package/templates/languages/ERLANG.md +361 -361
  196. package/templates/languages/GO.md +645 -645
  197. package/templates/languages/HASKELL.md +177 -177
  198. package/templates/languages/JAVA.md +607 -607
  199. package/templates/languages/JAVASCRIPT.md +631 -631
  200. package/templates/languages/JULIA.md +97 -97
  201. package/templates/languages/KOTLIN.md +511 -511
  202. package/templates/languages/LISP.md +100 -100
  203. package/templates/languages/LUA.md +74 -74
  204. package/templates/languages/OBJECTIVEC.md +90 -90
  205. package/templates/languages/PHP.md +416 -416
  206. package/templates/languages/PYTHON.md +682 -682
  207. package/templates/languages/RUBY.md +421 -421
  208. package/templates/languages/RUST.md +477 -477
  209. package/templates/languages/SAS.md +73 -73
  210. package/templates/languages/SCALA.md +348 -348
  211. package/templates/languages/SOLIDITY.md +580 -580
  212. package/templates/languages/SQL.md +137 -137
  213. package/templates/languages/SWIFT.md +466 -466
  214. package/templates/languages/TYPESCRIPT.md +591 -591
  215. package/templates/languages/ZIG.md +265 -265
  216. package/templates/modules/ATLASSIAN.md +255 -255
  217. package/templates/modules/CONTEXT7.md +54 -54
  218. package/templates/modules/FIGMA.md +267 -267
  219. package/templates/modules/GITHUB_MCP.md +64 -64
  220. package/templates/modules/GRAFANA.md +328 -328
  221. package/templates/modules/MEMORY.md +126 -126
  222. package/templates/modules/NOTION.md +247 -247
  223. package/templates/modules/PLAYWRIGHT.md +90 -90
  224. package/templates/modules/RULEBOOK_MCP.md +208 -208
  225. package/templates/modules/SERENA.md +337 -337
  226. package/templates/modules/SUPABASE.md +223 -223
  227. package/templates/modules/SYNAP.md +69 -69
  228. package/templates/modules/VECTORIZER.md +63 -63
  229. package/templates/modules/sequential-thinking.md +42 -42
  230. package/templates/ralph/ralph-history.bat +4 -4
  231. package/templates/ralph/ralph-history.sh +5 -5
  232. package/templates/ralph/ralph-init.bat +5 -5
  233. package/templates/ralph/ralph-init.sh +5 -5
  234. package/templates/ralph/ralph-pause.bat +5 -5
  235. package/templates/ralph/ralph-pause.sh +5 -5
  236. package/templates/ralph/ralph-run.bat +5 -5
  237. package/templates/ralph/ralph-run.sh +5 -5
  238. package/templates/ralph/ralph-status.bat +4 -4
  239. package/templates/ralph/ralph-status.sh +5 -5
  240. package/templates/rules/consult-analysis-before-implementing.md +23 -23
  241. package/templates/rules/cpp.md +46 -46
  242. package/templates/rules/csharp.md +44 -44
  243. package/templates/rules/diagnostic-first.md +39 -39
  244. package/templates/rules/fail-twice-escalate.md +46 -46
  245. package/templates/rules/follow-task-sequence.md +36 -36
  246. package/templates/rules/git-safety.md +29 -29
  247. package/templates/rules/go.md +40 -40
  248. package/templates/rules/incremental-implementation.md +56 -56
  249. package/templates/rules/incremental-tests.md +29 -29
  250. package/templates/rules/java.md +43 -43
  251. package/templates/rules/javascript.md +39 -39
  252. package/templates/rules/knowledge-base-usage.md +41 -41
  253. package/templates/rules/multi-agent-teams.md +75 -75
  254. package/templates/rules/no-deferred.md +31 -31
  255. package/templates/rules/no-shortcuts.md +30 -30
  256. package/templates/rules/python.md +43 -43
  257. package/templates/rules/research-first.md +30 -30
  258. package/templates/rules/respect-handoff-trigger.md +41 -41
  259. package/templates/rules/rust.md +40 -40
  260. package/templates/rules/sequential-editing.md +21 -21
  261. package/templates/rules/session-workflow.md +24 -24
  262. package/templates/rules/task-decomposition.md +32 -32
  263. package/templates/rules/typescript.md +40 -40
  264. package/templates/services/AZURE_BLOB.md +184 -184
  265. package/templates/services/CASSANDRA.md +239 -239
  266. package/templates/services/DATADOG.md +26 -26
  267. package/templates/services/DOCKER.md +124 -124
  268. package/templates/services/DOCKER_COMPOSE.md +168 -168
  269. package/templates/services/DYNAMODB.md +308 -308
  270. package/templates/services/ELASTICSEARCH.md +347 -347
  271. package/templates/services/GCS.md +178 -178
  272. package/templates/services/HELM.md +194 -194
  273. package/templates/services/INFLUXDB.md +265 -265
  274. package/templates/services/KAFKA.md +341 -341
  275. package/templates/services/KUBERNETES.md +208 -208
  276. package/templates/services/MARIADB.md +183 -183
  277. package/templates/services/MEMCACHED.md +242 -242
  278. package/templates/services/MINIO.md +201 -201
  279. package/templates/services/MONGODB.md +268 -268
  280. package/templates/services/MYSQL.md +358 -358
  281. package/templates/services/NEO4J.md +247 -247
  282. package/templates/services/OPENTELEMETRY.md +25 -25
  283. package/templates/services/ORACLE.md +290 -290
  284. package/templates/services/PINO.md +24 -24
  285. package/templates/services/POSTGRESQL.md +326 -326
  286. package/templates/services/PROMETHEUS.md +33 -33
  287. package/templates/services/RABBITMQ.md +286 -286
  288. package/templates/services/REDIS.md +292 -292
  289. package/templates/services/S3.md +298 -298
  290. package/templates/services/SENTRY.md +23 -23
  291. package/templates/services/SQLITE.md +294 -294
  292. package/templates/services/SQLSERVER.md +294 -294
  293. package/templates/services/WINSTON.md +30 -30
  294. package/templates/skills/cli/aider/SKILL.md +59 -59
  295. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  296. package/templates/skills/cli/auggie/SKILL.md +42 -42
  297. package/templates/skills/cli/claude/SKILL.md +42 -42
  298. package/templates/skills/cli/cline/SKILL.md +42 -42
  299. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  300. package/templates/skills/cli/codeium/SKILL.md +30 -30
  301. package/templates/skills/cli/codex/SKILL.md +31 -31
  302. package/templates/skills/cli/continue/SKILL.md +44 -44
  303. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  304. package/templates/skills/cli/factory/SKILL.md +28 -28
  305. package/templates/skills/cli/gemini/SKILL.md +45 -45
  306. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  307. package/templates/skills/cli/opencode/SKILL.md +28 -28
  308. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  309. package/templates/skills/core/dag/SKILL.md +314 -314
  310. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  311. package/templates/skills/core/karpathy-guidelines/SKILL.md +93 -0
  312. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  313. package/templates/skills/core/rulebook/SKILL.md +176 -176
  314. package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
  315. package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
  316. package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
  317. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  318. package/templates/skills/dev/analysis/SKILL.md +19 -19
  319. package/templates/skills/dev/api-design/SKILL.md +15 -15
  320. package/templates/skills/dev/architect/SKILL.md +17 -17
  321. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  322. package/templates/skills/dev/db-design/SKILL.md +15 -15
  323. package/templates/skills/dev/debug/SKILL.md +16 -16
  324. package/templates/skills/dev/deploy/SKILL.md +17 -17
  325. package/templates/skills/dev/docs/SKILL.md +17 -17
  326. package/templates/skills/dev/handoff/SKILL.md +27 -27
  327. package/templates/skills/dev/migrate/SKILL.md +15 -15
  328. package/templates/skills/dev/perf/SKILL.md +17 -17
  329. package/templates/skills/dev/refactor/SKILL.md +17 -17
  330. package/templates/skills/dev/research/SKILL.md +14 -14
  331. package/templates/skills/dev/review/SKILL.md +18 -18
  332. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  333. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  334. package/templates/skills/frameworks/django/SKILL.md +93 -93
  335. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  336. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  337. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  338. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  339. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  340. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  341. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  342. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  343. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  344. package/templates/skills/frameworks/react/SKILL.md +48 -48
  345. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  346. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  347. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  348. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  349. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  350. package/templates/skills/ides/copilot/SKILL.md +47 -47
  351. package/templates/skills/ides/cursor/SKILL.md +53 -53
  352. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  353. package/templates/skills/ides/replit/SKILL.md +46 -46
  354. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  355. package/templates/skills/ides/vscode/SKILL.md +50 -50
  356. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  357. package/templates/skills/ides/zed/SKILL.md +42 -42
  358. package/templates/skills/languages/c/SKILL.md +343 -343
  359. package/templates/skills/languages/cpp/SKILL.md +753 -753
  360. package/templates/skills/languages/csharp/SKILL.md +427 -427
  361. package/templates/skills/languages/elixir/SKILL.md +464 -464
  362. package/templates/skills/languages/erlang/SKILL.md +371 -371
  363. package/templates/skills/languages/go/SKILL.md +655 -655
  364. package/templates/skills/languages/haskell/SKILL.md +187 -187
  365. package/templates/skills/languages/java/SKILL.md +617 -617
  366. package/templates/skills/languages/javascript/SKILL.md +641 -641
  367. package/templates/skills/languages/julia/SKILL.md +107 -107
  368. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  369. package/templates/skills/languages/lisp/SKILL.md +110 -110
  370. package/templates/skills/languages/lua/SKILL.md +84 -84
  371. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  372. package/templates/skills/languages/php/SKILL.md +426 -426
  373. package/templates/skills/languages/python/SKILL.md +692 -692
  374. package/templates/skills/languages/ruby/SKILL.md +431 -431
  375. package/templates/skills/languages/rust/SKILL.md +487 -487
  376. package/templates/skills/languages/sas/SKILL.md +83 -83
  377. package/templates/skills/languages/scala/SKILL.md +358 -358
  378. package/templates/skills/languages/solidity/SKILL.md +590 -590
  379. package/templates/skills/languages/sql/SKILL.md +147 -147
  380. package/templates/skills/languages/swift/SKILL.md +476 -476
  381. package/templates/skills/languages/typescript/SKILL.md +302 -302
  382. package/templates/skills/languages/zig/SKILL.md +275 -275
  383. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  384. package/templates/skills/modules/context7/SKILL.md +64 -64
  385. package/templates/skills/modules/figma/SKILL.md +277 -277
  386. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  387. package/templates/skills/modules/grafana/SKILL.md +338 -338
  388. package/templates/skills/modules/memory/SKILL.md +73 -73
  389. package/templates/skills/modules/notion/SKILL.md +257 -257
  390. package/templates/skills/modules/playwright/SKILL.md +100 -100
  391. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  392. package/templates/skills/modules/serena/SKILL.md +347 -347
  393. package/templates/skills/modules/supabase/SKILL.md +233 -233
  394. package/templates/skills/modules/synap/SKILL.md +79 -79
  395. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  396. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  397. package/templates/skills/services/cassandra/SKILL.md +249 -249
  398. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  399. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  400. package/templates/skills/services/gcs/SKILL.md +188 -188
  401. package/templates/skills/services/influxdb/SKILL.md +275 -275
  402. package/templates/skills/services/kafka/SKILL.md +351 -351
  403. package/templates/skills/services/mariadb/SKILL.md +193 -193
  404. package/templates/skills/services/memcached/SKILL.md +252 -252
  405. package/templates/skills/services/minio/SKILL.md +211 -211
  406. package/templates/skills/services/mongodb/SKILL.md +278 -278
  407. package/templates/skills/services/mysql/SKILL.md +368 -368
  408. package/templates/skills/services/neo4j/SKILL.md +257 -257
  409. package/templates/skills/services/oracle/SKILL.md +300 -300
  410. package/templates/skills/services/postgresql/SKILL.md +336 -336
  411. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  412. package/templates/skills/services/redis/SKILL.md +302 -302
  413. package/templates/skills/services/s3/SKILL.md +308 -308
  414. package/templates/skills/services/sqlite/SKILL.md +304 -304
  415. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  416. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  417. package/templates/skills/workflows/ralph/install.sh +87 -87
  418. package/templates/skills/workflows/ralph/manifest.json +158 -158
package/README.md CHANGED
@@ -1,393 +1,394 @@
1
- # @hivehub/rulebook
2
-
3
- [![npm version](https://img.shields.io/npm/v/@hivehub/rulebook?logo=npm&logoColor=white)](https://www.npmjs.com/package/@hivehub/rulebook)
4
- [![npm downloads](https://img.shields.io/npm/dm/@hivehub/rulebook?logo=npm&logoColor=white)](https://www.npmjs.com/package/@hivehub/rulebook)
5
- [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
6
- [![Node.js](https://img.shields.io/badge/Node.js-20+-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/)
7
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
8
-
9
- [![Tests](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/test.yml?label=tests&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/test.yml)
10
- [![Build](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/build.yml?label=build&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/build.yml)
11
- [![Lint](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/lint.yml?label=lint&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/lint.yml)
12
-
13
- > Tool-agnostic AI development framework. Standardize projects across Claude Code, Cursor, Gemini, Codex, Windsurf, and Copilot with automated templates, quality gates, persistent memory, and framework detection for 28 languages, 17 frameworks, 13 MCP modules, and 20 services.
14
-
15
- ---
16
-
17
- ## Quick Start
18
-
19
- ```bash
20
- # Initialize — auto-detects languages, tools, and complexity
21
- npx @hivehub/rulebook@latest init
22
-
23
- # Update existing project to latest rules
24
- npx @hivehub/rulebook@latest update
25
-
26
- # Check project health
27
- npx @hivehub/rulebook@latest doctor
28
- ```
29
-
30
- That's it. Rulebook detects your stack, generates rules for every AI tool in your project, sets up quality gates, and configures MCP integration — all in one command.
31
-
32
- > Install globally with `npm install -g @hivehub/rulebook` to use `rulebook` directly.
33
-
34
- ---
35
-
36
- ## What Rulebook Does
37
-
38
- AI coding assistants produce inconsistent, error-prone code without clear guidelines. Rulebook gives every AI tool in your project the same set of rules — automatically.
39
-
40
- **One `init`, every tool configured:**
41
-
42
- | What | How |
43
- |------|-----|
44
- | **Rules for every AI tool** | `AGENTS.md` + `CLAUDE.md` + `.cursor/rules/` + Gemini/Copilot/Windsurf configs — all generated from a single source of truth |
45
- | **Quality gates** | Pre-commit hooks (lint, type-check, format) + pre-push hooks (build, tests) — language-aware, cross-platform |
46
- | **44+ MCP tools** | Task management, persistent memory, skills, decisions, knowledge, learnings, Ralph loop, workspace, terse compression + evals — all via Model Context Protocol |
47
- | **Structural enforcement** | `PreToolUse` hooks block forbidden patterns (deferred tasks, stubs/TODOs, manual task files) before edits reach disk |
48
- | **Session continuity** | Persistent memory across sessions, automatic handoff at context limits, STATE.md live status |
49
- | **Autonomous task solving** | Ralph loop: multi-iteration AI agent with quality gates, learning extraction, pause/resume |
50
- | **28 languages, 17 frameworks** | Auto-detected with confidence scores, language-specific templates and CI/CD workflows |
51
-
52
- ---
53
-
54
- ## Core Features
55
-
56
- ### Modular Rule System
57
-
58
- Rulebook generates a **modular `@import` chain** instead of one massive file:
59
-
60
- ```
61
- CLAUDE.md (thin, ~100 lines)
62
- @imports AGENTS.md — team-shared rules
63
- @imports AGENTS.override.md — your project overrides (survives updates)
64
- @imports .rulebook/STATE.md — live task/health status
65
- @imports .rulebook/PLANS.md — session scratchpad
66
- ```
67
-
68
- Path-scoped rules in `.claude/rules/` load only when the AI touches matching files (e.g., TypeScript rules load only for `.ts` files). 5 always-on rules enforce core behaviors: diagnostic-first, fail-twice-escalate, no-deferred, no-shortcuts, sequential-editing.
69
-
70
- ### Persistent Memory
71
-
72
- Context that survives across AI sessions. Decisions, bugs, patterns, and preferences are stored locally and searchable.
73
-
74
- | Component | Technology |
75
- |-----------|-----------|
76
- | Storage | better-sqlite3 (native) with sql.js WASM fallback |
77
- | Search | Hybrid BM25 keyword + HNSW vector (256-dim TF-IDF, no API calls) |
78
- | Ranking | Reciprocal Rank Fusion |
79
- | Privacy | Auto-redact `<private>` tags, local-only storage |
80
-
81
- ```bash
82
- rulebook memory search "authentication approach" # Hybrid search
83
- rulebook memory save "Chose JWT over sessions" # Save context
84
- rulebook memory stats # DB health
85
- ```
86
-
87
- ### Terse Mode — Output & Input Compression (v5.4.0)
88
-
89
- Structurally-enforced output compression via a SessionStart hook that injects a filtered SKILL.md and a per-turn UserPromptSubmit attention anchor. Four intensity levels aligned with Rulebook's agent tiers — `off` for opus-class reasoning, `brief` for sonnet, `terse` for haiku, `ultra` for CI/automation. Auto-clarity drops compression for security warnings, destructive ops, and quality-gate failures.
90
-
91
- ```bash
92
- /rulebook-terse # Activate using tier default
93
- /rulebook-terse ultra # Maximum compression
94
- /rulebook-terse off # Disable
95
- ```
96
-
97
- Paired with `rulebook compress` — input-side compression for memory files (`CLAUDE.md`, `AGENTS.override.md`, `.rulebook/PLANS.md`):
98
-
99
- ```bash
100
- rulebook compress --check CLAUDE.md # Report ratio + validator
101
- rulebook compress --dry-run CLAUDE.md # Preview
102
- rulebook compress CLAUDE.md # Rewrite + backup
103
- rulebook compress --restore CLAUDE.md # Revert from backup
104
- ```
105
-
106
- Preserves code blocks, URLs, file paths, dates, and version numbers byte-for-byte.
107
-
108
- **Measured** against a three-arm eval harness (`baseline` / `terse` / `rulebook-terse`) on 10 real prompts executed through the Claude Code CLI, tokens counted with `tiktoken`:
109
-
110
- | Arm | Total tokens | vs baseline | vs terse |
111
- |---|---:|---:|---:|
112
- | `baseline` (no system prompt) | 2,696 | — | −42% |
113
- | `terse` (control: `Answer concisely.`) | 4,611 | +71% | — |
114
- | `rulebook-terse` (skill active) | **1,940** | **−28%** | **−58%** |
115
-
116
- Honest delta is **`rulebook-terse` vs `terse` = 57.9% average lift**, per-prompt range **34% → 77%**. All ten prompts clear the 15% threshold individually. Interestingly, the `terse` control is 71% *larger* than `baseline` — `Answer concisely.` alone steers the model toward structured output (headings, code blocks), which inflates tokens. The skill's explicit rules reverse that effect.
117
-
118
- Regenerate snapshots against live Claude: `npx tsx evals/cli_run.ts` (shells out to `claude -p`, reuses existing CLI auth). Re-measure offline: `npx tsx evals/measure.ts`.
119
-
120
- Auto-activates after `rulebook init` or `rulebook update` — SessionStart hook writes to `.rulebook/.terse-mode`, UserPromptSubmit hook emits a ~45-token attention anchor per user message. Opt-out: set `.rulebook/rulebook.json` → `"terse": {"enabled": false}`. Override level: `"terse": {"defaultMode": "brief"}` or export `RULEBOOK_TERSE_MODE=ultra`.
121
-
122
- See [docs/analysis/caveman/](docs/analysis/caveman/) for the design rationale, [docs/guides/rulebook-terse.md](docs/guides/rulebook-terse.md) for the user guide, and `templates/hooks/terse-*.sh` for the hook source.
123
-
124
- ### Task Management
125
-
126
- Spec-driven development with OpenSpec-compatible format. Phase-prefixed task IDs, mandatory tail items (docs + tests + verify), and automatic archival.
127
-
128
- ```bash
129
- rulebook task create phase1_add-auth # Create task with structure
130
- rulebook task list # See pending work
131
- rulebook task validate phase1_add-auth # Check format
132
- rulebook task archive phase1_add-auth # Archive when done
133
- ```
134
-
135
- Each task gets: `proposal.md` (why), `tasks.md` (checklist), `specs/` (technical requirements with SHALL/MUST keywords and Given/When/Then scenarios).
136
-
137
- ### Ralph Autonomous Loop
138
-
139
- Multi-iteration AI agent that solves tasks from a PRD with fresh context per iteration. 5 quality gates (type-check, lint, tests, coverage, security) must pass before an iteration succeeds.
140
-
141
- ```bash
142
- rulebook ralph init # Generate PRD from tasks
143
- rulebook ralph run --max-iterations 10 # Execute loop
144
- rulebook ralph status # Check progress
145
- rulebook ralph history # Review iterations
146
- ```
147
-
148
- Features: parallel story execution, plan checkpoints, context compression, learning extraction, graceful pause/resume.
149
-
150
- ### Multi-Project Workspace
151
-
152
- One MCP server manages all projects in a monorepo, with fully isolated per-project managers.
153
-
154
- ```bash
155
- rulebook workspace init # Create workspace config
156
- rulebook workspace add ./frontend # Add projects
157
- rulebook mcp init --workspace # Single MCP for all
158
- ```
159
-
160
- Auto-discovers from `pnpm-workspace.yaml`, `turbo.json`, `nx.json`, `lerna.json`, or `*.code-workspace`.
161
-
162
- ### Structural Enforcement Hooks
163
-
164
- 3 `PreToolUse` hooks block forbidden patterns at the tool level — before edits reach disk:
165
-
166
- | Hook | Blocks |
167
- |------|--------|
168
- | `enforce-no-deferred` | `deferred`, `skip`, `later`, `TODO` in tasks.md |
169
- | `enforce-no-shortcuts` | Stubs, placeholders, `HACK`/`FIXME` in source files |
170
- | `enforce-mcp-for-tasks` | Manual `mkdir`/`Write` in `.rulebook/tasks/` |
171
-
172
- Cross-platform (Node.js, no `jq` dependency).
173
-
174
- ---
175
-
176
- ## MCP Server
177
-
178
- 44+ MCP tools exposed via stdio transport. Zero configuration after `rulebook mcp init`.
179
-
180
- ```bash
181
- rulebook mcp init # One-time setup — configures .mcp.json automatically
182
- ```
183
-
184
- | Category | Tools | Examples |
185
- |----------|-------|---------|
186
- | Tasks (7) | CRUD + validate + archive + delete | `rulebook_task_create`, `rulebook_task_list` |
187
- | Skills (6) | List, show, enable, disable, search, validate | `rulebook_skill_enable`, `rulebook_skill_search` |
188
- | Memory (6) | Save, search, get, timeline, stats, cleanup | `rulebook_memory_search`, `rulebook_memory_save` |
189
- | Ralph (4) | Init, run, status, history | `rulebook_ralph_run`, `rulebook_ralph_status` |
190
- | Workspace (4) | List, status, search, tasks | `rulebook_workspace_search`, `rulebook_workspace_tasks` |
191
- | Knowledge (3) | Add, list, show | `rulebook_knowledge_add`, `rulebook_knowledge_list` |
192
- | Decisions (4) | Create, list, show, update | `rulebook_decision_create`, `rulebook_decision_list` |
193
- | Learnings (3) | Capture, list, promote | `rulebook_learn_capture`, `rulebook_learn_list` |
194
- | Analysis (3) | Create, list, show | `rulebook_analysis_create`, `rulebook_analysis_list` |
195
- | Compress (2) | Compress memory files, list candidates | `rulebook_compress`, `rulebook_compress_list` |
196
- | Evals (2) | Offline measurement, live API regeneration | `rulebook_evals_measure`, `rulebook_evals_run` |
197
- | Other (3+) | Doctor, rules list, blockers, session, codebase | `rulebook_doctor_run`, `rulebook_rules_list` |
198
-
199
- All tools accept optional `projectId` for workspace routing.
200
-
201
- ---
202
-
203
- ## CLI Reference
204
-
205
- ### Project Setup
206
-
207
- ```bash
208
- rulebook init # Interactive setup (auto-detects everything)
209
- rulebook init --minimal # Essentials only
210
- rulebook init --lean # AGENTS.md as <3KB index
211
- rulebook init --light # No quality enforcement
212
- rulebook update # Update to latest rules
213
- rulebook doctor # 7 health checks
214
- rulebook validate # Check project standards
215
- rulebook health # Health score (0-100)
216
- rulebook fix # Auto-fix common issues
217
- ```
218
-
219
- ### Task Management
220
-
221
- ```bash
222
- rulebook task create <task-id> # Create (phase-prefixed: phase1_add-auth)
223
- rulebook task list # List active tasks
224
- rulebook task show <task-id> # Show details
225
- rulebook task validate <task-id> # Validate format
226
- rulebook task archive <task-id> # Archive completed task
227
- rulebook task delete <task-id> # Delete permanently
228
- ```
229
-
230
- ### Memory & Knowledge
231
-
232
- ```bash
233
- rulebook memory search <query> # Hybrid BM25+vector search
234
- rulebook memory save <text> # Save context
235
- rulebook memory stats # Database health
236
- rulebook memory cleanup # Evict old memories
237
- rulebook knowledge list # View patterns and anti-patterns
238
- rulebook learn list # View captured learnings
239
- rulebook decision list # View architecture decisions
240
- ```
241
-
242
- ### Ralph Autonomous Loop
243
-
244
- ```bash
245
- rulebook ralph init # Generate PRD from tasks
246
- rulebook ralph run # Execute iteration loop
247
- rulebook ralph status # Current progress
248
- rulebook ralph history # Past iterations
249
- rulebook ralph pause # Gracefully pause
250
- rulebook ralph resume # Resume from pause
251
- ```
252
-
253
- ### Workspace
254
-
255
- ```bash
256
- rulebook workspace init # Create workspace config
257
- rulebook workspace add <path> # Add project
258
- rulebook workspace list # List all projects
259
- rulebook workspace status # Status with task counts
260
- ```
261
-
262
- ### Rules & Skills
263
-
264
- ```bash
265
- rulebook rules list # List rules by tier
266
- rulebook rules add <rule> # Install from library
267
- rulebook rules project # Project to all tools
268
- rulebook skill list # List available skills
269
- rulebook skill add <skill-id> # Enable a skill
270
- rulebook skill show <skill-id> # Show skill details
271
- ```
272
-
273
- ### CI/CD & Quality
274
-
275
- ```bash
276
- rulebook workflows # Generate GitHub Actions
277
- rulebook check-deps # Check dependencies
278
- rulebook check-coverage # Check test coverage
279
- rulebook version <major|minor|patch> # Bump version
280
- rulebook changelog # Generate from git commits
281
- ```
282
-
283
- ---
284
-
285
- ## Supported Stack
286
-
287
- **28 Languages**: TypeScript, JavaScript, Python, Rust, Go, Java, Kotlin, C, C++, C#, PHP, Ruby, Swift, Elixir, Dart, Scala, Haskell, Julia, R, Lua, Solidity, Zig, Erlang, Ada, SAS, Lisp, Objective-C, SQL
288
-
289
- **17 Frameworks**: NestJS, Spring Boot, Laravel, Django, Flask, Rails, Symfony, Zend, Angular, React, Vue, Nuxt, Next.js, jQuery, React Native, Flutter, Electron
290
-
291
- **20 Services**: PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, SQLite, MongoDB, Cassandra, DynamoDB, Redis, Memcached, Elasticsearch, Neo4j, InfluxDB, RabbitMQ, Kafka, S3, Azure Blob, GCS, MinIO
292
-
293
- **13 MCP Modules**: Vectorizer, Synap, Context7, GitHub MCP, Playwright, Memory, Supabase, Notion, Atlassian, Serena, Figma, Grafana, Sequential Thinking
294
-
295
- **23 AI Tools**: Cursor, Windsurf, VS Code, GitHub Copilot, Tabnine, Replit, JetBrains AI, Zed, Aider, Continue, Claude, Claude Code, Gemini, Cline, Amazon Q, Auggie, CodeBuddy, Factory, OpenCode, Kilo, Codex, Codeium, Cursor CLI
296
-
297
- ---
298
-
299
- ## VSCode Extension
300
-
301
- The **Rulebook Dashboard** extension provides full visibility into your AI workflow.
302
-
303
- ```bash
304
- code --install-extension vscode-extension/rulebook-dashboard-*.vsix
305
- ```
306
-
307
- | Tab | Shows |
308
- |-----|-------|
309
- | Agents | Team members with real-time status, memory state, last activity |
310
- | Tasks | Progress bars, expandable details, Archive & Update buttons |
311
- | Memory | Stats (count, DB size, types), full-text search |
312
- | Analysis | Structured analyses with findings and execution plans |
313
- | Doctor | 7 health checks with auto-run |
314
- | Telemetry | MCP tool latency and success rates |
315
-
316
- Status bar: context usage indicator (`ctx 78%` with green/yellow/red), Rulebook button, indexer state.
317
-
318
- ---
319
-
320
- ## Configuration
321
-
322
- All config lives in `.rulebook/rulebook.json`:
323
-
324
- ```json
325
- {
326
- "version": "5.3.0",
327
- "mode": "full",
328
- "features": {
329
- "mcp": true,
330
- "memory": true,
331
- "ralph": true,
332
- "multiAgent": true,
333
- "hooks": true,
334
- "telemetry": false
335
- }
336
- }
337
- ```
338
-
339
- **Key files generated by Rulebook:**
340
-
341
- | File | Purpose |
342
- |------|---------|
343
- | `AGENTS.md` | Team-shared AI rules (regenerated on update) |
344
- | `AGENTS.override.md` | Your project overrides (survives updates) |
345
- | `CLAUDE.md` | Claude Code entry point with @imports |
346
- | `.claude/rules/` | Path-scoped rules (language-specific + always-on) |
347
- | `.claude/settings.json` | Hooks and env vars for Claude Code |
348
- | `.rulebook/specs/` | Detailed spec templates per language/framework |
349
- | `.rulebook/STATE.md` | Machine-written live status |
350
- | `.rulebook/tasks/` | Active task directories |
351
-
352
- ---
353
-
354
- ## Documentation
355
-
356
- Full documentation in [`/docs`](docs/):
357
-
358
- - [Getting Started](docs/guides/GETTING_STARTED.md)
359
- - [Best Practices](docs/guides/BEST_PRACTICES.md)
360
- - [CLI Agents](docs/CLI_AGENTS.md)
361
- - [Roadmap](docs/ROADMAP.md)
362
-
363
- See the full [CHANGELOG](CHANGELOG.md) for version history.
364
-
365
- ---
366
-
367
- ## Contributing
368
-
369
- Contributions welcome! Requires Node.js 20+.
370
-
371
- ```bash
372
- git clone https://github.com/hivellm/rulebook.git
373
- cd rulebook
374
- npm install
375
- npm test
376
- npm run build
377
- ```
378
-
379
- ---
380
-
381
- ## Acknowledgments
382
-
383
- - **[Ralph](https://github.com/snarktank/ralph)** — Inspired the autonomous loop integration (multi-iteration AI task solving with fresh context per iteration)
384
- - **[OpenSpec](https://github.com/Fission-AI/openspec)** — Influenced the task management format (delta-based specs, Given/When/Then scenarios, requirement-focused organization)
385
- - **[Caveman](https://github.com/JuliusBrussee/caveman)** — Grounding for the v5.4.0 terse-mode design (SessionStart + UserPromptSubmit hook pattern, intensity-filtered SKILL.md injection, three-arm eval harness). See [docs/analysis/caveman/](docs/analysis/caveman/) for the full analysis.
386
-
387
- ---
388
-
389
- ## License
390
-
391
- Apache License 2.0 &copy; HiveLLM Team
392
-
393
- [Issues](https://github.com/hivellm/rulebook/issues) &middot; [Discussions](https://github.com/hivellm/rulebook/discussions) &middot; [npm](https://www.npmjs.com/package/@hivehub/rulebook)
1
+ # @hivehub/rulebook
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@hivehub/rulebook?logo=npm&logoColor=white)](https://www.npmjs.com/package/@hivehub/rulebook)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@hivehub/rulebook?logo=npm&logoColor=white)](https://www.npmjs.com/package/@hivehub/rulebook)
5
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
6
+ [![Node.js](https://img.shields.io/badge/Node.js-20+-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/)
7
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
8
+
9
+ [![Tests](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/test.yml?label=tests&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/test.yml)
10
+ [![Build](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/build.yml?label=build&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/build.yml)
11
+ [![Lint](https://img.shields.io/github/actions/workflow/status/hivellm/rulebook/lint.yml?label=lint&logo=github)](https://github.com/hivellm/rulebook/actions/workflows/lint.yml)
12
+
13
+ > Tool-agnostic AI development framework. Standardize projects across Claude Code, Cursor, Gemini, Codex, Windsurf, and Copilot with automated templates, quality gates, persistent memory, and framework detection for 28 languages, 17 frameworks, 13 MCP modules, and 20 services.
14
+
15
+ ---
16
+
17
+ ## Quick Start
18
+
19
+ ```bash
20
+ # Initialize — auto-detects languages, tools, and complexity
21
+ npx @hivehub/rulebook@latest init
22
+
23
+ # Update existing project to latest rules
24
+ npx @hivehub/rulebook@latest update
25
+
26
+ # Check project health
27
+ npx @hivehub/rulebook@latest doctor
28
+ ```
29
+
30
+ That's it. Rulebook detects your stack, generates rules for every AI tool in your project, sets up quality gates, and configures MCP integration — all in one command.
31
+
32
+ > Install globally with `npm install -g @hivehub/rulebook` to use `rulebook` directly.
33
+
34
+ ---
35
+
36
+ ## What Rulebook Does
37
+
38
+ AI coding assistants produce inconsistent, error-prone code without clear guidelines. Rulebook gives every AI tool in your project the same set of rules — automatically.
39
+
40
+ **One `init`, every tool configured:**
41
+
42
+ | What | How |
43
+ |------|-----|
44
+ | **Rules for every AI tool** | `AGENTS.md` + `CLAUDE.md` + `.cursor/rules/` + Gemini/Copilot/Windsurf configs — all generated from a single source of truth |
45
+ | **Quality gates** | Pre-commit hooks (lint, type-check, format) + pre-push hooks (build, tests) — language-aware, cross-platform |
46
+ | **44+ MCP tools** | Task management, persistent memory, skills, decisions, knowledge, learnings, Ralph loop, workspace, terse compression + evals — all via Model Context Protocol |
47
+ | **Structural enforcement** | `PreToolUse` hooks block forbidden patterns (deferred tasks, stubs/TODOs, manual task files) before edits reach disk |
48
+ | **Session continuity** | Persistent memory across sessions, automatic handoff at context limits, STATE.md live status |
49
+ | **Autonomous task solving** | Ralph loop: multi-iteration AI agent with quality gates, learning extraction, pause/resume |
50
+ | **28 languages, 17 frameworks** | Auto-detected with confidence scores, language-specific templates and CI/CD workflows |
51
+
52
+ ---
53
+
54
+ ## Core Features
55
+
56
+ ### Modular Rule System
57
+
58
+ Rulebook generates a **modular `@import` chain** instead of one massive file:
59
+
60
+ ```
61
+ CLAUDE.md (thin, ~100 lines)
62
+ @imports AGENTS.md — team-shared rules
63
+ @imports AGENTS.override.md — your project overrides (survives updates)
64
+ @imports .rulebook/STATE.md — live task/health status
65
+ @imports .rulebook/PLANS.md — session scratchpad
66
+ ```
67
+
68
+ Path-scoped rules in `.claude/rules/` load only when the AI touches matching files (e.g., TypeScript rules load only for `.ts` files). 5 always-on rules enforce core behaviors: diagnostic-first, fail-twice-escalate, no-deferred, no-shortcuts, sequential-editing.
69
+
70
+ ### Persistent Memory
71
+
72
+ Context that survives across AI sessions. Decisions, bugs, patterns, and preferences are stored locally and searchable.
73
+
74
+ | Component | Technology |
75
+ |-----------|-----------|
76
+ | Storage | better-sqlite3 (native) with sql.js WASM fallback |
77
+ | Search | Hybrid BM25 keyword + HNSW vector (256-dim TF-IDF, no API calls) |
78
+ | Ranking | Reciprocal Rank Fusion |
79
+ | Privacy | Auto-redact `<private>` tags, local-only storage |
80
+
81
+ ```bash
82
+ rulebook memory search "authentication approach" # Hybrid search
83
+ rulebook memory save "Chose JWT over sessions" # Save context
84
+ rulebook memory stats # DB health
85
+ ```
86
+
87
+ ### Terse Mode — Output & Input Compression (v5.4.0)
88
+
89
+ Structurally-enforced output compression via a SessionStart hook that injects a filtered SKILL.md and a per-turn UserPromptSubmit attention anchor. Four intensity levels aligned with Rulebook's agent tiers — `off` for opus-class reasoning, `brief` for sonnet, `terse` for haiku, `ultra` for CI/automation. Auto-clarity drops compression for security warnings, destructive ops, and quality-gate failures.
90
+
91
+ ```bash
92
+ /rulebook-terse # Activate using tier default
93
+ /rulebook-terse ultra # Maximum compression
94
+ /rulebook-terse off # Disable
95
+ ```
96
+
97
+ Paired with `rulebook compress` — input-side compression for memory files (`CLAUDE.md`, `AGENTS.override.md`, `.rulebook/PLANS.md`):
98
+
99
+ ```bash
100
+ rulebook compress --check CLAUDE.md # Report ratio + validator
101
+ rulebook compress --dry-run CLAUDE.md # Preview
102
+ rulebook compress CLAUDE.md # Rewrite + backup
103
+ rulebook compress --restore CLAUDE.md # Revert from backup
104
+ ```
105
+
106
+ Preserves code blocks, URLs, file paths, dates, and version numbers byte-for-byte.
107
+
108
+ **Measured** against a three-arm eval harness (`baseline` / `terse` / `rulebook-terse`) on 10 real prompts executed through the Claude Code CLI, tokens counted with `tiktoken`:
109
+
110
+ | Arm | Total tokens | vs baseline | vs terse |
111
+ |---|---:|---:|---:|
112
+ | `baseline` (no system prompt) | 2,696 | — | −42% |
113
+ | `terse` (control: `Answer concisely.`) | 4,611 | +71% | — |
114
+ | `rulebook-terse` (skill active) | **1,940** | **−28%** | **−58%** |
115
+
116
+ Honest delta is **`rulebook-terse` vs `terse` = 57.9% average lift**, per-prompt range **34% → 77%**. All ten prompts clear the 15% threshold individually. Interestingly, the `terse` control is 71% *larger* than `baseline` — `Answer concisely.` alone steers the model toward structured output (headings, code blocks), which inflates tokens. The skill's explicit rules reverse that effect.
117
+
118
+ Regenerate snapshots against live Claude: `npx tsx evals/cli_run.ts` (shells out to `claude -p`, reuses existing CLI auth). Re-measure offline: `npx tsx evals/measure.ts`.
119
+
120
+ Auto-activates after `rulebook init` or `rulebook update` — SessionStart hook writes to `.rulebook/.terse-mode`, UserPromptSubmit hook emits a ~45-token attention anchor per user message. Opt-out: set `.rulebook/rulebook.json` → `"terse": {"enabled": false}`. Override level: `"terse": {"defaultMode": "brief"}` or export `RULEBOOK_TERSE_MODE=ultra`.
121
+
122
+ See [docs/analysis/caveman/](docs/analysis/caveman/) for the design rationale, [docs/guides/rulebook-terse.md](docs/guides/rulebook-terse.md) for the user guide, and `templates/hooks/terse-*.sh` for the hook source.
123
+
124
+ ### Task Management
125
+
126
+ Spec-driven development with OpenSpec-compatible format. Phase-prefixed task IDs, mandatory tail items (docs + tests + verify), and automatic archival.
127
+
128
+ ```bash
129
+ rulebook task create phase1_add-auth # Create task with structure
130
+ rulebook task list # See pending work
131
+ rulebook task validate phase1_add-auth # Check format
132
+ rulebook task archive phase1_add-auth # Archive when done
133
+ ```
134
+
135
+ Each task gets: `proposal.md` (why), `tasks.md` (checklist), `specs/` (technical requirements with SHALL/MUST keywords and Given/When/Then scenarios).
136
+
137
+ ### Ralph Autonomous Loop
138
+
139
+ Multi-iteration AI agent that solves tasks from a PRD with fresh context per iteration. 5 quality gates (type-check, lint, tests, coverage, security) must pass before an iteration succeeds.
140
+
141
+ ```bash
142
+ rulebook ralph init # Generate PRD from tasks
143
+ rulebook ralph run --max-iterations 10 # Execute loop
144
+ rulebook ralph status # Check progress
145
+ rulebook ralph history # Review iterations
146
+ ```
147
+
148
+ Features: parallel story execution, plan checkpoints, context compression, learning extraction, graceful pause/resume.
149
+
150
+ ### Multi-Project Workspace
151
+
152
+ One MCP server manages all projects in a monorepo, with fully isolated per-project managers.
153
+
154
+ ```bash
155
+ rulebook workspace init # Create workspace config
156
+ rulebook workspace add ./frontend # Add projects
157
+ rulebook mcp init --workspace # Single MCP for all
158
+ ```
159
+
160
+ Auto-discovers from `pnpm-workspace.yaml`, `turbo.json`, `nx.json`, `lerna.json`, or `*.code-workspace`.
161
+
162
+ ### Structural Enforcement Hooks
163
+
164
+ 3 `PreToolUse` hooks block forbidden patterns at the tool level — before edits reach disk:
165
+
166
+ | Hook | Blocks |
167
+ |------|--------|
168
+ | `enforce-no-deferred` | `deferred`, `skip`, `later`, `TODO` in tasks.md |
169
+ | `enforce-no-shortcuts` | Stubs, placeholders, `HACK`/`FIXME` in source files |
170
+ | `enforce-mcp-for-tasks` | Manual `mkdir`/`Write` in `.rulebook/tasks/` |
171
+
172
+ Cross-platform (Node.js, no `jq` dependency).
173
+
174
+ ---
175
+
176
+ ## MCP Server
177
+
178
+ 44+ MCP tools exposed via stdio transport. Zero configuration after `rulebook mcp init`.
179
+
180
+ ```bash
181
+ rulebook mcp init # One-time setup — configures .mcp.json automatically
182
+ ```
183
+
184
+ | Category | Tools | Examples |
185
+ |----------|-------|---------|
186
+ | Tasks (7) | CRUD + validate + archive + delete | `rulebook_task_create`, `rulebook_task_list` |
187
+ | Skills (6) | List, show, enable, disable, search, validate | `rulebook_skill_enable`, `rulebook_skill_search` |
188
+ | Memory (6) | Save, search, get, timeline, stats, cleanup | `rulebook_memory_search`, `rulebook_memory_save` |
189
+ | Ralph (4) | Init, run, status, history | `rulebook_ralph_run`, `rulebook_ralph_status` |
190
+ | Workspace (4) | List, status, search, tasks | `rulebook_workspace_search`, `rulebook_workspace_tasks` |
191
+ | Knowledge (3) | Add, list, show | `rulebook_knowledge_add`, `rulebook_knowledge_list` |
192
+ | Decisions (4) | Create, list, show, update | `rulebook_decision_create`, `rulebook_decision_list` |
193
+ | Learnings (3) | Capture, list, promote | `rulebook_learn_capture`, `rulebook_learn_list` |
194
+ | Analysis (3) | Create, list, show | `rulebook_analysis_create`, `rulebook_analysis_list` |
195
+ | Compress (2) | Compress memory files, list candidates | `rulebook_compress`, `rulebook_compress_list` |
196
+ | Evals (2) | Offline measurement, live API regeneration | `rulebook_evals_measure`, `rulebook_evals_run` |
197
+ | Other (3+) | Doctor, rules list, blockers, session, codebase | `rulebook_doctor_run`, `rulebook_rules_list` |
198
+
199
+ All tools accept optional `projectId` for workspace routing.
200
+
201
+ ---
202
+
203
+ ## CLI Reference
204
+
205
+ ### Project Setup
206
+
207
+ ```bash
208
+ rulebook init # Interactive setup (auto-detects everything)
209
+ rulebook init --minimal # Essentials only
210
+ rulebook init --lean # AGENTS.md as <3KB index
211
+ rulebook init --light # No quality enforcement
212
+ rulebook update # Update to latest rules
213
+ rulebook doctor # 7 health checks
214
+ rulebook validate # Check project standards
215
+ rulebook health # Health score (0-100)
216
+ rulebook fix # Auto-fix common issues
217
+ ```
218
+
219
+ ### Task Management
220
+
221
+ ```bash
222
+ rulebook task create <task-id> # Create (phase-prefixed: phase1_add-auth)
223
+ rulebook task list # List active tasks
224
+ rulebook task show <task-id> # Show details
225
+ rulebook task validate <task-id> # Validate format
226
+ rulebook task archive <task-id> # Archive completed task
227
+ rulebook task delete <task-id> # Delete permanently
228
+ ```
229
+
230
+ ### Memory & Knowledge
231
+
232
+ ```bash
233
+ rulebook memory search <query> # Hybrid BM25+vector search
234
+ rulebook memory save <text> # Save context
235
+ rulebook memory stats # Database health
236
+ rulebook memory cleanup # Evict old memories
237
+ rulebook knowledge list # View patterns and anti-patterns
238
+ rulebook learn list # View captured learnings
239
+ rulebook decision list # View architecture decisions
240
+ ```
241
+
242
+ ### Ralph Autonomous Loop
243
+
244
+ ```bash
245
+ rulebook ralph init # Generate PRD from tasks
246
+ rulebook ralph run # Execute iteration loop
247
+ rulebook ralph status # Current progress
248
+ rulebook ralph history # Past iterations
249
+ rulebook ralph pause # Gracefully pause
250
+ rulebook ralph resume # Resume from pause
251
+ ```
252
+
253
+ ### Workspace
254
+
255
+ ```bash
256
+ rulebook workspace init # Create workspace config
257
+ rulebook workspace add <path> # Add project
258
+ rulebook workspace list # List all projects
259
+ rulebook workspace status # Status with task counts
260
+ ```
261
+
262
+ ### Rules & Skills
263
+
264
+ ```bash
265
+ rulebook rules list # List rules by tier
266
+ rulebook rules add <rule> # Install from library
267
+ rulebook rules project # Project to all tools
268
+ rulebook skill list # List available skills
269
+ rulebook skill add <skill-id> # Enable a skill
270
+ rulebook skill show <skill-id> # Show skill details
271
+ ```
272
+
273
+ ### CI/CD & Quality
274
+
275
+ ```bash
276
+ rulebook workflows # Generate GitHub Actions
277
+ rulebook check-deps # Check dependencies
278
+ rulebook check-coverage # Check test coverage
279
+ rulebook version <major|minor|patch> # Bump version
280
+ rulebook changelog # Generate from git commits
281
+ ```
282
+
283
+ ---
284
+
285
+ ## Supported Stack
286
+
287
+ **28 Languages**: TypeScript, JavaScript, Python, Rust, Go, Java, Kotlin, C, C++, C#, PHP, Ruby, Swift, Elixir, Dart, Scala, Haskell, Julia, R, Lua, Solidity, Zig, Erlang, Ada, SAS, Lisp, Objective-C, SQL
288
+
289
+ **17 Frameworks**: NestJS, Spring Boot, Laravel, Django, Flask, Rails, Symfony, Zend, Angular, React, Vue, Nuxt, Next.js, jQuery, React Native, Flutter, Electron
290
+
291
+ **20 Services**: PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, SQLite, MongoDB, Cassandra, DynamoDB, Redis, Memcached, Elasticsearch, Neo4j, InfluxDB, RabbitMQ, Kafka, S3, Azure Blob, GCS, MinIO
292
+
293
+ **13 MCP Modules**: Vectorizer, Synap, Context7, GitHub MCP, Playwright, Memory, Supabase, Notion, Atlassian, Serena, Figma, Grafana, Sequential Thinking
294
+
295
+ **23 AI Tools**: Cursor, Windsurf, VS Code, GitHub Copilot, Tabnine, Replit, JetBrains AI, Zed, Aider, Continue, Claude, Claude Code, Gemini, Cline, Amazon Q, Auggie, CodeBuddy, Factory, OpenCode, Kilo, Codex, Codeium, Cursor CLI
296
+
297
+ ---
298
+
299
+ ## VSCode Extension
300
+
301
+ The **Rulebook Dashboard** extension provides full visibility into your AI workflow.
302
+
303
+ ```bash
304
+ code --install-extension vscode-extension/rulebook-dashboard-*.vsix
305
+ ```
306
+
307
+ | Tab | Shows |
308
+ |-----|-------|
309
+ | Agents | Team members with real-time status, memory state, last activity |
310
+ | Tasks | Progress bars, expandable details, Archive & Update buttons |
311
+ | Memory | Stats (count, DB size, types), full-text search |
312
+ | Analysis | Structured analyses with findings and execution plans |
313
+ | Doctor | 7 health checks with auto-run |
314
+ | Telemetry | MCP tool latency and success rates |
315
+
316
+ Status bar: context usage indicator (`ctx 78%` with green/yellow/red), Rulebook button, indexer state.
317
+
318
+ ---
319
+
320
+ ## Configuration
321
+
322
+ All config lives in `.rulebook/rulebook.json`:
323
+
324
+ ```json
325
+ {
326
+ "version": "5.3.0",
327
+ "mode": "full",
328
+ "features": {
329
+ "mcp": true,
330
+ "memory": true,
331
+ "ralph": true,
332
+ "multiAgent": true,
333
+ "hooks": true,
334
+ "telemetry": false
335
+ }
336
+ }
337
+ ```
338
+
339
+ **Key files generated by Rulebook:**
340
+
341
+ | File | Purpose |
342
+ |------|---------|
343
+ | `AGENTS.md` | Team-shared AI rules (regenerated on update) |
344
+ | `AGENTS.override.md` | Your project overrides (survives updates) |
345
+ | `CLAUDE.md` | Claude Code entry point with @imports |
346
+ | `.claude/rules/` | Path-scoped rules (language-specific + always-on) |
347
+ | `.claude/settings.json` | Hooks and env vars for Claude Code |
348
+ | `.rulebook/specs/` | Detailed spec templates per language/framework |
349
+ | `.rulebook/STATE.md` | Machine-written live status |
350
+ | `.rulebook/tasks/` | Active task directories |
351
+
352
+ ---
353
+
354
+ ## Documentation
355
+
356
+ Full documentation in [`/docs`](docs/):
357
+
358
+ - [Getting Started](docs/guides/GETTING_STARTED.md)
359
+ - [Best Practices](docs/guides/BEST_PRACTICES.md)
360
+ - [CLI Agents](docs/CLI_AGENTS.md)
361
+ - [Roadmap](docs/ROADMAP.md)
362
+
363
+ See the full [CHANGELOG](CHANGELOG.md) for version history.
364
+
365
+ ---
366
+
367
+ ## Contributing
368
+
369
+ Contributions welcome! Requires Node.js 20+.
370
+
371
+ ```bash
372
+ git clone https://github.com/hivellm/rulebook.git
373
+ cd rulebook
374
+ npm install
375
+ npm test
376
+ npm run build
377
+ ```
378
+
379
+ ---
380
+
381
+ ## Acknowledgments
382
+
383
+ - **[Ralph](https://github.com/snarktank/ralph)** — Inspired the autonomous loop integration (multi-iteration AI task solving with fresh context per iteration)
384
+ - **[OpenSpec](https://github.com/Fission-AI/openspec)** — Influenced the task management format (delta-based specs, Given/When/Then scenarios, requirement-focused organization)
385
+ - **[Caveman](https://github.com/JuliusBrussee/caveman)** — Grounding for the v5.4.0 terse-mode design (SessionStart + UserPromptSubmit hook pattern, intensity-filtered SKILL.md injection, three-arm eval harness). See [docs/analysis/caveman/](docs/analysis/caveman/) for the full analysis.
386
+ - **[forrestchang/andrej-karpathy-skills](https://github.com/forrestchang/andrej-karpathy-skills)** — Source of the four "Editing Discipline" principles (think before coding, simplicity first, surgical changes, goal-driven execution) inlined in the generated `AGENTS.md`. Grounded in [Andrej Karpathy's observations](https://x.com/karpathy/status/2015883857489522876) on common LLM coding pitfalls.
387
+
388
+ ---
389
+
390
+ ## License
391
+
392
+ Apache License 2.0 &copy; HiveLLM Team
393
+
394
+ [Issues](https://github.com/hivellm/rulebook/issues) &middot; [Discussions](https://github.com/hivellm/rulebook/discussions) &middot; [npm](https://www.npmjs.com/package/@hivehub/rulebook)