zilmate 1.8.1 → 1.8.5

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 (313) hide show
  1. package/.agents/skills/copywriting/SKILL.md +252 -0
  2. package/.agents/skills/copywriting/evals/evals.json +111 -0
  3. package/.agents/skills/copywriting/references/copy-frameworks.md +344 -0
  4. package/.agents/skills/copywriting/references/natural-transitions.md +272 -0
  5. package/.agents/skills/firecrawl-deep-research/SKILL.md +108 -0
  6. package/.agents/skills/shadcn/SKILL.md +267 -0
  7. package/.agents/skills/shadcn/agents/openai.yml +5 -0
  8. package/.agents/skills/shadcn/assets/shadcn-small.png +0 -0
  9. package/.agents/skills/shadcn/assets/shadcn.png +0 -0
  10. package/.agents/skills/shadcn/cli.md +290 -0
  11. package/.agents/skills/shadcn/customization.md +209 -0
  12. package/.agents/skills/shadcn/evals/evals.json +47 -0
  13. package/.agents/skills/shadcn/mcp.md +105 -0
  14. package/.agents/skills/shadcn/registry.md +277 -0
  15. package/.agents/skills/shadcn/rules/base-vs-radix.md +306 -0
  16. package/.agents/skills/shadcn/rules/composition.md +195 -0
  17. package/.agents/skills/shadcn/rules/forms.md +192 -0
  18. package/.agents/skills/shadcn/rules/icons.md +101 -0
  19. package/.agents/skills/shadcn/rules/styling.md +162 -0
  20. package/.agents/skills/tavily-research/SKILL.md +100 -0
  21. package/.agents/skills/upstash/SKILL.md +48 -0
  22. package/.agents/skills/upstash/upstash-box-js/overview.md +243 -0
  23. package/.agents/skills/upstash/upstash-box-py/overview.md +275 -0
  24. package/.agents/skills/upstash/upstash-cli/overview.md +138 -0
  25. package/.agents/skills/upstash/upstash-qstash-js/advanced/callbacks.md +147 -0
  26. package/.agents/skills/upstash/upstash-qstash-js/advanced/deduplication.md +86 -0
  27. package/.agents/skills/upstash/upstash-qstash-js/advanced/dlq.md +164 -0
  28. package/.agents/skills/upstash/upstash-qstash-js/advanced/multi-region/summary.md +388 -0
  29. package/.agents/skills/upstash/upstash-qstash-js/advanced/multi-region/verify-multi-region-setup.ts +388 -0
  30. package/.agents/skills/upstash/upstash-qstash-js/fundamentals/local-development.md +106 -0
  31. package/.agents/skills/upstash/upstash-qstash-js/fundamentals/publishing-messages.md +144 -0
  32. package/.agents/skills/upstash/upstash-qstash-js/fundamentals/queues-and-flow-control.md +148 -0
  33. package/.agents/skills/upstash/upstash-qstash-js/fundamentals/schedules.md +177 -0
  34. package/.agents/skills/upstash/upstash-qstash-js/fundamentals/url-groups.md +127 -0
  35. package/.agents/skills/upstash/upstash-qstash-js/overview.md +81 -0
  36. package/.agents/skills/upstash/upstash-qstash-js/verification/platform-specific/nextjs.md +171 -0
  37. package/.agents/skills/upstash/upstash-qstash-js/verification/receiver.md +213 -0
  38. package/.agents/skills/upstash/upstash-ratelimit-js/algorithms.md +84 -0
  39. package/.agents/skills/upstash/upstash-ratelimit-js/features.md +117 -0
  40. package/.agents/skills/upstash/upstash-ratelimit-js/methods-getting-started.md +77 -0
  41. package/.agents/skills/upstash/upstash-ratelimit-js/overview.md +26 -0
  42. package/.agents/skills/upstash/upstash-ratelimit-js/pricing-cost.md +146 -0
  43. package/.agents/skills/upstash/upstash-ratelimit-js/traffic-protection.md +77 -0
  44. package/.agents/skills/upstash/upstash-redis-js/advanced-features/auto-pipeline.md +49 -0
  45. package/.agents/skills/upstash/upstash-redis-js/advanced-features/pipeline-and-transactions.md +42 -0
  46. package/.agents/skills/upstash/upstash-redis-js/advanced-features/scripting.md +124 -0
  47. package/.agents/skills/upstash/upstash-redis-js/data-structures/hashes.md +71 -0
  48. package/.agents/skills/upstash/upstash-redis-js/data-structures/json.md +133 -0
  49. package/.agents/skills/upstash/upstash-redis-js/data-structures/lists.md +72 -0
  50. package/.agents/skills/upstash/upstash-redis-js/data-structures/sets.md +90 -0
  51. package/.agents/skills/upstash/upstash-redis-js/data-structures/sorted-sets.md +126 -0
  52. package/.agents/skills/upstash/upstash-redis-js/data-structures/streams.md +196 -0
  53. package/.agents/skills/upstash/upstash-redis-js/data-structures/strings.md +73 -0
  54. package/.agents/skills/upstash/upstash-redis-js/migrations/from-ioredis.md +163 -0
  55. package/.agents/skills/upstash/upstash-redis-js/migrations/from-redis-node.md +205 -0
  56. package/.agents/skills/upstash/upstash-redis-js/overview.md +183 -0
  57. package/.agents/skills/upstash/upstash-redis-js/patterns/caching.md +58 -0
  58. package/.agents/skills/upstash/upstash-redis-js/patterns/distributed-locks.md +130 -0
  59. package/.agents/skills/upstash/upstash-redis-js/patterns/leaderboard.md +134 -0
  60. package/.agents/skills/upstash/upstash-redis-js/patterns/rate-limiting.md +187 -0
  61. package/.agents/skills/upstash/upstash-redis-js/patterns/session-management.md +217 -0
  62. package/.agents/skills/upstash/upstash-redis-js/performance/batching-operations.md +76 -0
  63. package/.agents/skills/upstash/upstash-redis-js/performance/data-serialization.md +134 -0
  64. package/.agents/skills/upstash/upstash-redis-js/performance/error-handling.md +118 -0
  65. package/.agents/skills/upstash/upstash-redis-js/performance/pipeline-optimization.md +105 -0
  66. package/.agents/skills/upstash/upstash-redis-js/performance/redis-replicas.md +14 -0
  67. package/.agents/skills/upstash/upstash-redis-js/performance/ttl-expiration.md +32 -0
  68. package/.agents/skills/upstash/upstash-redis-js/search/adapters.md +99 -0
  69. package/.agents/skills/upstash/upstash-redis-js/search/commands/aggregating.md +234 -0
  70. package/.agents/skills/upstash/upstash-redis-js/search/commands/aliases.md +76 -0
  71. package/.agents/skills/upstash/upstash-redis-js/search/commands/index-management.md +124 -0
  72. package/.agents/skills/upstash/upstash-redis-js/search/commands/querying.md +315 -0
  73. package/.agents/skills/upstash/upstash-redis-js/search/overview.md +155 -0
  74. package/.agents/skills/upstash/upstash-redis-start/overview.md +71 -0
  75. package/.agents/skills/upstash/upstash-search-js/overview.md +48 -0
  76. package/.agents/skills/upstash/upstash-search-js/quick-start.md +158 -0
  77. package/.agents/skills/upstash/upstash-search-js/sdk-overview.md +158 -0
  78. package/.agents/skills/upstash/upstash-vector-js/features/filtering-and-metadata.md +82 -0
  79. package/.agents/skills/upstash/upstash-vector-js/features/index-structure.md +193 -0
  80. package/.agents/skills/upstash/upstash-vector-js/features/namespaces.md +32 -0
  81. package/.agents/skills/upstash/upstash-vector-js/overview.md +44 -0
  82. package/.agents/skills/upstash/upstash-vector-js/sdk-methods.md +210 -0
  83. package/.agents/skills/upstash/upstash-workflow-js/agents.md +248 -0
  84. package/.agents/skills/upstash/upstash-workflow-js/basics/client.md +180 -0
  85. package/.agents/skills/upstash/upstash-workflow-js/basics/context.md +230 -0
  86. package/.agents/skills/upstash/upstash-workflow-js/basics/serve.md +70 -0
  87. package/.agents/skills/upstash/upstash-workflow-js/features/flow-control.md +145 -0
  88. package/.agents/skills/upstash/upstash-workflow-js/features/invoke.md +97 -0
  89. package/.agents/skills/upstash/upstash-workflow-js/features/retries-failures-reliability.md +239 -0
  90. package/.agents/skills/upstash/upstash-workflow-js/features/wait-for-event.md +97 -0
  91. package/.agents/skills/upstash/upstash-workflow-js/features/webhooks.md +79 -0
  92. package/.agents/skills/upstash/upstash-workflow-js/how-to/local-dev.md +177 -0
  93. package/.agents/skills/upstash/upstash-workflow-js/how-to/middleware.md +166 -0
  94. package/.agents/skills/upstash/upstash-workflow-js/how-to/migrations.md +201 -0
  95. package/.agents/skills/upstash/upstash-workflow-js/how-to/realtime.md +186 -0
  96. package/.agents/skills/upstash/upstash-workflow-js/overview.md +55 -0
  97. package/.agents/skills/upstash/upstash-workflow-js/rest-api.md +156 -0
  98. package/.agents/skills/upstash/upstash-workflow-js/troubleshooting.md +201 -0
  99. package/.agents/skills/upstash-box-js/SKILL.md +248 -0
  100. package/.agents/skills/upstash-box-py/SKILL.md +280 -0
  101. package/.agents/skills/upstash-cli/SKILL.md +143 -0
  102. package/.agents/skills/upstash-qstash-js/SKILL.md +86 -0
  103. package/.agents/skills/upstash-qstash-js/advanced/callbacks.md +147 -0
  104. package/.agents/skills/upstash-qstash-js/advanced/deduplication.md +86 -0
  105. package/.agents/skills/upstash-qstash-js/advanced/dlq.md +164 -0
  106. package/.agents/skills/upstash-qstash-js/advanced/multi-region/summary.md +388 -0
  107. package/.agents/skills/upstash-qstash-js/advanced/multi-region/verify-multi-region-setup.ts +388 -0
  108. package/.agents/skills/upstash-qstash-js/fundamentals/local-development.md +106 -0
  109. package/.agents/skills/upstash-qstash-js/fundamentals/publishing-messages.md +144 -0
  110. package/.agents/skills/upstash-qstash-js/fundamentals/queues-and-flow-control.md +148 -0
  111. package/.agents/skills/upstash-qstash-js/fundamentals/schedules.md +177 -0
  112. package/.agents/skills/upstash-qstash-js/fundamentals/url-groups.md +127 -0
  113. package/.agents/skills/upstash-qstash-js/verification/platform-specific/nextjs.md +171 -0
  114. package/.agents/skills/upstash-qstash-js/verification/receiver.md +213 -0
  115. package/.agents/skills/upstash-ratelimit-js/SKILL.md +31 -0
  116. package/.agents/skills/upstash-ratelimit-js/algorithms.md +84 -0
  117. package/.agents/skills/upstash-ratelimit-js/features.md +117 -0
  118. package/.agents/skills/upstash-ratelimit-js/methods-getting-started.md +77 -0
  119. package/.agents/skills/upstash-ratelimit-js/pricing-cost.md +146 -0
  120. package/.agents/skills/upstash-ratelimit-js/traffic-protection.md +77 -0
  121. package/.agents/skills/upstash-redis-js/SKILL.md +188 -0
  122. package/.agents/skills/upstash-redis-js/advanced-features/auto-pipeline.md +49 -0
  123. package/.agents/skills/upstash-redis-js/advanced-features/pipeline-and-transactions.md +42 -0
  124. package/.agents/skills/upstash-redis-js/advanced-features/scripting.md +124 -0
  125. package/.agents/skills/upstash-redis-js/data-structures/hashes.md +71 -0
  126. package/.agents/skills/upstash-redis-js/data-structures/json.md +133 -0
  127. package/.agents/skills/upstash-redis-js/data-structures/lists.md +72 -0
  128. package/.agents/skills/upstash-redis-js/data-structures/sets.md +90 -0
  129. package/.agents/skills/upstash-redis-js/data-structures/sorted-sets.md +126 -0
  130. package/.agents/skills/upstash-redis-js/data-structures/streams.md +196 -0
  131. package/.agents/skills/upstash-redis-js/data-structures/strings.md +73 -0
  132. package/.agents/skills/upstash-redis-js/migrations/from-ioredis.md +163 -0
  133. package/.agents/skills/upstash-redis-js/migrations/from-redis-node.md +205 -0
  134. package/.agents/skills/upstash-redis-js/patterns/caching.md +58 -0
  135. package/.agents/skills/upstash-redis-js/patterns/distributed-locks.md +130 -0
  136. package/.agents/skills/upstash-redis-js/patterns/leaderboard.md +134 -0
  137. package/.agents/skills/upstash-redis-js/patterns/rate-limiting.md +187 -0
  138. package/.agents/skills/upstash-redis-js/patterns/session-management.md +217 -0
  139. package/.agents/skills/upstash-redis-js/performance/batching-operations.md +76 -0
  140. package/.agents/skills/upstash-redis-js/performance/data-serialization.md +134 -0
  141. package/.agents/skills/upstash-redis-js/performance/error-handling.md +118 -0
  142. package/.agents/skills/upstash-redis-js/performance/pipeline-optimization.md +105 -0
  143. package/.agents/skills/upstash-redis-js/performance/redis-replicas.md +14 -0
  144. package/.agents/skills/upstash-redis-js/performance/ttl-expiration.md +32 -0
  145. package/.agents/skills/upstash-redis-js/search/adapters.md +99 -0
  146. package/.agents/skills/upstash-redis-js/search/commands/aggregating.md +234 -0
  147. package/.agents/skills/upstash-redis-js/search/commands/aliases.md +76 -0
  148. package/.agents/skills/upstash-redis-js/search/commands/index-management.md +124 -0
  149. package/.agents/skills/upstash-redis-js/search/commands/querying.md +315 -0
  150. package/.agents/skills/upstash-redis-js/search/overview.md +155 -0
  151. package/.agents/skills/upstash-redis-start/SKILL.md +76 -0
  152. package/.agents/skills/upstash-search-js/SKILL.md +53 -0
  153. package/.agents/skills/upstash-search-js/quick-start.md +158 -0
  154. package/.agents/skills/upstash-search-js/sdk-overview.md +158 -0
  155. package/.agents/skills/upstash-vector-js/SKILL.md +49 -0
  156. package/.agents/skills/upstash-vector-js/features/filtering-and-metadata.md +82 -0
  157. package/.agents/skills/upstash-vector-js/features/index-structure.md +193 -0
  158. package/.agents/skills/upstash-vector-js/features/namespaces.md +32 -0
  159. package/.agents/skills/upstash-vector-js/sdk-methods.md +210 -0
  160. package/.agents/skills/upstash-workflow-js/SKILL.md +60 -0
  161. package/.agents/skills/upstash-workflow-js/agents.md +248 -0
  162. package/.agents/skills/upstash-workflow-js/basics/client.md +180 -0
  163. package/.agents/skills/upstash-workflow-js/basics/context.md +230 -0
  164. package/.agents/skills/upstash-workflow-js/basics/serve.md +70 -0
  165. package/.agents/skills/upstash-workflow-js/features/flow-control.md +145 -0
  166. package/.agents/skills/upstash-workflow-js/features/invoke.md +97 -0
  167. package/.agents/skills/upstash-workflow-js/features/retries-failures-reliability.md +239 -0
  168. package/.agents/skills/upstash-workflow-js/features/wait-for-event.md +97 -0
  169. package/.agents/skills/upstash-workflow-js/features/webhooks.md +79 -0
  170. package/.agents/skills/upstash-workflow-js/how-to/local-dev.md +177 -0
  171. package/.agents/skills/upstash-workflow-js/how-to/middleware.md +166 -0
  172. package/.agents/skills/upstash-workflow-js/how-to/migrations.md +201 -0
  173. package/.agents/skills/upstash-workflow-js/how-to/realtime.md +186 -0
  174. package/.agents/skills/upstash-workflow-js/rest-api.md +156 -0
  175. package/.agents/skills/upstash-workflow-js/troubleshooting.md +201 -0
  176. package/dist/agents/coding.agent.d.ts +185 -42
  177. package/dist/agents/coding.agent.d.ts.map +1 -1
  178. package/dist/agents/coding.agent.js +42 -5
  179. package/dist/agents/coding.agent.js.map +1 -1
  180. package/dist/agents/manager.d.ts +216 -41
  181. package/dist/agents/manager.d.ts.map +1 -1
  182. package/dist/agents/manager.js +103 -140
  183. package/dist/agents/manager.js.map +1 -1
  184. package/dist/agents/security.agent.d.ts +3 -3
  185. package/dist/agents/swarm/development/lead.d.ts +3 -0
  186. package/dist/agents/swarm/development/lead.d.ts.map +1 -0
  187. package/dist/agents/swarm/development/lead.js +24 -0
  188. package/dist/agents/swarm/development/lead.js.map +1 -0
  189. package/dist/agents/swarm/main.d.ts +69 -0
  190. package/dist/agents/swarm/main.d.ts.map +1 -1
  191. package/dist/agents/swarm/main.js +65 -11
  192. package/dist/agents/swarm/main.js.map +1 -1
  193. package/dist/agents/swarm/registry.d.ts +2 -1
  194. package/dist/agents/swarm/registry.d.ts.map +1 -1
  195. package/dist/agents/swarm/registry.js +225 -95
  196. package/dist/agents/swarm/registry.js.map +1 -1
  197. package/dist/cli/composer.d.ts.map +1 -1
  198. package/dist/cli/composer.js +85 -30
  199. package/dist/cli/composer.js.map +1 -1
  200. package/dist/cli/confirm.d.ts +2 -2
  201. package/dist/cli/confirm.d.ts.map +1 -1
  202. package/dist/cli/confirm.js +373 -4
  203. package/dist/cli/confirm.js.map +1 -1
  204. package/dist/cli/doctor.d.ts +1 -0
  205. package/dist/cli/doctor.d.ts.map +1 -1
  206. package/dist/cli/doctor.js +47 -2
  207. package/dist/cli/doctor.js.map +1 -1
  208. package/dist/cli/format.d.ts +4 -0
  209. package/dist/cli/format.d.ts.map +1 -1
  210. package/dist/cli/format.js +352 -65
  211. package/dist/cli/format.js.map +1 -1
  212. package/dist/cli/interactive.d.ts.map +1 -1
  213. package/dist/cli/interactive.js +80 -2
  214. package/dist/cli/interactive.js.map +1 -1
  215. package/dist/cli/menu.d.ts.map +1 -1
  216. package/dist/cli/menu.js +93 -83
  217. package/dist/cli/menu.js.map +1 -1
  218. package/dist/cli/render.d.ts.map +1 -1
  219. package/dist/cli/render.js +2 -1
  220. package/dist/cli/render.js.map +1 -1
  221. package/dist/cli/setup.d.ts.map +1 -1
  222. package/dist/cli/setup.js +262 -27
  223. package/dist/cli/setup.js.map +1 -1
  224. package/dist/cli/swarm.d.ts.map +1 -1
  225. package/dist/cli/swarm.js +13 -10
  226. package/dist/cli/swarm.js.map +1 -1
  227. package/dist/cli/theme.d.ts +7 -1
  228. package/dist/cli/theme.d.ts.map +1 -1
  229. package/dist/cli/theme.js +4 -16
  230. package/dist/cli/theme.js.map +1 -1
  231. package/dist/cli/update.d.ts.map +1 -1
  232. package/dist/cli/update.js +12 -4
  233. package/dist/cli/update.js.map +1 -1
  234. package/dist/config/env.d.ts +3 -1
  235. package/dist/config/env.d.ts.map +1 -1
  236. package/dist/config/env.js +22 -2
  237. package/dist/config/env.js.map +1 -1
  238. package/dist/config/models.d.ts +1 -0
  239. package/dist/config/models.d.ts.map +1 -1
  240. package/dist/config/models.js +17 -1
  241. package/dist/config/models.js.map +1 -1
  242. package/dist/documents/pdf.d.ts.map +1 -1
  243. package/dist/documents/pdf.js +282 -22
  244. package/dist/documents/pdf.js.map +1 -1
  245. package/dist/documents/slides.d.ts.map +1 -1
  246. package/dist/documents/slides.js +160 -30
  247. package/dist/documents/slides.js.map +1 -1
  248. package/dist/index.js +73 -18
  249. package/dist/index.js.map +1 -1
  250. package/dist/memory/history.js +1 -1
  251. package/dist/observability/doctor.d.ts.map +1 -1
  252. package/dist/observability/doctor.js +3 -0
  253. package/dist/observability/doctor.js.map +1 -1
  254. package/dist/runtime/progress.d.ts +5 -1
  255. package/dist/runtime/progress.d.ts.map +1 -1
  256. package/dist/runtime/progress.js.map +1 -1
  257. package/dist/runtime/swarm.d.ts +1 -1
  258. package/dist/runtime/swarm.d.ts.map +1 -1
  259. package/dist/runtime/swarm.js +19 -3
  260. package/dist/runtime/swarm.js.map +1 -1
  261. package/dist/runtime/tool-utils.d.ts +2 -0
  262. package/dist/runtime/tool-utils.d.ts.map +1 -1
  263. package/dist/runtime/tool-utils.js +91 -0
  264. package/dist/runtime/tool-utils.js.map +1 -1
  265. package/dist/server.js +1 -1
  266. package/dist/server.js.map +1 -1
  267. package/dist/skills/loader.d.ts.map +1 -1
  268. package/dist/skills/loader.js +16 -0
  269. package/dist/skills/loader.js.map +1 -1
  270. package/dist/test-call.d.ts +2 -0
  271. package/dist/test-call.d.ts.map +1 -0
  272. package/dist/test-call.js +29 -0
  273. package/dist/test-call.js.map +1 -0
  274. package/dist/test-manager-call.d.ts +2 -0
  275. package/dist/test-manager-call.d.ts.map +1 -0
  276. package/dist/test-manager-call.js +138 -0
  277. package/dist/test-manager-call.js.map +1 -0
  278. package/dist/test-manager-filtered.d.ts +2 -0
  279. package/dist/test-manager-filtered.d.ts.map +1 -0
  280. package/dist/test-manager-filtered.js +130 -0
  281. package/dist/test-manager-filtered.js.map +1 -0
  282. package/dist/test-mcp-call.d.ts +2 -0
  283. package/dist/test-mcp-call.d.ts.map +1 -0
  284. package/dist/test-mcp-call.js +103 -0
  285. package/dist/test-mcp-call.js.map +1 -0
  286. package/dist/tools/composio.tool.d.ts +1 -1
  287. package/dist/tools/composio.tool.d.ts.map +1 -1
  288. package/dist/tools/composio.tool.js +7 -16
  289. package/dist/tools/composio.tool.js.map +1 -1
  290. package/dist/tools/executive.tool.d.ts +40 -0
  291. package/dist/tools/executive.tool.d.ts.map +1 -0
  292. package/dist/tools/executive.tool.js +74 -0
  293. package/dist/tools/executive.tool.js.map +1 -0
  294. package/dist/tools/filesystem.tool.d.ts +183 -40
  295. package/dist/tools/filesystem.tool.d.ts.map +1 -1
  296. package/dist/tools/filesystem.tool.js +564 -111
  297. package/dist/tools/filesystem.tool.js.map +1 -1
  298. package/dist/tools/mcp.tool.d.ts +56 -0
  299. package/dist/tools/mcp.tool.d.ts.map +1 -0
  300. package/dist/tools/mcp.tool.js +285 -0
  301. package/dist/tools/mcp.tool.js.map +1 -0
  302. package/dist/tools/osint.tool.d.ts +4 -4
  303. package/dist/tools/pentest.tool.d.ts +2 -2
  304. package/dist/tools/setup-assistant.tool.d.ts +1 -1
  305. package/dist/tools/setup-assistant.tool.js +1 -1
  306. package/dist/tools/setup-assistant.tool.js.map +1 -1
  307. package/dist/workspace/paths.d.ts +1 -0
  308. package/dist/workspace/paths.d.ts.map +1 -1
  309. package/dist/workspace/paths.js +3 -4
  310. package/dist/workspace/paths.js.map +1 -1
  311. package/package.json +7 -3
  312. package/scripts/postinstall.mjs +19 -4
  313. package/scripts/release-github.mjs +11 -11
