@hivehub/rulebook 5.5.2 → 5.7.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 (325) hide show
  1. package/.claude/commands/rulebook-learn-capture.md +41 -48
  2. package/.claude/commands/rulebook-learn-list.md +13 -13
  3. package/README.md +332 -394
  4. package/dist/cli/commands/context-intelligence.d.ts +0 -1
  5. package/dist/cli/commands/context-intelligence.d.ts.map +1 -1
  6. package/dist/cli/commands/context-intelligence.js +12 -33
  7. package/dist/cli/commands/context-intelligence.js.map +1 -1
  8. package/dist/cli/commands/index.d.ts +4 -7
  9. package/dist/cli/commands/index.d.ts.map +1 -1
  10. package/dist/cli/commands/index.js +4 -7
  11. package/dist/cli/commands/index.js.map +1 -1
  12. package/dist/cli/commands/init.d.ts.map +1 -1
  13. package/dist/cli/commands/init.js +40 -81
  14. package/dist/cli/commands/init.js.map +1 -1
  15. package/dist/cli/commands/mcp.d.ts +0 -1
  16. package/dist/cli/commands/mcp.d.ts.map +1 -1
  17. package/dist/cli/commands/mcp.js +1 -7
  18. package/dist/cli/commands/mcp.js.map +1 -1
  19. package/dist/cli/commands/memory.d.ts +7 -1
  20. package/dist/cli/commands/memory.d.ts.map +1 -1
  21. package/dist/cli/commands/memory.js +51 -57
  22. package/dist/cli/commands/memory.js.map +1 -1
  23. package/dist/cli/commands/misc.d.ts +1 -15
  24. package/dist/cli/commands/misc.d.ts.map +1 -1
  25. package/dist/cli/commands/misc.js +36 -215
  26. package/dist/cli/commands/misc.js.map +1 -1
  27. package/dist/cli/commands/plans.d.ts +0 -6
  28. package/dist/cli/commands/plans.d.ts.map +1 -1
  29. package/dist/cli/commands/plans.js +9 -77
  30. package/dist/cli/commands/plans.js.map +1 -1
  31. package/dist/cli/commands/skills.js +6 -6
  32. package/dist/cli/commands/skills.js.map +1 -1
  33. package/dist/cli/commands/task.js +4 -4
  34. package/dist/cli/commands/task.js.map +1 -1
  35. package/dist/cli/commands/update.d.ts.map +1 -1
  36. package/dist/cli/commands/update.js +122 -52
  37. package/dist/cli/commands/update.js.map +1 -1
  38. package/dist/cli/prompts.d.ts.map +1 -1
  39. package/dist/cli/prompts.js +1 -78
  40. package/dist/cli/prompts.js.map +1 -1
  41. package/dist/core/claude/claude-mcp.d.ts +59 -0
  42. package/dist/core/claude/claude-mcp.d.ts.map +1 -0
  43. package/dist/core/claude/claude-mcp.js +220 -0
  44. package/dist/core/claude/claude-mcp.js.map +1 -0
  45. package/dist/core/claude/claude-md-generator.d.ts +52 -0
  46. package/dist/core/claude/claude-md-generator.d.ts.map +1 -0
  47. package/dist/core/claude/claude-md-generator.js +104 -0
  48. package/dist/core/claude/claude-md-generator.js.map +1 -0
  49. package/dist/core/claude/claude-settings-manager.d.ts +44 -0
  50. package/dist/core/claude/claude-settings-manager.d.ts.map +1 -0
  51. package/dist/core/claude/claude-settings-manager.js +194 -0
  52. package/dist/core/claude/claude-settings-manager.js.map +1 -0
  53. package/dist/core/console/cli-bridge.d.ts +113 -0
  54. package/dist/core/console/cli-bridge.d.ts.map +1 -0
  55. package/dist/core/console/cli-bridge.js +1094 -0
  56. package/dist/core/console/cli-bridge.js.map +1 -0
  57. package/dist/core/detect/detector.d.ts +35 -0
  58. package/dist/core/detect/detector.d.ts.map +1 -0
  59. package/dist/core/detect/detector.js +541 -0
  60. package/dist/core/detect/detector.js.map +1 -0
  61. package/dist/core/docs/docs-generator.d.ts +9 -0
  62. package/dist/core/docs/docs-generator.d.ts.map +1 -0
  63. package/dist/core/docs/docs-generator.js +531 -0
  64. package/dist/core/docs/docs-generator.js.map +1 -0
  65. package/dist/core/docs/mcp-reference-generator.d.ts +13 -0
  66. package/dist/core/docs/mcp-reference-generator.d.ts.map +1 -0
  67. package/dist/core/docs/mcp-reference-generator.js +66 -0
  68. package/dist/core/docs/mcp-reference-generator.js.map +1 -0
  69. package/dist/core/generators/generator.d.ts +54 -0
  70. package/dist/core/generators/generator.d.ts.map +1 -0
  71. package/dist/core/generators/generator.js +1041 -0
  72. package/dist/core/generators/generator.js.map +1 -0
  73. package/dist/core/generators/gitignore-generator.d.ts +13 -0
  74. package/dist/core/generators/gitignore-generator.d.ts.map +1 -0
  75. package/dist/core/generators/gitignore-generator.js +307 -0
  76. package/dist/core/generators/gitignore-generator.js.map +1 -0
  77. package/dist/core/generators/minimal-scaffolder.d.ts +8 -0
  78. package/dist/core/generators/minimal-scaffolder.d.ts.map +1 -0
  79. package/dist/core/generators/minimal-scaffolder.js +51 -0
  80. package/dist/core/generators/minimal-scaffolder.js.map +1 -0
  81. package/dist/core/generators/rules-generator.d.ts +73 -0
  82. package/dist/core/generators/rules-generator.d.ts.map +1 -0
  83. package/dist/core/generators/rules-generator.js +202 -0
  84. package/dist/core/generators/rules-generator.js.map +1 -0
  85. package/dist/core/generators/workflow-generator.d.ts +15 -0
  86. package/dist/core/generators/workflow-generator.d.ts.map +1 -0
  87. package/dist/core/generators/workflow-generator.js +390 -0
  88. package/dist/core/generators/workflow-generator.js.map +1 -0
  89. package/dist/core/ide/multi-tool-generator.d.ts +59 -0
  90. package/dist/core/ide/multi-tool-generator.d.ts.map +1 -0
  91. package/dist/core/ide/multi-tool-generator.js +157 -0
  92. package/dist/core/ide/multi-tool-generator.js.map +1 -0
  93. package/dist/core/ide/opencode-generator.d.ts +72 -0
  94. package/dist/core/ide/opencode-generator.d.ts.map +1 -0
  95. package/dist/core/ide/opencode-generator.js +450 -0
  96. package/dist/core/ide/opencode-generator.js.map +1 -0
  97. package/dist/core/merger.d.ts +1 -1
  98. package/dist/core/merger.d.ts.map +1 -1
  99. package/dist/core/merger.js +5 -5
  100. package/dist/core/merger.js.map +1 -1
  101. package/dist/core/migrator.d.ts +0 -1
  102. package/dist/core/migrator.d.ts.map +1 -1
  103. package/dist/core/migrator.js +4 -29
  104. package/dist/core/migrator.js.map +1 -1
  105. package/dist/core/quality/coverage-checker.d.ts +14 -0
  106. package/dist/core/quality/coverage-checker.d.ts.map +1 -0
  107. package/dist/core/quality/coverage-checker.js +176 -0
  108. package/dist/core/quality/coverage-checker.js.map +1 -0
  109. package/dist/core/quality/dependency-checker.d.ts +21 -0
  110. package/dist/core/quality/dependency-checker.d.ts.map +1 -0
  111. package/dist/core/quality/dependency-checker.js +247 -0
  112. package/dist/core/quality/dependency-checker.js.map +1 -0
  113. package/dist/core/quality/doctor.d.ts +19 -0
  114. package/dist/core/quality/doctor.d.ts.map +1 -0
  115. package/dist/core/quality/doctor.js +163 -0
  116. package/dist/core/quality/doctor.js.map +1 -0
  117. package/dist/core/quality/validator.d.ts +21 -0
  118. package/dist/core/quality/validator.d.ts.map +1 -0
  119. package/dist/core/quality/validator.js +177 -0
  120. package/dist/core/quality/validator.js.map +1 -0
  121. package/dist/core/skills/skills-manager.d.ts +126 -0
  122. package/dist/core/skills/skills-manager.d.ts.map +1 -0
  123. package/dist/core/skills/skills-manager.js +630 -0
  124. package/dist/core/skills/skills-manager.js.map +1 -0
  125. package/dist/core/state/config-manager.d.ts +86 -0
  126. package/dist/core/state/config-manager.d.ts.map +1 -0
  127. package/dist/core/state/config-manager.js +562 -0
  128. package/dist/core/state/config-manager.js.map +1 -0
  129. package/dist/core/state/override-manager.d.ts +23 -0
  130. package/dist/core/state/override-manager.d.ts.map +1 -0
  131. package/dist/core/state/override-manager.js +82 -0
  132. package/dist/core/state/override-manager.js.map +1 -0
  133. package/dist/core/state/state-writer.d.ts +34 -0
  134. package/dist/core/state/state-writer.d.ts.map +1 -0
  135. package/dist/core/state/state-writer.js +78 -0
  136. package/dist/core/state/state-writer.js.map +1 -0
  137. package/dist/core/state/version-bumper.d.ts +19 -0
  138. package/dist/core/state/version-bumper.d.ts.map +1 -0
  139. package/dist/core/state/version-bumper.js +180 -0
  140. package/dist/core/state/version-bumper.js.map +1 -0
  141. package/dist/core/tasks/decision-manager.d.ts +25 -0
  142. package/dist/core/tasks/decision-manager.d.ts.map +1 -0
  143. package/dist/core/tasks/decision-manager.js +183 -0
  144. package/dist/core/tasks/decision-manager.js.map +1 -0
  145. package/dist/core/tasks/knowledge-manager.d.ts +24 -0
  146. package/dist/core/tasks/knowledge-manager.d.ts.map +1 -0
  147. package/dist/core/tasks/knowledge-manager.js +173 -0
  148. package/dist/core/tasks/knowledge-manager.js.map +1 -0
  149. package/dist/core/tasks/learn-manager.d.ts +27 -0
  150. package/dist/core/tasks/learn-manager.d.ts.map +1 -0
  151. package/dist/core/tasks/learn-manager.js +121 -0
  152. package/dist/core/tasks/learn-manager.js.map +1 -0
  153. package/dist/core/tasks/plans-manager.d.ts +46 -0
  154. package/dist/core/tasks/plans-manager.d.ts.map +1 -0
  155. package/dist/core/tasks/plans-manager.js +158 -0
  156. package/dist/core/tasks/plans-manager.js.map +1 -0
  157. package/dist/core/tasks/task-manager.d.ts +127 -0
  158. package/dist/core/tasks/task-manager.d.ts.map +1 -0
  159. package/dist/core/tasks/task-manager.js +607 -0
  160. package/dist/core/tasks/task-manager.js.map +1 -0
  161. package/dist/core/workspace/project-worker.d.ts +6 -6
  162. package/dist/core/workspace/project-worker.d.ts.map +1 -1
  163. package/dist/core/workspace/project-worker.js +6 -6
  164. package/dist/core/workspace/project-worker.js.map +1 -1
  165. package/dist/index.d.ts +1 -1
  166. package/dist/index.d.ts.map +1 -1
  167. package/dist/index.js +19 -176
  168. package/dist/index.js.map +1 -1
  169. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  170. package/dist/mcp/rulebook-server.js +16 -960
  171. package/dist/mcp/rulebook-server.js.map +1 -1
  172. package/dist/memory/file-search.d.ts +43 -0
  173. package/dist/memory/file-search.d.ts.map +1 -0
  174. package/dist/memory/file-search.js +228 -0
  175. package/dist/memory/file-search.js.map +1 -0
  176. package/dist/memory/file-store.d.ts +99 -0
  177. package/dist/memory/file-store.d.ts.map +1 -0
  178. package/dist/memory/file-store.js +615 -0
  179. package/dist/memory/file-store.js.map +1 -0
  180. package/dist/memory/legacy-migrator.d.ts +27 -0
  181. package/dist/memory/legacy-migrator.d.ts.map +1 -0
  182. package/dist/memory/legacy-migrator.js +185 -0
  183. package/dist/memory/legacy-migrator.js.map +1 -0
  184. package/dist/memory/memory-manager.d.ts +25 -24
  185. package/dist/memory/memory-manager.d.ts.map +1 -1
  186. package/dist/memory/memory-manager.js +97 -140
  187. package/dist/memory/memory-manager.js.map +1 -1
  188. package/dist/memory/memory-types.d.ts +1 -1
  189. package/dist/memory/memory-types.d.ts.map +1 -1
  190. package/dist/types.d.ts +8 -119
  191. package/dist/types.d.ts.map +1 -1
  192. package/package.json +1 -6
  193. package/templates/agents/context-intelligence.md +50 -52
  194. package/templates/cli/OPENCODE.md +85 -18
  195. package/templates/commands/rulebook-learn-capture.md +41 -48
  196. package/templates/commands/rulebook-learn-list.md +13 -13
  197. package/templates/core/AGENTS_LEAN.md +0 -14
  198. package/templates/hooks/check-context-and-handoff.sh +8 -10
  199. package/templates/hooks/enforce-pre-tool.sh +70 -0
  200. package/templates/hooks/terse-mode-tracker.sh +146 -143
  201. package/templates/ides/OPENCODE.md +63 -0
  202. package/templates/skills/cli/opencode/SKILL.md +82 -28
  203. package/.claude/commands/ralph-config.md +0 -112
  204. package/.claude/commands/ralph-history.md +0 -110
  205. package/.claude/commands/ralph-init.md +0 -72
  206. package/.claude/commands/ralph-pause-resume.md +0 -105
  207. package/.claude/commands/ralph-run.md +0 -101
  208. package/.claude/commands/ralph-status.md +0 -76
  209. package/templates/core/RALPH.md +0 -471
  210. package/templates/frameworks/ANGULAR.md +0 -36
  211. package/templates/frameworks/DJANGO.md +0 -83
  212. package/templates/frameworks/ELECTRON.md +0 -147
  213. package/templates/frameworks/FLASK.md +0 -38
  214. package/templates/frameworks/FLUTTER.md +0 -55
  215. package/templates/frameworks/JQUERY.md +0 -32
  216. package/templates/frameworks/LARAVEL.md +0 -38
  217. package/templates/frameworks/NESTJS.md +0 -43
  218. package/templates/frameworks/NEXTJS.md +0 -127
  219. package/templates/frameworks/NUXT.md +0 -40
  220. package/templates/frameworks/RAILS.md +0 -66
  221. package/templates/frameworks/REACT.md +0 -38
  222. package/templates/frameworks/REACT_NATIVE.md +0 -47
  223. package/templates/frameworks/SPRING.md +0 -39
  224. package/templates/frameworks/SYMFONY.md +0 -36
  225. package/templates/frameworks/VUE.md +0 -36
  226. package/templates/frameworks/ZEND.md +0 -35
  227. package/templates/hooks/enforce-mcp-for-tasks.sh +0 -31
  228. package/templates/hooks/enforce-no-deferred.sh +0 -21
  229. package/templates/hooks/enforce-no-shortcuts.sh +0 -31
  230. package/templates/ides/COPILOT.md +0 -37
  231. package/templates/ides/CURSOR.md +0 -43
  232. package/templates/ides/JETBRAINS_AI.md +0 -35
  233. package/templates/ides/REPLIT.md +0 -36
  234. package/templates/ides/TABNINE.md +0 -29
  235. package/templates/ides/VSCODE.md +0 -40
  236. package/templates/ides/WINDSURF.md +0 -36
  237. package/templates/ides/ZED.md +0 -32
  238. package/templates/ides/cursor-mdc/go.mdc +0 -24
  239. package/templates/ides/cursor-mdc/python.mdc +0 -24
  240. package/templates/ides/cursor-mdc/quality.mdc +0 -25
  241. package/templates/ides/cursor-mdc/ralph.mdc +0 -39
  242. package/templates/ides/cursor-mdc/rulebook.mdc +0 -38
  243. package/templates/ides/cursor-mdc/rust.mdc +0 -24
  244. package/templates/ides/cursor-mdc/typescript.mdc +0 -25
  245. package/templates/ralph/ralph-history.bat +0 -4
  246. package/templates/ralph/ralph-history.sh +0 -5
  247. package/templates/ralph/ralph-init.bat +0 -5
  248. package/templates/ralph/ralph-init.sh +0 -5
  249. package/templates/ralph/ralph-pause.bat +0 -5
  250. package/templates/ralph/ralph-pause.sh +0 -5
  251. package/templates/ralph/ralph-run.bat +0 -5
  252. package/templates/ralph/ralph-run.sh +0 -5
  253. package/templates/ralph/ralph-status.bat +0 -4
  254. package/templates/ralph/ralph-status.sh +0 -5
  255. package/templates/services/AZURE_BLOB.md +0 -184
  256. package/templates/services/CASSANDRA.md +0 -239
  257. package/templates/services/DATADOG.md +0 -26
  258. package/templates/services/DOCKER.md +0 -124
  259. package/templates/services/DOCKER_COMPOSE.md +0 -168
  260. package/templates/services/DYNAMODB.md +0 -308
  261. package/templates/services/ELASTICSEARCH.md +0 -347
  262. package/templates/services/GCS.md +0 -178
  263. package/templates/services/HELM.md +0 -194
  264. package/templates/services/INFLUXDB.md +0 -265
  265. package/templates/services/KAFKA.md +0 -341
  266. package/templates/services/KUBERNETES.md +0 -208
  267. package/templates/services/MARIADB.md +0 -183
  268. package/templates/services/MEMCACHED.md +0 -242
  269. package/templates/services/MINIO.md +0 -201
  270. package/templates/services/MONGODB.md +0 -268
  271. package/templates/services/MYSQL.md +0 -358
  272. package/templates/services/NEO4J.md +0 -247
  273. package/templates/services/OPENTELEMETRY.md +0 -25
  274. package/templates/services/ORACLE.md +0 -290
  275. package/templates/services/PINO.md +0 -24
  276. package/templates/services/POSTGRESQL.md +0 -326
  277. package/templates/services/PROMETHEUS.md +0 -33
  278. package/templates/services/RABBITMQ.md +0 -286
  279. package/templates/services/REDIS.md +0 -292
  280. package/templates/services/S3.md +0 -298
  281. package/templates/services/SENTRY.md +0 -23
  282. package/templates/services/SQLITE.md +0 -294
  283. package/templates/services/SQLSERVER.md +0 -294
  284. package/templates/services/WINSTON.md +0 -30
  285. package/templates/skills/frameworks/angular/SKILL.md +0 -46
  286. package/templates/skills/frameworks/django/SKILL.md +0 -93
  287. package/templates/skills/frameworks/electron/SKILL.md +0 -157
  288. package/templates/skills/frameworks/flask/SKILL.md +0 -48
  289. package/templates/skills/frameworks/flutter/SKILL.md +0 -65
  290. package/templates/skills/frameworks/jquery/SKILL.md +0 -42
  291. package/templates/skills/frameworks/laravel/SKILL.md +0 -48
  292. package/templates/skills/frameworks/nestjs/SKILL.md +0 -53
  293. package/templates/skills/frameworks/nextjs/SKILL.md +0 -137
  294. package/templates/skills/frameworks/nuxt/SKILL.md +0 -50
  295. package/templates/skills/frameworks/rails/SKILL.md +0 -76
  296. package/templates/skills/frameworks/react/SKILL.md +0 -48
  297. package/templates/skills/frameworks/react-native/SKILL.md +0 -57
  298. package/templates/skills/frameworks/spring/SKILL.md +0 -49
  299. package/templates/skills/frameworks/symfony/SKILL.md +0 -46
  300. package/templates/skills/frameworks/vue/SKILL.md +0 -46
  301. package/templates/skills/frameworks/zend/SKILL.md +0 -45
  302. package/templates/skills/services/azure-blob/SKILL.md +0 -194
  303. package/templates/skills/services/cassandra/SKILL.md +0 -249
  304. package/templates/skills/services/dynamodb/SKILL.md +0 -318
  305. package/templates/skills/services/elasticsearch/SKILL.md +0 -357
  306. package/templates/skills/services/gcs/SKILL.md +0 -188
  307. package/templates/skills/services/influxdb/SKILL.md +0 -275
  308. package/templates/skills/services/kafka/SKILL.md +0 -351
  309. package/templates/skills/services/mariadb/SKILL.md +0 -193
  310. package/templates/skills/services/memcached/SKILL.md +0 -252
  311. package/templates/skills/services/minio/SKILL.md +0 -211
  312. package/templates/skills/services/mongodb/SKILL.md +0 -278
  313. package/templates/skills/services/mysql/SKILL.md +0 -368
  314. package/templates/skills/services/neo4j/SKILL.md +0 -257
  315. package/templates/skills/services/oracle/SKILL.md +0 -300
  316. package/templates/skills/services/postgresql/SKILL.md +0 -336
  317. package/templates/skills/services/rabbitmq/SKILL.md +0 -296
  318. package/templates/skills/services/redis/SKILL.md +0 -302
  319. package/templates/skills/services/s3/SKILL.md +0 -308
  320. package/templates/skills/services/sqlite/SKILL.md +0 -304
  321. package/templates/skills/services/sqlserver/SKILL.md +0 -304
  322. package/templates/skills/workflows/ralph/SETUP.md +0 -228
  323. package/templates/skills/workflows/ralph/SKILL.md +0 -309
  324. package/templates/skills/workflows/ralph/install.sh +0 -87
  325. package/templates/skills/workflows/ralph/manifest.json +0 -158
