@shinobiapps/shinobi 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (378) hide show
  1. package/CHANGELOG.md +70 -0
  2. package/CODE_OF_CONDUCT.md +70 -0
  3. package/LICENSE +21 -0
  4. package/README.md +269 -0
  5. package/SECURITY.md +75 -0
  6. package/dist/cli.d.ts +3 -0
  7. package/dist/cli.d.ts.map +1 -0
  8. package/dist/cli.js +200 -0
  9. package/dist/cli.js.map +1 -0
  10. package/dist/commands/cost.d.ts +9 -0
  11. package/dist/commands/cost.d.ts.map +1 -0
  12. package/dist/commands/cost.js +49 -0
  13. package/dist/commands/cost.js.map +1 -0
  14. package/dist/commands/digest.d.ts +29 -0
  15. package/dist/commands/digest.d.ts.map +1 -0
  16. package/dist/commands/digest.js +63 -0
  17. package/dist/commands/digest.js.map +1 -0
  18. package/dist/commands/init.d.ts +15 -0
  19. package/dist/commands/init.d.ts.map +1 -0
  20. package/dist/commands/init.js +81 -0
  21. package/dist/commands/init.js.map +1 -0
  22. package/dist/commands/sync.d.ts +5 -0
  23. package/dist/commands/sync.d.ts.map +1 -0
  24. package/dist/commands/sync.js +160 -0
  25. package/dist/commands/sync.js.map +1 -0
  26. package/dist/dashboard/auth.d.ts +17 -0
  27. package/dist/dashboard/auth.d.ts.map +1 -0
  28. package/dist/dashboard/auth.js +108 -0
  29. package/dist/dashboard/auth.js.map +1 -0
  30. package/dist/dashboard/server.d.ts +16 -0
  31. package/dist/dashboard/server.d.ts.map +1 -0
  32. package/dist/dashboard/server.js +1020 -0
  33. package/dist/dashboard/server.js.map +1 -0
  34. package/dist/dashboard/settings-store.d.ts +46 -0
  35. package/dist/dashboard/settings-store.d.ts.map +1 -0
  36. package/dist/dashboard/settings-store.js +183 -0
  37. package/dist/dashboard/settings-store.js.map +1 -0
  38. package/dist/dashboard-spa/apple-touch-icon.png +0 -0
  39. package/dist/dashboard-spa/assets/index-0vWLEg34.css +1 -0
  40. package/dist/dashboard-spa/assets/index-Rnhs9802.js +263 -0
  41. package/dist/dashboard-spa/assets/index-Rnhs9802.js.map +1 -0
  42. package/dist/dashboard-spa/icon-192.png +0 -0
  43. package/dist/dashboard-spa/icon-192.svg +4 -0
  44. package/dist/dashboard-spa/icon-512.png +0 -0
  45. package/dist/dashboard-spa/index.html +29 -0
  46. package/dist/dashboard-spa/manifest.webmanifest +37 -0
  47. package/dist/dashboard-spa/sw.js +111 -0
  48. package/dist/lib/config.d.ts +14 -0
  49. package/dist/lib/config.d.ts.map +1 -0
  50. package/dist/lib/config.js +36 -0
  51. package/dist/lib/config.js.map +1 -0
  52. package/dist/lib/db.d.ts +5 -0
  53. package/dist/lib/db.d.ts.map +1 -0
  54. package/dist/lib/db.js +33 -0
  55. package/dist/lib/db.js.map +1 -0
  56. package/dist/lib/fts.d.ts +2 -0
  57. package/dist/lib/fts.d.ts.map +1 -0
  58. package/dist/lib/fts.js +14 -0
  59. package/dist/lib/fts.js.map +1 -0
  60. package/dist/lib/json.d.ts +3 -0
  61. package/dist/lib/json.d.ts.map +1 -0
  62. package/dist/lib/json.js +16 -0
  63. package/dist/lib/json.js.map +1 -0
  64. package/dist/lib/migrations.d.ts +9 -0
  65. package/dist/lib/migrations.d.ts.map +1 -0
  66. package/dist/lib/migrations.js +94 -0
  67. package/dist/lib/migrations.js.map +1 -0
  68. package/dist/lib/priority.d.ts +2 -0
  69. package/dist/lib/priority.d.ts.map +1 -0
  70. package/dist/lib/priority.js +8 -0
  71. package/dist/lib/priority.js.map +1 -0
  72. package/dist/models/activity.d.ts +41 -0
  73. package/dist/models/activity.d.ts.map +1 -0
  74. package/dist/models/activity.js +55 -0
  75. package/dist/models/activity.js.map +1 -0
  76. package/dist/models/approvals.d.ts +43 -0
  77. package/dist/models/approvals.d.ts.map +1 -0
  78. package/dist/models/approvals.js +102 -0
  79. package/dist/models/approvals.js.map +1 -0
  80. package/dist/models/context.d.ts +25 -0
  81. package/dist/models/context.d.ts.map +1 -0
  82. package/dist/models/context.js +63 -0
  83. package/dist/models/context.js.map +1 -0
  84. package/dist/models/dead_ends-helpers.d.ts +3 -0
  85. package/dist/models/dead_ends-helpers.d.ts.map +1 -0
  86. package/dist/models/dead_ends-helpers.js +9 -0
  87. package/dist/models/dead_ends-helpers.js.map +1 -0
  88. package/dist/models/dead_ends.d.ts +41 -0
  89. package/dist/models/dead_ends.d.ts.map +1 -0
  90. package/dist/models/dead_ends.js +96 -0
  91. package/dist/models/dead_ends.js.map +1 -0
  92. package/dist/models/decision_drafts.d.ts +59 -0
  93. package/dist/models/decision_drafts.d.ts.map +1 -0
  94. package/dist/models/decision_drafts.js +105 -0
  95. package/dist/models/decision_drafts.js.map +1 -0
  96. package/dist/models/decisions-helpers.d.ts +3 -0
  97. package/dist/models/decisions-helpers.d.ts.map +1 -0
  98. package/dist/models/decisions-helpers.js +9 -0
  99. package/dist/models/decisions-helpers.js.map +1 -0
  100. package/dist/models/decisions.d.ts +51 -0
  101. package/dist/models/decisions.d.ts.map +1 -0
  102. package/dist/models/decisions.js +97 -0
  103. package/dist/models/decisions.js.map +1 -0
  104. package/dist/models/notes-helpers.d.ts +3 -0
  105. package/dist/models/notes-helpers.d.ts.map +1 -0
  106. package/dist/models/notes-helpers.js +9 -0
  107. package/dist/models/notes-helpers.js.map +1 -0
  108. package/dist/models/notes.d.ts +35 -0
  109. package/dist/models/notes.d.ts.map +1 -0
  110. package/dist/models/notes.js +66 -0
  111. package/dist/models/notes.js.map +1 -0
  112. package/dist/models/plans.d.ts +25 -0
  113. package/dist/models/plans.d.ts.map +1 -0
  114. package/dist/models/plans.js +39 -0
  115. package/dist/models/plans.js.map +1 -0
  116. package/dist/models/pr_links.d.ts +36 -0
  117. package/dist/models/pr_links.d.ts.map +1 -0
  118. package/dist/models/pr_links.js +45 -0
  119. package/dist/models/pr_links.js.map +1 -0
  120. package/dist/models/project_members.d.ts +22 -0
  121. package/dist/models/project_members.d.ts.map +1 -0
  122. package/dist/models/project_members.js +33 -0
  123. package/dist/models/project_members.js.map +1 -0
  124. package/dist/models/projects.d.ts +55 -0
  125. package/dist/models/projects.d.ts.map +1 -0
  126. package/dist/models/projects.js +126 -0
  127. package/dist/models/projects.js.map +1 -0
  128. package/dist/models/push_subscriptions.d.ts +24 -0
  129. package/dist/models/push_subscriptions.d.ts.map +1 -0
  130. package/dist/models/push_subscriptions.js +39 -0
  131. package/dist/models/push_subscriptions.js.map +1 -0
  132. package/dist/models/session_costs.d.ts +48 -0
  133. package/dist/models/session_costs.d.ts.map +1 -0
  134. package/dist/models/session_costs.js +77 -0
  135. package/dist/models/session_costs.js.map +1 -0
  136. package/dist/models/sessions.d.ts +41 -0
  137. package/dist/models/sessions.d.ts.map +1 -0
  138. package/dist/models/sessions.js +96 -0
  139. package/dist/models/sessions.js.map +1 -0
  140. package/dist/models/subtasks-helpers.d.ts +3 -0
  141. package/dist/models/subtasks-helpers.d.ts.map +1 -0
  142. package/dist/models/subtasks-helpers.js +9 -0
  143. package/dist/models/subtasks-helpers.js.map +1 -0
  144. package/dist/models/subtasks.d.ts +69 -0
  145. package/dist/models/subtasks.d.ts.map +1 -0
  146. package/dist/models/subtasks.js +215 -0
  147. package/dist/models/subtasks.js.map +1 -0
  148. package/dist/models/users.d.ts +25 -0
  149. package/dist/models/users.d.ts.map +1 -0
  150. package/dist/models/users.js +44 -0
  151. package/dist/models/users.js.map +1 -0
  152. package/dist/server/mcp.d.ts +6 -0
  153. package/dist/server/mcp.d.ts.map +1 -0
  154. package/dist/server/mcp.js +72 -0
  155. package/dist/server/mcp.js.map +1 -0
  156. package/dist/server/tools/approval.d.ts +3 -0
  157. package/dist/server/tools/approval.d.ts.map +1 -0
  158. package/dist/server/tools/approval.js +98 -0
  159. package/dist/server/tools/approval.js.map +1 -0
  160. package/dist/server/tools/args.d.ts +11 -0
  161. package/dist/server/tools/args.d.ts.map +1 -0
  162. package/dist/server/tools/args.js +79 -0
  163. package/dist/server/tools/args.js.map +1 -0
  164. package/dist/server/tools/context.d.ts +3 -0
  165. package/dist/server/tools/context.d.ts.map +1 -0
  166. package/dist/server/tools/context.js +72 -0
  167. package/dist/server/tools/context.js.map +1 -0
  168. package/dist/server/tools/dead_ends.d.ts +3 -0
  169. package/dist/server/tools/dead_ends.d.ts.map +1 -0
  170. package/dist/server/tools/dead_ends.js +111 -0
  171. package/dist/server/tools/dead_ends.js.map +1 -0
  172. package/dist/server/tools/decisions.d.ts +3 -0
  173. package/dist/server/tools/decisions.d.ts.map +1 -0
  174. package/dist/server/tools/decisions.js +101 -0
  175. package/dist/server/tools/decisions.js.map +1 -0
  176. package/dist/server/tools/extraction.d.ts +3 -0
  177. package/dist/server/tools/extraction.d.ts.map +1 -0
  178. package/dist/server/tools/extraction.js +145 -0
  179. package/dist/server/tools/extraction.js.map +1 -0
  180. package/dist/server/tools/git.d.ts +3 -0
  181. package/dist/server/tools/git.d.ts.map +1 -0
  182. package/dist/server/tools/git.js +86 -0
  183. package/dist/server/tools/git.js.map +1 -0
  184. package/dist/server/tools/history.d.ts +3 -0
  185. package/dist/server/tools/history.d.ts.map +1 -0
  186. package/dist/server/tools/history.js +51 -0
  187. package/dist/server/tools/history.js.map +1 -0
  188. package/dist/server/tools/index.d.ts +6 -0
  189. package/dist/server/tools/index.d.ts.map +1 -0
  190. package/dist/server/tools/index.js +41 -0
  191. package/dist/server/tools/index.js.map +1 -0
  192. package/dist/server/tools/notes.d.ts +3 -0
  193. package/dist/server/tools/notes.d.ts.map +1 -0
  194. package/dist/server/tools/notes.js +60 -0
  195. package/dist/server/tools/notes.js.map +1 -0
  196. package/dist/server/tools/plans.d.ts +3 -0
  197. package/dist/server/tools/plans.d.ts.map +1 -0
  198. package/dist/server/tools/plans.js +65 -0
  199. package/dist/server/tools/plans.js.map +1 -0
  200. package/dist/server/tools/plugin.d.ts +3 -0
  201. package/dist/server/tools/plugin.d.ts.map +1 -0
  202. package/dist/server/tools/plugin.js +26 -0
  203. package/dist/server/tools/plugin.js.map +1 -0
  204. package/dist/server/tools/projects.d.ts +3 -0
  205. package/dist/server/tools/projects.d.ts.map +1 -0
  206. package/dist/server/tools/projects.js +197 -0
  207. package/dist/server/tools/projects.js.map +1 -0
  208. package/dist/server/tools/recall.d.ts +3 -0
  209. package/dist/server/tools/recall.d.ts.map +1 -0
  210. package/dist/server/tools/recall.js +74 -0
  211. package/dist/server/tools/recall.js.map +1 -0
  212. package/dist/server/tools/registry.d.ts +8 -0
  213. package/dist/server/tools/registry.d.ts.map +1 -0
  214. package/dist/server/tools/registry.js +23 -0
  215. package/dist/server/tools/registry.js.map +1 -0
  216. package/dist/server/tools/subtasks.d.ts +3 -0
  217. package/dist/server/tools/subtasks.d.ts.map +1 -0
  218. package/dist/server/tools/subtasks.js +306 -0
  219. package/dist/server/tools/subtasks.js.map +1 -0
  220. package/dist/server/tools/types.d.ts +7 -0
  221. package/dist/server/tools/types.d.ts.map +1 -0
  222. package/dist/server/tools/types.js +2 -0
  223. package/dist/server/tools/types.js.map +1 -0
  224. package/dist/server/tools/workflow.d.ts +3 -0
  225. package/dist/server/tools/workflow.d.ts.map +1 -0
  226. package/dist/server/tools/workflow.js +434 -0
  227. package/dist/server/tools/workflow.js.map +1 -0
  228. package/dist/services/auth/magic-link.d.ts +27 -0
  229. package/dist/services/auth/magic-link.d.ts.map +1 -0
  230. package/dist/services/auth/magic-link.js +48 -0
  231. package/dist/services/auth/magic-link.js.map +1 -0
  232. package/dist/services/auth/session.d.ts +15 -0
  233. package/dist/services/auth/session.d.ts.map +1 -0
  234. package/dist/services/auth/session.js +65 -0
  235. package/dist/services/auth/session.js.map +1 -0
  236. package/dist/services/cost/claude-code-parser.d.ts +30 -0
  237. package/dist/services/cost/claude-code-parser.d.ts.map +1 -0
  238. package/dist/services/cost/claude-code-parser.js +110 -0
  239. package/dist/services/cost/claude-code-parser.js.map +1 -0
  240. package/dist/services/cost/pricing.d.ts +15 -0
  241. package/dist/services/cost/pricing.d.ts.map +1 -0
  242. package/dist/services/cost/pricing.js +33 -0
  243. package/dist/services/cost/pricing.js.map +1 -0
  244. package/dist/services/digest/generator.d.ts +51 -0
  245. package/dist/services/digest/generator.d.ts.map +1 -0
  246. package/dist/services/digest/generator.js +136 -0
  247. package/dist/services/digest/generator.js.map +1 -0
  248. package/dist/services/digest/scheduler.d.ts +3 -0
  249. package/dist/services/digest/scheduler.d.ts.map +1 -0
  250. package/dist/services/digest/scheduler.js +61 -0
  251. package/dist/services/digest/scheduler.js.map +1 -0
  252. package/dist/services/digest/telegram.d.ts +13 -0
  253. package/dist/services/digest/telegram.d.ts.map +1 -0
  254. package/dist/services/digest/telegram.js +68 -0
  255. package/dist/services/digest/telegram.js.map +1 -0
  256. package/dist/services/embedding/detect.d.ts +19 -0
  257. package/dist/services/embedding/detect.d.ts.map +1 -0
  258. package/dist/services/embedding/detect.js +64 -0
  259. package/dist/services/embedding/detect.js.map +1 -0
  260. package/dist/services/embedding/factory.d.ts +10 -0
  261. package/dist/services/embedding/factory.d.ts.map +1 -0
  262. package/dist/services/embedding/factory.js +79 -0
  263. package/dist/services/embedding/factory.js.map +1 -0
  264. package/dist/services/embedding/ollama.d.ts +14 -0
  265. package/dist/services/embedding/ollama.d.ts.map +1 -0
  266. package/dist/services/embedding/ollama.js +28 -0
  267. package/dist/services/embedding/ollama.js.map +1 -0
  268. package/dist/services/embedding/openai.d.ts +16 -0
  269. package/dist/services/embedding/openai.d.ts.map +1 -0
  270. package/dist/services/embedding/openai.js +33 -0
  271. package/dist/services/embedding/openai.js.map +1 -0
  272. package/dist/services/embedding/store.d.ts +25 -0
  273. package/dist/services/embedding/store.d.ts.map +1 -0
  274. package/dist/services/embedding/store.js +79 -0
  275. package/dist/services/embedding/store.js.map +1 -0
  276. package/dist/services/embedding/types.d.ts +9 -0
  277. package/dist/services/embedding/types.d.ts.map +1 -0
  278. package/dist/services/embedding/types.js +2 -0
  279. package/dist/services/embedding/types.js.map +1 -0
  280. package/dist/services/embedding/vector-math.d.ts +4 -0
  281. package/dist/services/embedding/vector-math.d.ts.map +1 -0
  282. package/dist/services/embedding/vector-math.js +27 -0
  283. package/dist/services/embedding/vector-math.js.map +1 -0
  284. package/dist/services/embedding/voyage.d.ts +16 -0
  285. package/dist/services/embedding/voyage.d.ts.map +1 -0
  286. package/dist/services/embedding/voyage.js +33 -0
  287. package/dist/services/embedding/voyage.js.map +1 -0
  288. package/dist/services/extraction/decision-extractor.d.ts +16 -0
  289. package/dist/services/extraction/decision-extractor.d.ts.map +1 -0
  290. package/dist/services/extraction/decision-extractor.js +111 -0
  291. package/dist/services/extraction/decision-extractor.js.map +1 -0
  292. package/dist/services/extraction/session-summarizer.d.ts +17 -0
  293. package/dist/services/extraction/session-summarizer.d.ts.map +1 -0
  294. package/dist/services/extraction/session-summarizer.js +112 -0
  295. package/dist/services/extraction/session-summarizer.js.map +1 -0
  296. package/dist/services/github/webhook.d.ts +17 -0
  297. package/dist/services/github/webhook.d.ts.map +1 -0
  298. package/dist/services/github/webhook.js +159 -0
  299. package/dist/services/github/webhook.js.map +1 -0
  300. package/dist/services/llm/factory.d.ts +3 -0
  301. package/dist/services/llm/factory.d.ts.map +1 -0
  302. package/dist/services/llm/factory.js +53 -0
  303. package/dist/services/llm/factory.js.map +1 -0
  304. package/dist/services/llm/openai-compat.d.ts +20 -0
  305. package/dist/services/llm/openai-compat.d.ts.map +1 -0
  306. package/dist/services/llm/openai-compat.js +53 -0
  307. package/dist/services/llm/openai-compat.js.map +1 -0
  308. package/dist/services/llm/types.d.ts +23 -0
  309. package/dist/services/llm/types.d.ts.map +1 -0
  310. package/dist/services/llm/types.js +2 -0
  311. package/dist/services/llm/types.js.map +1 -0
  312. package/dist/services/mentions/resolver.d.ts +36 -0
  313. package/dist/services/mentions/resolver.d.ts.map +1 -0
  314. package/dist/services/mentions/resolver.js +97 -0
  315. package/dist/services/mentions/resolver.js.map +1 -0
  316. package/dist/services/plugins/api.d.ts +55 -0
  317. package/dist/services/plugins/api.d.ts.map +1 -0
  318. package/dist/services/plugins/api.js +35 -0
  319. package/dist/services/plugins/api.js.map +1 -0
  320. package/dist/services/plugins/discovery.d.ts +7 -0
  321. package/dist/services/plugins/discovery.d.ts.map +1 -0
  322. package/dist/services/plugins/discovery.js +104 -0
  323. package/dist/services/plugins/discovery.js.map +1 -0
  324. package/dist/services/plugins/marketplace.d.ts +42 -0
  325. package/dist/services/plugins/marketplace.d.ts.map +1 -0
  326. package/dist/services/plugins/marketplace.js +186 -0
  327. package/dist/services/plugins/marketplace.js.map +1 -0
  328. package/dist/services/plugins/registry.d.ts +12 -0
  329. package/dist/services/plugins/registry.d.ts.map +1 -0
  330. package/dist/services/plugins/registry.js +66 -0
  331. package/dist/services/plugins/registry.js.map +1 -0
  332. package/dist/services/plugins/state.d.ts +12 -0
  333. package/dist/services/plugins/state.d.ts.map +1 -0
  334. package/dist/services/plugins/state.js +14 -0
  335. package/dist/services/plugins/state.js.map +1 -0
  336. package/dist/services/push/web-push.d.ts +26 -0
  337. package/dist/services/push/web-push.d.ts.map +1 -0
  338. package/dist/services/push/web-push.js +84 -0
  339. package/dist/services/push/web-push.js.map +1 -0
  340. package/dist/services/relay/client.d.ts +27 -0
  341. package/dist/services/relay/client.d.ts.map +1 -0
  342. package/dist/services/relay/client.js +219 -0
  343. package/dist/services/relay/client.js.map +1 -0
  344. package/dist/services/relay/types.d.ts +19 -0
  345. package/dist/services/relay/types.d.ts.map +1 -0
  346. package/dist/services/relay/types.js +2 -0
  347. package/dist/services/relay/types.js.map +1 -0
  348. package/dist/services/telemetry/client.d.ts +35 -0
  349. package/dist/services/telemetry/client.d.ts.map +1 -0
  350. package/dist/services/telemetry/client.js +125 -0
  351. package/dist/services/telemetry/client.js.map +1 -0
  352. package/dist/services/transcription/whisper.d.ts +16 -0
  353. package/dist/services/transcription/whisper.d.ts.map +1 -0
  354. package/dist/services/transcription/whisper.js +72 -0
  355. package/dist/services/transcription/whisper.js.map +1 -0
  356. package/docs/architecture.md +108 -0
  357. package/docs/configuration.md +73 -0
  358. package/docs/cursor-quirks.md +42 -0
  359. package/docs/embedding-providers.md +110 -0
  360. package/docs/github-integration.md +109 -0
  361. package/docs/plugin-development.md +104 -0
  362. package/docs/plugins.md +104 -0
  363. package/docs/relay.md +108 -0
  364. package/docs/remote-access.md +218 -0
  365. package/docs/sponsorship.md +54 -0
  366. package/migrations/.gitkeep +0 -0
  367. package/migrations/0001_initial_schema.sql +284 -0
  368. package/migrations/0002_activity_and_links.sql +26 -0
  369. package/migrations/0003_workspace.sql +7 -0
  370. package/migrations/0004_decision_drafts.sql +28 -0
  371. package/migrations/0005_project_summaries.sql +10 -0
  372. package/migrations/0006_push_and_approvals.sql +37 -0
  373. package/migrations/0007_session_costs.sql +17 -0
  374. package/migrations/0008_pr_links.sql +22 -0
  375. package/migrations/0009_telemetry.sql +17 -0
  376. package/migrations/0010_users_and_members.sql +40 -0
  377. package/migrations/0011_assignments_mentions.sql +20 -0
  378. package/package.json +95 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,70 @@