@@ -0,0 +1,277 @@
1
+ # Registry Authoring and Addresses
2
+
3
+ Use this reference when the user wants to create, fix, publish, or reason about
4
+ a shadcn registry.
5
+
6
+ ## Mental Model
7
+
8
+ A registry has two forms:
9
+
10
+ - **Source registry**: an authored `registry.json` in a project or repository.
11
+ It may use `include` and file paths that point at source files.
12
+ - **Built registry**: generated JSON files served to CLI consumers, usually
13
+ from `public/r`. Use `npx shadcn@latest build` to create this form.
14
+
15
+ The CLI installer consumes registry item payloads. A source registry is a way to
16
+ author those payloads from real files.
17
+
18
+ Registry items are not limited to React components. They can distribute
19
+ components, hooks, utilities, design tokens, pages, config files, docs, rules,
20
+ workflows, templates, MCP files, and other project files.
21
+
22
+ ## Root `registry.json`
23
+
24
+ The root registry file should define registry metadata and either `items` or
25
+ `include`.
26
+
27
+ ```json
28
+ {
29
+ "$schema": "https://ui.shadcn.com/schema/registry.json",
30
+ "name": "acme",
31
+ "homepage": "https://acme.com",
32
+ "items": [
33
+ {
34
+ "name": "absolute-url",
35
+ "type": "registry:lib",
36
+ "title": "Absolute URL",
37
+ "description": "A utility to turn any path into an absolute URL.",
38
+ "files": [
39
+ {
40
+ "path": "lib/absolute-url.ts",
41
+ "type": "registry:lib"
42
+ }
43
+ ]
44
+ }
45
+ ]
46
+ }
47
+ ```
48
+
49
+ Root registry rules:
50
+
51
+ - Root `registry.json` must include `name` and `homepage`.
52
+ - `items` is an array of registry item definitions.
53
+ - `include` may be used to split the source registry into multiple files.
54
+ - Included registry files may omit `name` and `homepage`.
55
+
56
+ ## Include
57
+
58
+ Use `include` to keep large registries modular.
59
+
60
+ ```json
61
+ {
62
+ "$schema": "https://ui.shadcn.com/schema/registry.json",
63
+ "name": "acme",
64
+ "homepage": "https://acme.com",
65
+ "include": ["registry/ui/registry.json", "registry/blocks/registry.json"]
66
+ }
67
+ ```
68
+
69
+ Include rules:
70
+
71
+ - Include paths are relative to the `registry.json` that declares them.
72
+ - Include paths must explicitly point to a `registry.json` file.
73
+ - Do not use remote URLs, absolute paths, or parent traversal (`..`).
74
+ - Item file paths are relative to the registry file that declares the item.
75
+ - Duplicate item names fail across the resolved registry.
76
+
77
+ Example included file:
78
+
79
+ ```json
80
+ {
81
+ "items": [
82
+ {
83
+ "name": "button",
84
+ "type": "registry:ui",
85
+ "files": [
86
+ {
87
+ "path": "button.tsx",
88
+ "type": "registry:ui"
89
+ }
90
+ ]
91
+ }
92
+ ]
93
+ }
94
+ ```
95
+
96
+ If this file is at `registry/ui/registry.json`, then `button.tsx` is read from
97
+ `registry/ui/button.tsx`, and the built item path is emitted relative to the
98
+ root registry.
99
+
100
+ ## Item Definitions
101
+
102
+ Common item fields:
103
+
104
+ ```json
105
+ {
106
+ "name": "login-form",
107
+ "type": "registry:block",
108
+ "title": "Login Form",
109
+ "description": "A login form with email and password fields.",
110
+ "dependencies": ["zod"],
111
+ "registryDependencies": ["button", "input", "label"],
112
+ "files": [
113
+ {
114
+ "path": "blocks/login-form.tsx",
115
+ "type": "registry:block"
116
+ }
117
+ ],
118
+ "cssVars": {
119
+ "light": {
120
+ "brand": "oklch(0.62 0.18 250)"
121
+ },
122
+ "dark": {
123
+ "brand": "oklch(0.72 0.16 250)"
124
+ }
125
+ }
126
+ }
127
+ ```
128
+
129
+ Important fields:
130
+
131
+ - `name`: the installable item name. It is not necessarily a file path.
132
+ - `type`: one of the registry item types, such as `registry:ui`,
133
+ `registry:block`, `registry:lib`, `registry:hook`, `registry:file`,
134
+ `registry:page`, `registry:theme`, `registry:style`, `registry:font`, or
135
+ `registry:item`.
136
+ - `files`: source files copied or generated by the item.
137
+ - `dependencies`: npm runtime dependencies.
138
+ - `devDependencies`: npm development dependencies.
139
+ - `registryDependencies`: other registry items required by this item.
140
+ - `cssVars`, `css`, `tailwind`, `envVars`, and `docs`: optional install-time
141
+ additions.
142
+
143
+ File rules:
144
+
145
+ - File paths are relative to the declaring `registry.json`.
146
+ - `registry:file` and `registry:page` files require a `target`.
147
+ - Do not use remote file URLs in source registry file paths.
148
+ - Keep source files copy-pasteable: no hidden app-only imports.
149
+
150
+ ## Registry Dependencies
151
+
152
+ `registryDependencies` entries are item addresses, not file paths.
153
+
154
+ ```json
155
+ {
156
+ "name": "login-form",
157
+ "type": "registry:block",
158
+ "registryDependencies": ["button", "@acme/input", "acme/ui/card#v1.2.0"],
159
+ "files": [
160
+ {
161
+ "path": "blocks/login-form.tsx",
162
+ "type": "registry:block"
163
+ }
164
+ ]
165
+ }
166
+ ```
167
+
168
+ Dependency rules:
169
+
170
+ - Bare names such as `"button"` mean official shadcn items.
171
+ - Bare names never mean same-registry or same-repository items.
172
+ - Namespaced dependencies use `@namespace/item-name`.
173
+ - GitHub dependencies use `owner/repo/item-name`.
174
+ - Pin GitHub dependencies with `owner/repo/item-name#ref` when needed.
175
+ - Refs are not inherited. If `owner/repo/foo#v2` depends on `bar` from the same
176
+ repo at `v2`, write `owner/repo/bar#v2`.
177
+ - Do not use relative dependencies such as `"./bar"`.
178
+
179
+ ## Address Schemes
180
+
181
+ When reasoning about a registry item string, classify it first.
182
+
183
+ | Address | Scheme | Meaning |
184
+ | ----------------------------------- | --------- | ------------------------------------------------------------ |
185
+ | `button` | shadcn | Official shadcn item named `button`. |
186
+ | `@acme/button` | namespace | Item `button` from configured registry `@acme`. |
187
+ | `@acme/ui/button` | namespace | Item `ui/button` from configured registry `@acme`. |
188
+ | `https://example.com/r/button.json` | url | Built registry item JSON at that URL. |
189
+ | `./button.json` | file | Built registry item JSON on disk. |
190
+ | `acme/ui/button` | github | Item `button` from GitHub repo `acme/ui`. |
191
+ | `acme/ui/forms/login#main` | github | Item `forms/login` from GitHub repo `acme/ui` at ref `main`. |
192
+
193
+ For namespace and GitHub addresses, slashful item names are allowed and are item
194
+ names, not file paths. Addresses ending in `.json` keep file-address
195
+ precedence, so `acme/ui/data/schema.json` is treated as a file path, not a
196
+ GitHub item address.
197
+
198
+ ## GitHub Registries
199
+
200
+ A public GitHub repository can act as a source registry when it has a root
201
+ `registry.json`.
202
+
203
+ ```txt
204
+ owner/repo/item-name[#ref]
205
+ ```
206
+
207
+ Rules:
208
+
209
+ - The first two path segments are GitHub owner and repo.
210
+ - All remaining path segments are the registry item name.
211
+ - The source entrypoint is always root `registry.json`.
212
+ - GitHub registries are source registries consumed directly by the CLI. They do
213
+ not require `shadcn build` or generated item JSON files.
214
+ - `include` follows the same source-registry rules as local registries.
215
+ - Currently, GitHub addresses support public `github.com` repositories only.
216
+ - Private repos and GitHub Enterprise require explicit product decisions.
217
+
218
+ When implementing GitHub registry fetching, resolve refs to a commit SHA before
219
+ reading source files. Do not read moving refs directly from
220
+ `raw.githubusercontent.com`, because branch-like refs can be cached for several
221
+ minutes.
222
+
223
+ Preferred flow:
224
+
225
+ ```txt
226
+ owner/repo[#ref]
227
+ -> resolve ref with git ls-remote
228
+ -> commit SHA
229
+ -> read https://raw.githubusercontent.com/{owner}/{repo}/{sha}/registry.json
230
+ -> read includes and item files from the same SHA
231
+ ```
232
+
233
+ This keeps a command on one consistent repository snapshot.
234
+
235
+ Full 40-character commit SHAs are already stable and can be used directly.
236
+ Branches, tags, and short refs require Git so the CLI can resolve them to a
237
+ commit SHA first.
238
+
239
+ ## Build and Verify
240
+
241
+ Use the CLI to build source registries:
242
+
243
+ ```bash
244
+ npx shadcn@latest build
245
+ npx shadcn@latest build registry.json --output public/r
246
+ ```
247
+
248
+ Use CLI commands to inspect the result:
249
+
250
+ ```bash
251
+ npx shadcn@latest list @acme
252
+ npx shadcn@latest search @acme -q "login"
253
+ npx shadcn@latest view @acme/login-form
254
+ npx shadcn@latest add @acme/login-form --dry-run
255
+ npx shadcn@latest registry validate ./registry.json
256
+ ```
257
+
258
+ Use GitHub addresses directly for public GitHub registries:
259
+
260
+ ```bash
261
+ npx shadcn@latest list owner/repo
262
+ npx shadcn@latest search owner/repo -q "login"
263
+ npx shadcn@latest view owner/repo/item
264
+ npx shadcn@latest add owner/repo/item --dry-run
265
+ npx shadcn@latest registry validate owner/repo
266
+ ```
267
+
268
+ When working on registry implementation in the shadcn/ui codebase:
269
+
270
+ - Keep address parsing pure and testable.
271
+ - Do not add side effects to validators.
272
+ - Preserve existing behavior for official shadcn, namespace, URL, and file
273
+ schemes.
274
+ - Add tests for address parsing, source loading, dependency resolution, list,
275
+ search, view, and add paths.
276
+ - Prefer small source-reader abstractions over a plugin system until there are
277
+ multiple real providers.
@@ -0,0 +1,306 @@
1
+ # Base vs Radix
2
+
3
+ API differences between `base` and `radix`. Check the `base` field from `npx shadcn@latest info`.
4
+
5
+ ## Contents
6
+
7
+ - Composition: asChild vs render
8
+ - Button / trigger as non-button element
9
+ - Select (items prop, placeholder, positioning, multiple, object values)
10
+ - ToggleGroup (type vs multiple)
11
+ - Slider (scalar vs array)
12
+ - Accordion (type and defaultValue)
13
+
14
+ ---
15
+
16
+ ## Composition: asChild (radix) vs render (base)
17
+
18
+ Radix uses `asChild` to replace the default element. Base uses `render`. Don't wrap triggers in extra elements.
19
+
20
+ **Incorrect:**
21
+
22
+ ```tsx
23
+ <DialogTrigger>
24
+ <div>
25
+ <Button>Open</Button>
26
+ </div>
27
+ </DialogTrigger>
28
+ ```
29
+
30
+ **Correct (radix):**
31
+
32
+ ```tsx
33
+ <DialogTrigger asChild>
34
+ <Button>Open</Button>
35
+ </DialogTrigger>
36
+ ```
37
+
38
+ **Correct (base):**
39
+
40
+ ```tsx
41
+ <DialogTrigger render={<Button />}>Open</DialogTrigger>
42
+ ```
43
+
44
+ This applies to all trigger and close components: `DialogTrigger`, `SheetTrigger`, `AlertDialogTrigger`, `DropdownMenuTrigger`, `PopoverTrigger`, `TooltipTrigger`, `CollapsibleTrigger`, `DialogClose`, `SheetClose`, `NavigationMenuLink`, `BreadcrumbLink`, `SidebarMenuButton`, `Badge`, `Item`.
45
+
46
+ ---
47
+
48
+ ## Button / trigger as non-button element (base only)
49
+
50
+ When `render` changes an element to a non-button (`<a>`, `<span>`), add `nativeButton={false}`.
51
+
52
+ **Incorrect (base):** missing `nativeButton={false}`.
53
+
54
+ ```tsx
55
+ <Button render={<a href="/docs" />}>Read the docs</Button>
56
+ ```
57
+
58
+ **Correct (base):**
59
+
60
+ ```tsx
61
+ <Button render={<a href="/docs" />} nativeButton={false}>
62
+ Read the docs
63
+ </Button>
64
+ ```
65
+
66
+ **Correct (radix):**
67
+
68
+ ```tsx
69
+ <Button asChild>
70
+ <a href="/docs">Read the docs</a>
71
+ </Button>
72
+ ```
73
+
74
+ Same for triggers whose `render` is not a `Button`:
75
+
76
+ ```tsx
77
+ // base.
78
+ <PopoverTrigger render={<InputGroupAddon />} nativeButton={false}>
79
+ Pick date
80
+ </PopoverTrigger>
81
+ ```
82
+
83
+ ---
84
+
85
+ ## Select
86
+
87
+ **items prop (base only).** Base requires an `items` prop on the root. Radix uses inline JSX only.
88
+
89
+ **Incorrect (base):**
90
+
91
+ ```tsx
92
+ <Select>
93
+ <SelectTrigger><SelectValue placeholder="Select a fruit" /></SelectTrigger>
94
+ </Select>
95
+ ```
96
+
97
+ **Correct (base):**
98
+
99
+ ```tsx
100
+ const items = [
101
+ { label: "Select a fruit", value: null },
102
+ { label: "Apple", value: "apple" },
103
+ { label: "Banana", value: "banana" },
104
+ ]
105
+
106
+ <Select items={items}>
107
+ <SelectTrigger>
108
+ <SelectValue />
109
+ </SelectTrigger>
110
+ <SelectContent>
111
+ <SelectGroup>
112
+ {items.map((item) => (
113
+ <SelectItem key={item.value} value={item.value}>{item.label}</SelectItem>
114
+ ))}
115
+ </SelectGroup>
116
+ </SelectContent>
117
+ </Select>
118
+ ```
119
+
120
+ **Correct (radix):**
121
+
122
+ ```tsx
123
+ <Select>
124
+ <SelectTrigger>
125
+ <SelectValue placeholder="Select a fruit" />
126
+ </SelectTrigger>
127
+ <SelectContent>
128
+ <SelectGroup>
129
+ <SelectItem value="apple">Apple</SelectItem>
130
+ <SelectItem value="banana">Banana</SelectItem>
131
+ </SelectGroup>
132
+ </SelectContent>
133
+ </Select>
134
+ ```
135
+
136
+ **Placeholder.** Base uses a `{ value: null }` item in the items array. Radix uses `<SelectValue placeholder="...">`.
137
+
138
+ **Content positioning.** Base uses `alignItemWithTrigger`. Radix uses `position`.
139
+
140
+ ```tsx
141
+ // base.
142
+ <SelectContent alignItemWithTrigger={false} side="bottom">
143
+
144
+ // radix.
145
+ <SelectContent position="popper">
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Select — multiple selection and object values (base only)
151
+
152
+ Base supports `multiple`, render-function children on `SelectValue`, and object values with `itemToStringValue`. Radix is single-select with string values only.
153
+
154
+ **Correct (base — multiple selection):**
155
+
156
+ ```tsx
157
+ <Select items={items} multiple defaultValue={[]}>
158
+ <SelectTrigger>
159
+ <SelectValue>
160
+ {(value: string[]) => value.length === 0 ? "Select fruits" : `${value.length} selected`}
161
+ </SelectValue>
162
+ </SelectTrigger>
163
+ ...
164
+ </Select>
165
+ ```
166
+
167
+ **Correct (base — object values):**
168
+
169
+ ```tsx
170
+ <Select defaultValue={plans[0]} itemToStringValue={(plan) => plan.name}>
171
+ <SelectTrigger>
172
+ <SelectValue>{(value) => value.name}</SelectValue>
173
+ </SelectTrigger>
174
+ ...
175
+ </Select>
176
+ ```
177
+
178
+ ---
179
+
180
+ ## ToggleGroup
181
+
182
+ Base uses a `multiple` boolean prop. Radix uses `type="single"` or `type="multiple"`.
183
+
184
+ **Incorrect (base):**
185
+
186
+ ```tsx
187
+ <ToggleGroup type="single" defaultValue="daily">
188
+ <ToggleGroupItem value="daily">Daily</ToggleGroupItem>
189
+ </ToggleGroup>
190
+ ```
191
+
192
+ **Correct (base):**
193
+
194
+ ```tsx
195
+ // Single (no prop needed), defaultValue is always an array.
196
+ <ToggleGroup defaultValue={["daily"]} spacing={2}>
197
+ <ToggleGroupItem value="daily">Daily</ToggleGroupItem>
198
+ <ToggleGroupItem value="weekly">Weekly</ToggleGroupItem>
199
+ </ToggleGroup>
200
+
201
+ // Multi-selection.
202
+ <ToggleGroup multiple>
203
+ <ToggleGroupItem value="bold">Bold</ToggleGroupItem>
204
+ <ToggleGroupItem value="italic">Italic</ToggleGroupItem>
205
+ </ToggleGroup>
206
+ ```
207
+
208
+ **Correct (radix):**
209
+
210
+ ```tsx
211
+ // Single, defaultValue is a string.
212
+ <ToggleGroup type="single" defaultValue="daily" spacing={2}>
213
+ <ToggleGroupItem value="daily">Daily</ToggleGroupItem>
214
+ <ToggleGroupItem value="weekly">Weekly</ToggleGroupItem>
215
+ </ToggleGroup>
216
+
217
+ // Multi-selection.
218
+ <ToggleGroup type="multiple">
219
+ <ToggleGroupItem value="bold">Bold</ToggleGroupItem>
220
+ <ToggleGroupItem value="italic">Italic</ToggleGroupItem>
221
+ </ToggleGroup>
222
+ ```
223
+
224
+ **Controlled single value:**
225
+
226
+ ```tsx
227
+ // base — wrap/unwrap arrays.
228
+ const [value, setValue] = React.useState("normal")
229
+ <ToggleGroup value={[value]} onValueChange={(v) => setValue(v[0])}>
230
+
231
+ // radix — plain string.
232
+ const [value, setValue] = React.useState("normal")
233
+ <ToggleGroup type="single" value={value} onValueChange={setValue}>
234
+ ```
235
+
236
+ ---
237
+
238
+ ## Slider
239
+
240
+ Base accepts a plain number for a single thumb. Radix always requires an array.
241
+
242
+ **Incorrect (base):**
243
+
244
+ ```tsx
245
+ <Slider defaultValue={[50]} max={100} step={1} />
246
+ ```
247
+
248
+ **Correct (base):**
249
+
250
+ ```tsx
251
+ <Slider defaultValue={50} max={100} step={1} />
252
+ ```
253
+
254
+ **Correct (radix):**
255
+
256
+ ```tsx
257
+ <Slider defaultValue={[50]} max={100} step={1} />
258
+ ```
259
+
260
+ Both use arrays for range sliders. Controlled `onValueChange` in base may need a cast:
261
+
262
+ ```tsx
263
+ // base.
264
+ const [value, setValue] = React.useState([0.3, 0.7])
265
+ <Slider value={value} onValueChange={(v) => setValue(v as number[])} />
266
+
267
+ // radix.
268
+ const [value, setValue] = React.useState([0.3, 0.7])
269
+ <Slider value={value} onValueChange={setValue} />
270
+ ```
271
+
272
+ ---
273
+
274
+ ## Accordion
275
+
276
+ Radix requires `type="single"` or `type="multiple"` and supports `collapsible`. `defaultValue` is a string. Base uses no `type` prop, uses `multiple` boolean, and `defaultValue` is always an array.
277
+
278
+ **Incorrect (base):**
279
+
280
+ ```tsx
281
+ <Accordion type="single" collapsible defaultValue="item-1">
282
+ <AccordionItem value="item-1">...</AccordionItem>
283
+ </Accordion>
284
+ ```
285
+
286
+ **Correct (base):**
287
+
288
+ ```tsx
289
+ <Accordion defaultValue={["item-1"]}>
290
+ <AccordionItem value="item-1">...</AccordionItem>
291
+ </Accordion>
292
+
293
+ // Multi-select.
294
+ <Accordion multiple defaultValue={["item-1", "item-2"]}>
295
+ <AccordionItem value="item-1">...</AccordionItem>
296
+ <AccordionItem value="item-2">...</AccordionItem>
297
+ </Accordion>
298
+ ```
299
+
300
+ **Correct (radix):**
301
+
302
+ ```tsx
303
+ <Accordion type="single" collapsible defaultValue="item-1">
304
+ <AccordionItem value="item-1">...</AccordionItem>
305
+ </Accordion>
306
+ ```