@@ -1,252 +0,0 @@
1
- ---
2
- name: "Memcached"
3
- description: "Use Memcached for simple, high-performance distributed caching with minimal overhead."
4
- version: "1.0.0"
5
- category: "services"
6
- author: "Rulebook"
7
- tags: ["services", "caching"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- MEMCACHED:START -->
12
- # Memcached Cache Instructions
13
-
14
- **CRITICAL**: Use Memcached for simple, high-performance distributed caching with minimal overhead.
15
-
16
- ## Core Features
17
-
18
- ### Connection
19
- ```typescript
20
- // Using memcached (Node.js)
21
- import Memcached from 'memcached'
22
-
23
- const memcached = new Memcached(process.env.MEMCACHED_SERVERS || 'localhost:11211', {
24
- maxKeySize: 250,
25
- maxExpiration: 2592000, // 30 days
26
- maxValue: 1048576, // 1MB
27
- poolSize: 10,
28
- reconnect: true,
29
- timeout: 5000,
30
- retries: 3,
31
- retry: 1000,
32
- remove: true,
33
- idle: 5000,
34
- })
35
- ```
36
-
37
- ### Basic Operations
38
- ```typescript
39
- // Set
40
- memcached.set('user:1', { name: 'John', email: 'john@example.com' }, 3600, (err) => {
41
- // Expires in 1 hour
42
- })
43
-
44
- // Get
45
- memcached.get('user:1', (err, data) => {
46
- console.log(data)
47
- })
48
-
49
- // Delete
50
- memcached.del('user:1', (err) => {
51
- // Deleted
52
- })
53
-
54
- // Replace (only if key exists)
55
- memcached.replace('user:1', newData, 3600, (err) => {
56
- // Replaced
57
- })
58
-
59
- // Add (only if key doesn't exist)
60
- memcached.add('user:1', data, 3600, (err) => {
61
- // Added
62
- })
63
- ```
64
-
65
- ### Advanced Operations
66
- ```typescript
67
- // Multiple gets
68
- memcached.getMulti(['user:1', 'user:2', 'user:3'], (err, data) => {
69
- // Returns object with keys as properties
70
- })
71
-
72
- // Increment/Decrement
73
- memcached.incr('counter', 1, (err, value) => {
74
- // Incremented
75
- })
76
-
77
- memcached.decr('counter', 1, (err, value) => {
78
- // Decremented
79
- })
80
-
81
- // Touch (update expiration)
82
- memcached.touch('user:1', 7200, (err) => {
83
- // Expiration updated to 2 hours
84
- })
85
-
86
- // Stats
87
- memcached.stats((err, stats) => {
88
- console.log(stats)
89
- })
90
- ```
91
-
92
- ## Common Patterns
93
-
94
- ### Caching with Promises
95
- ```typescript
96
- function getCached(key: string): Promise<any> {
97
- return new Promise((resolve, reject) => {
98
- memcached.get(key, (err, data) => {
99
- if (err) reject(err)
100
- else resolve(data)
101
- })
102
- })
103
- }
104
-
105
- function setCached(key: string, value: any, ttl: number): Promise<void> {
106
- return new Promise((resolve, reject) => {
107
- memcached.set(key, value, ttl, (err) => {
108
- if (err) reject(err)
109
- else resolve()
110
- })
111
- })
112
- }
113
-
114
- // Usage
115
- async function getCachedUser(userId: string) {
116
- const cached = await getCached(`user:${userId}`)
117
- if (cached) {
118
- return cached
119
- }
120
-
121
- const user = await fetchUserFromDatabase(userId)
122
- await setCached(`user:${userId}`, user, 3600)
123
- return user
124
- }
125
- ```
126
-
127
- ### Cache-Aside Pattern
128
- ```typescript
129
- async function getWithCache(key: string, fetchFn: () => Promise<any>, ttl: number) {
130
- try {
131
- const cached = await getCached(key)
132
- if (cached) {
133
- return cached
134
- }
135
- } catch (err) {
136
- // Cache miss or error, continue to fetch
137
- }
138
-
139
- const data = await fetchFn()
140
- try {
141
- await setCached(key, data, ttl)
142
- } catch (err) {
143
- // Cache set failed, but we have the data
144
- }
145
-
146
- return data
147
- }
148
- ```
149
-
150
- ### Rate Limiting
151
- ```typescript
152
- async function checkRateLimit(identifier: string, limit: number, window: number): Promise<boolean> {
153
- const key = `ratelimit:${identifier}`
154
-
155
- return new Promise((resolve) => {
156
- memcached.incr(key, 1, (err, value) => {
157
- if (err || value === false) {
158
- // Key doesn't exist, create it
159
- memcached.set(key, 1, window, () => {
160
- resolve(true)
161
- })
162
- } else if (value > limit) {
163
- resolve(false)
164
- } else {
165
- if (value === 1) {
166
- // First increment, set expiration
167
- memcached.touch(key, window, () => {})
168
- }
169
- resolve(true)
170
- }
171
- })
172
- })
173
- }
174
- ```
175
-
176
- ## Best Practices
177
-
178
- ✅ **DO:**
179
- - Use connection pooling
180
- - Set appropriate TTL for cached data
181
- - Handle cache misses gracefully
182
- - Use consistent key naming conventions
183
- - Monitor cache hit rates
184
- - Use multiple servers for redundancy
185
- - Compress large values before storing
186
- - Implement cache warming strategies
187
- - Use appropriate data serialization
188
- - Monitor memory usage
189
-
190
- ❌ **DON'T:**
191
- - Store large values (> 1MB, use external storage)
192
- - Use Memcached as primary database
193
- - Store sensitive data without encryption
194
- - Skip error handling
195
- - Ignore connection failures
196
- - Hardcode server addresses
197
- - Use blocking operations
198
- - Store complex nested objects (flatten when possible)
199
- - Ignore eviction policies
200
- - Skip monitoring
201
-
202
- ## Configuration
203
-
204
- ### Environment Variables
205
- ```bash
206
- MEMCACHED_SERVERS=localhost:11211
207
- MEMCACHED_SERVERS=server1:11211,server2:11211,server3:11211
208
- ```
209
-
210
- ### Docker Compose
211
- ```yaml
212
- services:
213
- memcached:
214
- image: memcached:1.6-alpine
215
- ports:
216
- - "11211:11211"
217
- command: ["-m", "64", "-I", "1m"] # 64MB memory, 1MB max item size
218
- healthcheck:
219
- test: ["CMD", "nc", "-z", "localhost", "11211"]
220
- interval: 10s
221
- timeout: 5s
222
- retries: 5
223
- ```
224
-
225
- ## Integration with Development
226
-
227
- ### Testing
228
- ```typescript
229
- // Use test Memcached instance
230
- const testMemcached = new Memcached('localhost:11212') // Different port
231
-
232
- // Clean up after tests
233
- afterEach((done) => {
234
- testMemcached.flush((err) => {
235
- done()
236
- })
237
- })
238
- ```
239
-
240
- ### Health Checks
241
- ```typescript
242
- function checkMemcachedHealth(): Promise<boolean> {
243
- return new Promise((resolve) => {
244
- memcached.stats((err) => {
245
- resolve(!err)
246
- })
247
- })
248
- }
249
- ```
250
-
251
- <!-- MEMCACHED:END -->
252
-
@@ -1,211 +0,0 @@
1
- ---
2
- name: "MinIO"
3
- description: "Use MinIO for S3-compatible object storage, self-hosted file storage, and development/testing with S3 APIs."
4
- version: "1.0.0"
5
- category: "services"
6
- author: "Rulebook"
7
- tags: ["services", "storage"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- MINIO:START -->
12
- # MinIO S3-Compatible Storage Instructions
13
-
14
- **CRITICAL**: Use MinIO for S3-compatible object storage, self-hosted file storage, and development/testing with S3 APIs.
15
-
16
- ## Core Features
17
-
18
- ### Connection
19
- ```typescript
20
- // Using @aws-sdk/client-s3 (S3-compatible)
21
- import { S3Client, PutObjectCommand, GetObjectCommand } from '@aws-sdk/client-s3'
22
-
23
- const s3Client = new S3Client({
24
- endpoint: process.env.MINIO_ENDPOINT || 'http://localhost:9000',
25
- region: process.env.MINIO_REGION || 'us-east-1',
26
- credentials: {
27
- accessKeyId: process.env.MINIO_ACCESS_KEY || 'minioadmin',
28
- secretAccessKey: process.env.MINIO_SECRET_KEY || 'minioadmin',
29
- },
30
- forcePathStyle: true, // Required for MinIO
31
- })
32
-
33
- // Using minio-js
34
- import * as MinIO from 'minio'
35
-
36
- const minioClient = new MinIO.Client({
37
- endPoint: process.env.MINIO_ENDPOINT?.replace('http://', '').replace('https://', '') || 'localhost',
38
- port: parseInt(process.env.MINIO_PORT || '9000'),
39
- useSSL: process.env.MINIO_USE_SSL === 'true',
40
- accessKey: process.env.MINIO_ACCESS_KEY || 'minioadmin',
41
- secretKey: process.env.MINIO_SECRET_KEY || 'minioadmin',
42
- })
43
- ```
44
-
45
- ### Basic Operations
46
- ```typescript
47
- // Using S3 SDK
48
- // Create bucket
49
- await s3Client.send(new CreateBucketCommand({
50
- Bucket: 'my-bucket',
51
- }))
52
-
53
- // Upload file
54
- await s3Client.send(new PutObjectCommand({
55
- Bucket: 'my-bucket',
56
- Key: 'path/to/file.jpg',
57
- Body: fileBuffer,
58
- ContentType: 'image/jpeg',
59
- }))
60
-
61
- // Download file
62
- const response = await s3Client.send(new GetObjectCommand({
63
- Bucket: 'my-bucket',
64
- Key: 'path/to/file.jpg',
65
- }))
66
- const fileContent = await response.Body?.transformToByteArray()
67
-
68
- // Using MinIO SDK
69
- // Upload file
70
- await minioClient.putObject('my-bucket', 'path/to/file.jpg', fileBuffer, fileBuffer.length, {
71
- 'Content-Type': 'image/jpeg',
72
- })
73
-
74
- // Download file
75
- const dataStream = await minioClient.getObject('my-bucket', 'path/to/file.jpg')
76
- const chunks: Buffer[] = []
77
- for await (const chunk of dataStream) {
78
- chunks.push(chunk)
79
- }
80
- const fileContent = Buffer.concat(chunks)
81
-
82
- // List objects
83
- const objectsStream = minioClient.listObjects('my-bucket', 'prefix/', true)
84
- for await (const obj of objectsStream) {
85
- console.log(obj.name, obj.size)
86
- }
87
- ```
88
-
89
- ### Advanced Features
90
- ```typescript
91
- // Presigned URL (S3 SDK)
92
- import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
93
-
94
- const command = new PutObjectCommand({
95
- Bucket: 'my-bucket',
96
- Key: 'uploads/file.jpg',
97
- ContentType: 'image/jpeg',
98
- })
99
-
100
- const presignedUrl = await getSignedUrl(s3Client, command, { expiresIn: 3600 })
101
-
102
- // Presigned URL (MinIO SDK)
103
- const url = await minioClient.presignedPutObject('my-bucket', 'uploads/file.jpg', 3600)
104
-
105
- // Bucket policies
106
- const policy = {
107
- Version: '2012-10-17',
108
- Statement: [
109
- {
110
- Effect: 'Allow',
111
- Principal: { AWS: ['*'] },
112
- Action: ['s3:GetObject'],
113
- Resource: ['arn:aws:s3:::my-bucket/*'],
114
- },
115
- ],
116
- }
117
-
118
- await minioClient.setBucketPolicy('my-bucket', JSON.stringify(policy))
119
- ```
120
-
121
- ## Common Patterns
122
-
123
- ### File Upload Handler
124
- ```typescript
125
- async function uploadFile(file: Buffer, filename: string, userId: string) {
126
- const key = `users/${userId}/${Date.now()}-${filename}`
127
-
128
- await s3Client.send(new PutObjectCommand({
129
- Bucket: process.env.MINIO_BUCKET,
130
- Key: key,
131
- Body: file,
132
- ContentType: getContentType(filename),
133
- Metadata: {
134
- userId,
135
- originalName: filename,
136
- },
137
- }))
138
-
139
- return {
140
- key,
141
- url: `${process.env.MINIO_ENDPOINT}/${process.env.MINIO_BUCKET}/${key}`,
142
- }
143
- }
144
- ```
145
-
146
- ## Best Practices
147
-
148
- ✅ **DO:**
149
- - Use S3-compatible APIs for portability
150
- - Set appropriate content types
151
- - Use presigned URLs for client uploads
152
- - Implement proper error handling
153
- - Use bucket policies for access control
154
- - Enable versioning for important data
155
- - Monitor storage usage
156
- - Use lifecycle policies
157
- - Implement retry logic
158
- - Use TLS in production
159
-
160
- ❌ **DON'T:**
161
- - Store sensitive data without encryption
162
- - Use default credentials in production
163
- - Hardcode endpoint URLs
164
- - Ignore error handling
165
- - Skip content-type validation
166
- - Ignore access policies
167
- - Skip monitoring
168
- - Use HTTP in production
169
- - Ignore storage limits
170
- - Store large files without chunking
171
-
172
- ## Configuration
173
-
174
- ### Environment Variables
175
- ```bash
176
- MINIO_ENDPOINT=http://localhost:9000
177
- MINIO_ENDPOINT=https://minio.example.com
178
- MINIO_PORT=9000
179
- MINIO_USE_SSL=false
180
- MINIO_ACCESS_KEY=minioadmin
181
- MINIO_SECRET_KEY=minioadmin
182
- MINIO_BUCKET=my-bucket
183
- MINIO_REGION=us-east-1
184
- ```
185
-
186
- ### Docker Compose
187
- ```yaml
188
- services:
189
- minio:
190
- image: minio/minio:latest
191
- ports:
192
- - "9000:9000" # API
193
- - "9001:9001" # Console
194
- environment:
195
- MINIO_ROOT_USER: minioadmin
196
- MINIO_ROOT_PASSWORD: securepassword
197
- command: server /data --console-address ":9001"
198
- volumes:
199
- - minio_data:/data
200
- healthcheck:
201
- test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
202
- interval: 30s
203
- timeout: 20s
204
- retries: 3
205
-
206
- volumes:
207
- minio_data:
208
- ```
209
-
210
- <!-- MINIO:END -->
211
-