1
+ # Changelog
2
+
3
+ All notable changes to Shinobi will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.1.0] — 2026-06-03
9
+
10
+ First public release.
11
+
12
+ ### Added
13
+
14
+ - **MCP server** with 34 tools covering projects, subtasks, decisions,
15
+ dead-ends, notes, plans, context, recall, history, git linking, workflow
16
+ helpers (`agent_bootstrap`, `session_closeout`), extraction (LLM-powered
17
+ decision drafts, session summaries), and approvals.
18
+ - **Local SQLite store** at `~/.shinobi/shinobi.db` with WAL mode, foreign
19
+ keys, FTS5 virtual tables for fulltext search, optional embedding BLOBs
20
+ for semantic recall.
21
+ - **Hono-served web dashboard** on `localhost:8765` with Kanban, decisions,
22
+ dead-ends, notes, plans, context, timeline, analytics, drafts, sessions,
23
+ voice capture, mobile push approvals, plugin marketplace, multi-agent
24
+ relay status.
25
+ - **React + Vite + Tailwind SPA** for the dashboard with mobile-responsive
26
+ layout and PWA manifest (installable on iOS / Android home screen).
27
+ - **Plugin system** discovering custom MCP tools from
28
+ `~/.shinobi/plugins/*.js` and `@shinobi/plugin-*` npm packages.
29
+ - **Embedding providers** — OpenAI (text-embedding-3-small), Voyage
30
+ (voyage-3-lite), Ollama (nomic-embed-text), BYO key. Falls back to FTS5
31
+ when no provider configured.
32
+ - **Cross-machine sync** — git-based snapshot push/pull
33
+ (`shinobi sync push` / `shinobi sync pull`).
34
+ - **Multi-agent realtime relay** — Cloudflare Worker + Durable Object
35
+ broadcasting `sync-available` events across workspace members within
36
+ ~1.5s.
37
+ - **Mobile push approvals** — `request_approval` MCP tool with Web Push
38
+ notification + action buttons, agent unblocks on response.
39
+ - **Voice capture** — PWA records or accepts uploaded audio, transcribes
40
+ via Whisper (BYO key), drafts decisions via LLM extractor for review.
41
+ - **GitHub integration** — `link_commit` MCP tool, webhook receiver for
42
+ PR linking via `[SHI-N]` tags or `target_path` attribution.
43
+ - **Session cost tracking** — per-session input/output token tallies for
44
+ Claude Code logs and Anthropic API call records.
45
+ - **Optional multi-user mode** — magic-link email auth, project members,
46
+ mentions; dormant when zero users exist (single-user transparent loopback).
47
+ - **VS Code + Cursor extensions** — status bar widget, project picker,
48
+ three sidebar views (tasks, recent decisions, dead-ends), six commands.
49
+ - **Forward-only SQL migrations** with checksum verification and adopt /
50
+ dry-run / verify CLI flags.
51
+
52
+ ### Distribution
53
+
54
+ - `npm install -g github:numbererikson/shinobi` installs the CLI globally.
55
+ - MIT license.
56
+ - Node.js 18+ required; better-sqlite3 ships prebuilt binaries for
57
+ Linux / macOS / Windows.
58
+
59
+ ### Known limitations
60
+
61
+ - Hosted SaaS tier is on the roadmap (waitlist via Team / Pro CTAs on the
62
+ marketing site) — not generally available at launch.
63
+ - Multi-user schema is wired (auth, members, mentions, subtask
64
+ assignments) but UI affordances are minimal; team-mode polish is
65
+ scheduled for v0.2.
66
+ - npm audit reports 5 moderate-severity advisories in the dev-dependency
67
+ chain (esbuild via vite via vitest, dev server only — not in the
68
+ shipped runtime). Tracked for v0.2 vite upgrade.
69
+
70
+ [0.1.0]: https://github.com/numbererikson/shinobi/releases/tag/v0.1.0
@@ -0,0 +1,70 @@
1
+ # Code of Conduct
2
+
3
+ This project follows the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
4
+
5
+ By participating in this community — opening issues, submitting pull
6
+ requests, commenting, or otherwise engaging — you agree to uphold its terms.
7
+
8
+ ## Our Pledge
9
+
10
+ We pledge to make participation in our community a welcoming experience for
11
+ everyone, regardless of age, body size, disability, ethnicity, gender
12
+ identity and expression, level of experience, education, socio-economic
13
+ status, nationality, personal appearance, race, religion, or sexual
14
+ identity and orientation.
15
+
16
+ We pledge to act and interact in ways that contribute to an open, welcoming,
17
+ diverse, inclusive, and healthy community.
18
+
19
+ ## Standards
20
+
21
+ Examples of behavior that contributes to a positive environment:
22
+
23
+ - Demonstrating empathy and kindness toward other people
24
+ - Being respectful of differing opinions, viewpoints, and experiences
25
+ - Giving and gracefully accepting constructive feedback
26
+ - Accepting responsibility, apologizing to those affected by our mistakes,
27
+ and learning from the experience
28
+ - Focusing on what is best not just for us as individuals, but for the
29
+ overall community
30
+
31
+ Examples of unacceptable behavior:
32
+
33
+ - The use of sexualized language or imagery, and sexual attention or
34
+ advances of any kind
35
+ - Trolling, insulting or derogatory comments, and personal or political
36
+ attacks
37
+ - Public or private harassment
38
+ - Publishing others' private information, such as a physical or email
39
+ address, without their explicit permission
40
+ - Other conduct which could reasonably be considered inappropriate in a
41
+ professional setting
42
+
43
+ ## Enforcement
44
+
45
+ Instances of unacceptable behavior may be reported to the project
46
+ maintainer at:
47
+
48
+ ```
49
+ contact@shinobi-apps.hr
50
+ ```
51
+
52
+ All complaints will be reviewed and investigated promptly and fairly. The
53
+ maintainer is obligated to respect the privacy and security of the reporter
54
+ of any incident.
55
+
56
+ ## Scope
57
+
58
+ This Code of Conduct applies within all community spaces — the GitHub
59
+ repository, issue tracker, pull requests, Discord (if/when launched), and
60
+ any other forum maintained by the project. It also applies when an
61
+ individual is officially representing the community in public spaces.
62
+
63
+ ## Attribution
64
+
65
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
66
+ version 2.1, available at
67
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
68
+
69
+ [homepage]: https://www.contributor-covenant.org
70
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Tomislav Krizan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,269 @@
1
+ # Shinobi
2
+
3
+ [![test](https://github.com/numbererikson/shinobi/actions/workflows/test.yml/badge.svg)](https://github.com/numbererikson/shinobi/actions/workflows/test.yml)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+ [![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
6
+
7
+ Local-first task spine + memory layer for AI coding agents.
8
+
9
+ Works with Claude Code, Cursor, Cline, Continue.dev, Zed — any MCP-compatible client.
10
+
11
+ > **Status:** v0.1 — feature-complete first release. MCP server with 34 tools, web dashboard, plugin system, cross-machine sync, optional semantic recall.
12
+
13
+ ## What it does
14
+
15
+ Shinobi gives your AI coding agent persistent project memory across sessions:
16
+
17
+ - **Projects + subtasks** — track multi-session work as the agent claims, completes, or pivots
18
+ - **Decisions** — record architectural choices with rationale so future sessions don't re-litigate them
19
+ - **Dead ends** — log approaches that failed; the agent checks here before retrying
20
+ - **Notes** — free-form annotations and voice notes (audio_path field)
21
+ - **Plans** — versioned plan snapshots, retrievable mid-task
22
+ - **Context** — per-project conventions, "don't touch" rules, test patterns, deploy notes, file annotations
23
+ - **Recall** — fulltext (FTS5) by default, semantic (embedding-backed) when an embedding provider is configured
24
+ - **Activity timeline** — every write path lands in the timeline so you can replay what happened
25
+ - **Git linking** — `link_commit` ties commits to subtasks via `[SHI-N]` tags or via `target_path` attribution
26
+ - **Web dashboard** — Hono-served Kanban + decisions + dead ends + notes + plans + context + timeline + analytics on `localhost:8765`
27
+ - **Cross-machine sync** — git-based snapshot push/pull, zero cloud infrastructure
28
+ - **Plugin system** — drop a `.js` file in `~/.shinobi/plugins/` or install a `@shinobi/plugin-*` npm package and register custom `plugin_*` tools
29
+
30
+ All local. SQLite. No cloud account required (BYO embedding provider only if you want semantic recall).
31
+
32
+ ## Install
33
+
34
+ Requirements:
35
+
36
+ - Node.js 18+ on `PATH`
37
+ - C++ build toolchain for `better-sqlite3` native build (most systems have prebuilt binaries; Windows may need [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) as fallback)
38
+
39
+ ### From npm (recommended)
40
+
41
+ ```bash
42
+ npm install -g @shinobiapps/shinobi
43
+ ```
44
+
45
+ The binary is `shinobi` (e.g. `shinobi serve`, `shinobi dashboard`).
46
+
47
+ ### From GitHub (latest, unreleased)
48
+
49
+ ```bash
50
+ npm install -g github:numbererikson/shinobi
51
+ ```
52
+
53
+ Pulls from `main`. Useful for trying unreleased fixes. On Windows you may need
54
+ to add your Node directory to system `PATH` before this works, because the
55
+ `prepare` build script runs in a subshell that does not always inherit
56
+ per-session `PATH` (Laragon, portable installs). If install fails with `'node'
57
+ is not recognized`, prefer the npm install above.
58
+
59
+ ### From a cloned source folder (for development / contributing)
60
+
61
+ ```bash
62
+ git clone https://github.com/numbererikson/shinobi.git
63
+ cd shinobi
64
+ npm install # triggers `prepare` → builds dist/
65
+ npm install -g .
66
+ ```
67
+
68
+ ### Then bootstrap
69
+
70
+ In any project root where you want Shinobi available to your MCP client:
71
+
72
+ ```bash
73
+ shinobi init
74
+ shinobi dashboard
75
+ ```
76
+
77
+ `init` will:
78
+ 1. Create `~/.shinobi/` with `config.json`, `.env` template, and `shinobi.db` (migrations applied)
79
+ 2. Drop a `.mcp.json` snippet for the current project
80
+ 3. Print next steps
81
+
82
+ Restart your MCP client (Claude Code / Cursor / Cline) and the `mcp__shinobi__*` tools become available.
83
+
84
+ Then open:
85
+
86
+ ```text
87
+ http://127.0.0.1:8765
88
+ ```
89
+
90
+ On Windows PowerShell, if script execution blocks `shinobi`, use the `.cmd` shim:
91
+
92
+ ```powershell
93
+ shinobi.cmd dashboard
94
+ ```
95
+
96
+ If you upgraded Node or copied an old `node_modules`, rebuild native dependencies:
97
+
98
+ ```bash
99
+ npm rebuild better-sqlite3
100
+ ```
101
+
102
+ Important: the code lives in the Shinobi folder, but the local memory database lives in:
103
+
104
+ ```text
105
+ ~/.shinobi/shinobi.db
106
+ ```
107
+
108
+ To move the tool only, copy/clone the Shinobi folder and run the install commands above. To move the existing projects, tasks, decisions, notes, and context too, either copy `~/.shinobi/` or use `shinobi sync`.
109
+
110
+ ## CLI
111
+
112
+ ```
113
+ shinobi <command> [options]
114
+
115
+ Commands:
116
+ init Bootstrap ~/.shinobi/ and drop .mcp.json in the current directory
117
+ mcp Run the MCP server over stdio (invoked by the MCP client)
118
+ migrate Apply pending SQL migrations
119
+ dashboard Start the web dashboard on localhost (default port 8765)
120
+ sync init <path> [branch] Configure a local git repo as the cross-machine sync target
121
+ sync push Snapshot the DB and commit it to the sync repo
122
+ sync pull Restore the DB from the sync repo's snapshot
123
+ sync status Show last push/pull timestamps and git status
124
+ ```
125
+
126
+ ## MCP tools (34)
127
+
128
+ | Group | Tools |
129
+ |---|---|
130
+ | Projects | list_projects, get_project, create_project, update_project, archive_project, unarchive_project, delete_project |
131
+ | Subtasks | list_tasks, get_task, create_task, bulk_create_tasks, update_subtask, delete_subtask, claim_task, complete_task, next_task |
132
+ | Decisions | log_decision, decisions_for_file, update_decision_status |
133
+ | Dead ends | log_dead_end, check_dead_ends |
134
+ | Notes | add_note, list_notes |
135
+ | Plans | save_plan, get_plan |
136
+ | Context | get_context, update_context |
137
+ | Recall | recall (FTS5 or semantic) |
138
+ | Timeline | history, link_commit |
139
+ | Workflow | agent_bootstrap, session_closeout, file_context |
140
+ | Plugins | plugin_hello |
141
+
142
+ ## Architecture
143
+
144
+ | Layer | Tech |
145
+ |---|---|
146
+ | Language | TypeScript (strict mode, ES2022, NodeNext) |
147
+ | Runtime | Node 18+ |
148
+ | MCP | `@modelcontextprotocol/sdk` 1.x |
149
+ | Storage | SQLite via `better-sqlite3` (WAL mode) |
150
+ | Dashboard | Hono + `@hono/node-server` (same process, localhost:8765) |
151
+ | Embeddings (optional) | OpenAI text-embedding-3-small / Voyage voyage-3-lite / Ollama nomic-embed-text |
152
+ | Migrations | Forward-only, sha256 checksum, `schema_migrations` table |
153
+
154
+ See [docs/architecture.md](docs/architecture.md) for the request lifecycle and module layout.
155
+
156
+ ## Dashboard auth
157
+
158
+ The dashboard is open on loopback binds (`127.0.0.1`, `localhost`, `::1`) and token-protected on any non-loopback bind. The token is read from `SHINOBI_DASHBOARD_TOKEN`, otherwise loaded from `~/.shinobi/dashboard-token`, otherwise auto-generated and persisted there. `/health` is always open for probes.
159
+
160
+ Browser flow — open the dashboard with the token once and the cookie sticks:
161
+
162
+ ```text
163
+ http://192.168.1.10:8765/?token=YOUR_TOKEN
164
+ ```
165
+
166
+ Curl / scripts — any of these works:
167
+
168
+ ```bash
169
+ curl -H "Authorization: Bearer $SHINOBI_DASHBOARD_TOKEN" http://192.168.1.10:8765/api/projects/1/snapshot
170
+ curl -H "X-Shinobi-Token: $SHINOBI_DASHBOARD_TOKEN" http://192.168.1.10:8765/api/projects/1/snapshot
171
+ curl --cookie "shinobi_token=$SHINOBI_DASHBOARD_TOKEN" http://192.168.1.10:8765/api/projects/1/snapshot
172
+ ```
173
+
174
+ See [docs/configuration.md](docs/configuration.md#dashboard) for the full env-var reference.
175
+
176
+ ## Cross-machine sync
177
+
178
+ Shinobi syncs your local SQLite database via a private git repo. Setup once per machine:
179
+
180
+ ```bash
181
+ # Once: clone a private GitHub repo to act as the sync repo
182
+ git clone git@github.com:USER/shinobi-sync.git ~/shinobi-sync
183
+
184
+ # Once per machine: tell shinobi about it
185
+ shinobi sync init ~/shinobi-sync main
186
+
187
+ # Push from the writer machine:
188
+ shinobi sync push
189
+
190
+ # Pull on the reader machine:
191
+ shinobi sync pull
192
+ ```
193
+
194
+ The DB file lands on the `main` branch as a binary; pre-existing local DB is backed up to `<path>.bak-<timestamp>` before restore.
195
+
196
+ ## Configuration
197
+
198
+ Edit `~/.shinobi/.env` or set env vars before running `shinobi mcp`:
199
+
200
+ | Variable | Default | Purpose |
201
+ |---|---|---|
202
+ | `SHINOBI_DB_PATH` | `~/.shinobi/shinobi.db` | SQLite location |
203
+ | `SHINOBI_CONFIG_DIR` | `~/.shinobi` | Config + plugins directory |
204
+ | `SHINOBI_PLUGINS_DIR` | `${configdir}/plugins` | Plugin discovery directory |
205
+ | `SHINOBI_DASHBOARD_PORT` | `8765` | Dashboard port |
206
+ | `SHINOBI_DASHBOARD_HOST` | `127.0.0.1` | Dashboard bind host. Loopback skips auth; non-loopback auto-enables token auth. |
207
+ | `SHINOBI_DASHBOARD_TOKEN` | _(auto)_ | Override the dashboard token; auto-generated to `~/.shinobi/dashboard-token` when needed. |
208
+ | `SHINOBI_EMBED_PROVIDER` | `none` | `openai` / `voyage` / `ollama` / `none` |
209
+ | `SHINOBI_EMBED_API_KEY` | — | Auth for OpenAI / Voyage (else falls back to `OPENAI_API_KEY` / `VOYAGE_API_KEY`) |
210
+ | `SHINOBI_EMBED_MODEL` | provider default | Override model id |
211
+ | `SHINOBI_EMBED_DIMS` | provider default | Override dimensions |
212
+ | `SHINOBI_OLLAMA_URL` | `http://localhost:11434` | Ollama endpoint |
213
+ | `SHINOBI_MIGRATIONS_DIR` | `<package>/migrations` | Override migrations source |
214
+
215
+ Full reference: [docs/configuration.md](docs/configuration.md).
216
+
217
+ ## Plugins
218
+
219
+ Write a single `.js` file in `~/.shinobi/plugins/`:
220
+
221
+ ```js
222
+ // ~/.shinobi/plugins/my-plugin.js
223
+ export default function register(registry, api) {
224
+ registry.registerTool({
225
+ name: 'plugin_count_open',
226
+ description: 'Count open decisions across all projects',
227
+ inputSchema: { type: 'object', properties: {}, additionalProperties: false },
228
+ handler: (_args, api) => {
229
+ const projects = api.listProjects();
230
+ let total = 0;
231
+ for (const p of projects) {
232
+ total += api.listDecisions({ projectId: p.id, status: 'open' }).length;
233
+ }
234
+ return { open_decisions: total };
235
+ },
236
+ });
237
+ }
238
+ ```
239
+
240
+ Restart the MCP client and `mcp__shinobi__plugin_count_open` is available. See [docs/plugin-development.md](docs/plugin-development.md).
241
+
242
+ ## Roadmap
243
+
244
+ - **v0.1 (current)** — local MCP + dashboard + plugin system + git sync + relay
245
+ + optional embeddings + voice + mobile push + VS Code/Cursor extensions.
246
+ - **v0.2** — multi-user team mode (auth + members + mentions UI), vite/dev-deps
247
+ upgrade, plugin marketplace UI polish, deeper integrations (Linear /
248
+ GitHub Issues sync candidates).
249
+ - **v0.3** — hosted SaaS GA + Stripe billing.
250
+ - **v1.0** — stability, audit, performance pass.
251
+
252
+ ## Changelog
253
+
254
+ See [CHANGELOG.md](CHANGELOG.md) for release notes.
255
+
256
+ ## Contributing
257
+
258
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Issues and PRs welcome.
259
+
260
+ By participating you agree to our [Code of Conduct](CODE_OF_CONDUCT.md).
261
+
262
+ ## Security
263
+
264
+ For vulnerability reports, see [SECURITY.md](SECURITY.md) — please do
265
+ **not** open public issues for security matters.
266
+
267
+ ## License
268
+
269
+ MIT — see [LICENSE](LICENSE).
package/SECURITY.md ADDED
@@ -0,0 +1,75 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ The latest released minor (currently v0.1.x) is supported with security
6
+ patches. Earlier versions are not.
7
+
8
+ ## Reporting a Vulnerability
9
+
10
+ If you've found a security issue in Shinobi, **please do not open a public
11
+ GitHub issue**. Instead, email:
12
+
13
+ ```
14
+ contact@shinobi-apps.hr
15
+ ```
16
+
17
+ Include:
18
+
19
+ - A description of the issue and its impact
20
+ - Steps to reproduce (proof-of-concept if you have one)
21
+ - Affected version(s)
22
+
23
+ You can expect:
24
+
25
+ - An acknowledgement within **5 business days**
26
+ - A status update within **10 business days**
27
+ - A patch released within **30 days** for confirmed, exploitable issues — or
28
+ a clear explanation if more time is required
29
+
30
+ ## Scope
31
+
32
+ **In scope:**
33
+
34
+ - The Shinobi MCP server (this repo)
35
+ - The Hono-served dashboard and its API endpoints
36
+ - The Cloudflare Worker relay (`relay-worker/`)
37
+ - The plugin discovery mechanism (`~/.shinobi/plugins/`, `@shinobi/plugin-*`)
38
+ - The npm distribution and `prepare` script
39
+
40
+ **Not in scope:**
41
+
42
+ - Vulnerabilities in third-party dependencies — please report those to the
43
+ dependency's maintainer. We pick up patches through normal dependency
44
+ updates and `npm audit fix`.
45
+ - Local-attack scenarios that require shell access to the user's machine
46
+ (Shinobi binds to loopback by default; we assume the host is trusted).
47
+ - Bugs that are not security-relevant — please file those as regular
48
+ GitHub issues.
49
+
50
+ ## Recognition
51
+
52
+ If you would like public credit after coordinated disclosure, we will add
53
+ you to an acknowledgements section in this file. Anonymous reporting is
54
+ fine — your call.
55
+
56
+ ## Threat Model
57
+
58
+ Shinobi is a local-first tool. The default deployment assumes:
59
+
60
+ - One user, one machine, loopback-only dashboard binding
61
+ - Trusted MCP client (the user's own AI agent)
62
+ - Local filesystem and SQLite store are not adversary-accessible
63
+
64
+ When the dashboard binds to a non-loopback address (`SHINOBI_DASHBOARD_HOST`
65
+ not in `127.0.0.1`/`localhost`), token auth is auto-enabled. The token is
66
+ generated to `~/.shinobi/dashboard-token`.
67
+
68
+ The Cloudflare Worker relay uses a shared HMAC token
69
+ (`SHINOBI_RELAY_TOKEN`); WebSocket connections with mismatched tokens are
70
+ rejected. Workspace separation is enforced via Durable Object naming.
71
+
72
+ If you operate Shinobi outside this threat model (multi-user hosted SaaS,
73
+ exposed dashboard without tunneling, etc.), please review the relevant
74
+ docs and consider whether additional hardening (reverse proxy, WAF, audit
75
+ logging) is appropriate for your deployment.
package/dist/cli.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=cli.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}