pi-cloudflare 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 (410) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +67 -0
  3. package/bin/setup.mjs +103 -0
  4. package/dist/auth-flow.d.ts +15 -0
  5. package/dist/auth-flow.d.ts.map +1 -0
  6. package/dist/auth-flow.js +90 -0
  7. package/dist/auth-flow.js.map +1 -0
  8. package/dist/client.d.ts +18 -0
  9. package/dist/client.d.ts.map +1 -0
  10. package/dist/client.js +47 -0
  11. package/dist/client.js.map +1 -0
  12. package/dist/config.d.ts +13 -0
  13. package/dist/config.d.ts.map +1 -0
  14. package/dist/config.js +10 -0
  15. package/dist/config.js.map +1 -0
  16. package/dist/index.d.ts +24 -0
  17. package/dist/index.d.ts.map +1 -0
  18. package/dist/index.js +109 -0
  19. package/dist/index.js.map +1 -0
  20. package/dist/oauth.d.ts +44 -0
  21. package/dist/oauth.d.ts.map +1 -0
  22. package/dist/oauth.js +135 -0
  23. package/dist/oauth.js.map +1 -0
  24. package/dist/proxy.d.ts +29 -0
  25. package/dist/proxy.d.ts.map +1 -0
  26. package/dist/proxy.js +39 -0
  27. package/dist/proxy.js.map +1 -0
  28. package/dist/servers.d.ts +19 -0
  29. package/dist/servers.d.ts.map +1 -0
  30. package/dist/servers.js +40 -0
  31. package/dist/servers.js.map +1 -0
  32. package/dist/token-store.d.ts +23 -0
  33. package/dist/token-store.d.ts.map +1 -0
  34. package/dist/token-store.js +47 -0
  35. package/dist/token-store.js.map +1 -0
  36. package/package.json +67 -0
  37. package/skills/agents-sdk/SKILL.md +221 -0
  38. package/skills/agents-sdk/references/browse-the-web.md +63 -0
  39. package/skills/agents-sdk/references/callable.md +92 -0
  40. package/skills/agents-sdk/references/client-sdk.md +110 -0
  41. package/skills/agents-sdk/references/codemode.md +110 -0
  42. package/skills/agents-sdk/references/configuration.md +72 -0
  43. package/skills/agents-sdk/references/durable-execution.md +51 -0
  44. package/skills/agents-sdk/references/email.md +146 -0
  45. package/skills/agents-sdk/references/human-in-the-loop.md +67 -0
  46. package/skills/agents-sdk/references/mcp.md +188 -0
  47. package/skills/agents-sdk/references/observability.md +44 -0
  48. package/skills/agents-sdk/references/queue-retries.md +79 -0
  49. package/skills/agents-sdk/references/routing.md +75 -0
  50. package/skills/agents-sdk/references/server-driven-messages.md +63 -0
  51. package/skills/agents-sdk/references/state-scheduling.md +171 -0
  52. package/skills/agents-sdk/references/streaming-chat.md +198 -0
  53. package/skills/agents-sdk/references/think.md +112 -0
  54. package/skills/agents-sdk/references/voice.md +68 -0
  55. package/skills/agents-sdk/references/webhooks-push.md +86 -0
  56. package/skills/agents-sdk/references/workflows.md +132 -0
  57. package/skills/cloudflare/SKILL.md +248 -0
  58. package/skills/cloudflare/references/agents-sdk/README.md +89 -0
  59. package/skills/cloudflare/references/agents-sdk/api.md +190 -0
  60. package/skills/cloudflare/references/agents-sdk/configuration.md +182 -0
  61. package/skills/cloudflare/references/agents-sdk/gotchas.md +158 -0
  62. package/skills/cloudflare/references/agents-sdk/patterns.md +192 -0
  63. package/skills/cloudflare/references/ai-gateway/README.md +175 -0
  64. package/skills/cloudflare/references/ai-gateway/configuration.md +111 -0
  65. package/skills/cloudflare/references/ai-gateway/dynamic-routing.md +82 -0
  66. package/skills/cloudflare/references/ai-gateway/features.md +96 -0
  67. package/skills/cloudflare/references/ai-gateway/sdk-integration.md +114 -0
  68. package/skills/cloudflare/references/ai-gateway/troubleshooting.md +88 -0
  69. package/skills/cloudflare/references/ai-search/README.md +138 -0
  70. package/skills/cloudflare/references/ai-search/api.md +87 -0
  71. package/skills/cloudflare/references/ai-search/configuration.md +88 -0
  72. package/skills/cloudflare/references/ai-search/gotchas.md +81 -0
  73. package/skills/cloudflare/references/ai-search/patterns.md +85 -0
  74. package/skills/cloudflare/references/analytics-engine/README.md +94 -0
  75. package/skills/cloudflare/references/analytics-engine/api.md +112 -0
  76. package/skills/cloudflare/references/analytics-engine/configuration.md +112 -0
  77. package/skills/cloudflare/references/analytics-engine/gotchas.md +85 -0
  78. package/skills/cloudflare/references/analytics-engine/patterns.md +83 -0
  79. package/skills/cloudflare/references/api/README.md +66 -0
  80. package/skills/cloudflare/references/api/api.md +204 -0
  81. package/skills/cloudflare/references/api/configuration.md +160 -0
  82. package/skills/cloudflare/references/api/gotchas.md +225 -0
  83. package/skills/cloudflare/references/api/patterns.md +204 -0
  84. package/skills/cloudflare/references/api-shield/README.md +44 -0
  85. package/skills/cloudflare/references/api-shield/api.md +141 -0
  86. package/skills/cloudflare/references/api-shield/configuration.md +192 -0
  87. package/skills/cloudflare/references/api-shield/gotchas.md +125 -0
  88. package/skills/cloudflare/references/api-shield/patterns.md +180 -0
  89. package/skills/cloudflare/references/argo-smart-routing/README.md +90 -0
  90. package/skills/cloudflare/references/argo-smart-routing/api.md +240 -0
  91. package/skills/cloudflare/references/argo-smart-routing/configuration.md +197 -0
  92. package/skills/cloudflare/references/argo-smart-routing/gotchas.md +111 -0
  93. package/skills/cloudflare/references/argo-smart-routing/patterns.md +104 -0
  94. package/skills/cloudflare/references/artifacts/README.md +79 -0
  95. package/skills/cloudflare/references/artifacts/api.md +128 -0
  96. package/skills/cloudflare/references/artifacts/configuration.md +92 -0
  97. package/skills/cloudflare/references/bindings/README.md +122 -0
  98. package/skills/cloudflare/references/bindings/api.md +203 -0
  99. package/skills/cloudflare/references/bindings/configuration.md +188 -0
  100. package/skills/cloudflare/references/bindings/gotchas.md +208 -0
  101. package/skills/cloudflare/references/bindings/patterns.md +200 -0
  102. package/skills/cloudflare/references/bot-management/README.md +94 -0
  103. package/skills/cloudflare/references/bot-management/api.md +169 -0
  104. package/skills/cloudflare/references/bot-management/configuration.md +163 -0
  105. package/skills/cloudflare/references/bot-management/gotchas.md +114 -0
  106. package/skills/cloudflare/references/bot-management/patterns.md +182 -0
  107. package/skills/cloudflare/references/browser-rendering/README.md +78 -0
  108. package/skills/cloudflare/references/browser-rendering/api.md +108 -0
  109. package/skills/cloudflare/references/browser-rendering/configuration.md +78 -0
  110. package/skills/cloudflare/references/browser-rendering/gotchas.md +88 -0
  111. package/skills/cloudflare/references/browser-rendering/patterns.md +91 -0
  112. package/skills/cloudflare/references/c3/README.md +111 -0
  113. package/skills/cloudflare/references/c3/api.md +71 -0
  114. package/skills/cloudflare/references/c3/configuration.md +81 -0
  115. package/skills/cloudflare/references/c3/gotchas.md +92 -0
  116. package/skills/cloudflare/references/c3/patterns.md +82 -0
  117. package/skills/cloudflare/references/cache-reserve/README.md +147 -0
  118. package/skills/cloudflare/references/cache-reserve/api.md +194 -0
  119. package/skills/cloudflare/references/cache-reserve/configuration.md +169 -0
  120. package/skills/cloudflare/references/cache-reserve/gotchas.md +132 -0
  121. package/skills/cloudflare/references/cache-reserve/patterns.md +197 -0
  122. package/skills/cloudflare/references/containers/README.md +85 -0
  123. package/skills/cloudflare/references/containers/api.md +187 -0
  124. package/skills/cloudflare/references/containers/configuration.md +188 -0
  125. package/skills/cloudflare/references/containers/gotchas.md +178 -0
  126. package/skills/cloudflare/references/containers/patterns.md +202 -0
  127. package/skills/cloudflare/references/cron-triggers/README.md +99 -0
  128. package/skills/cloudflare/references/cron-triggers/api.md +196 -0
  129. package/skills/cloudflare/references/cron-triggers/configuration.md +180 -0
  130. package/skills/cloudflare/references/cron-triggers/gotchas.md +199 -0
  131. package/skills/cloudflare/references/cron-triggers/patterns.md +190 -0
  132. package/skills/cloudflare/references/d1/README.md +133 -0
  133. package/skills/cloudflare/references/d1/api.md +196 -0
  134. package/skills/cloudflare/references/d1/configuration.md +191 -0
  135. package/skills/cloudflare/references/d1/gotchas.md +98 -0
  136. package/skills/cloudflare/references/d1/patterns.md +189 -0
  137. package/skills/cloudflare/references/ddos/README.md +41 -0
  138. package/skills/cloudflare/references/ddos/api.md +164 -0
  139. package/skills/cloudflare/references/ddos/configuration.md +93 -0
  140. package/skills/cloudflare/references/ddos/gotchas.md +107 -0
  141. package/skills/cloudflare/references/ddos/patterns.md +174 -0
  142. package/skills/cloudflare/references/do-storage/README.md +75 -0
  143. package/skills/cloudflare/references/do-storage/api.md +102 -0
  144. package/skills/cloudflare/references/do-storage/configuration.md +112 -0
  145. package/skills/cloudflare/references/do-storage/gotchas.md +150 -0
  146. package/skills/cloudflare/references/do-storage/patterns.md +194 -0
  147. package/skills/cloudflare/references/do-storage/testing.md +183 -0
  148. package/skills/cloudflare/references/durable-objects/README.md +185 -0
  149. package/skills/cloudflare/references/durable-objects/api.md +187 -0
  150. package/skills/cloudflare/references/durable-objects/configuration.md +160 -0
  151. package/skills/cloudflare/references/durable-objects/gotchas.md +197 -0
  152. package/skills/cloudflare/references/durable-objects/patterns.md +201 -0
  153. package/skills/cloudflare/references/email-routing/README.md +89 -0
  154. package/skills/cloudflare/references/email-routing/api.md +195 -0
  155. package/skills/cloudflare/references/email-routing/configuration.md +186 -0
  156. package/skills/cloudflare/references/email-routing/gotchas.md +196 -0
  157. package/skills/cloudflare/references/email-routing/patterns.md +229 -0
  158. package/skills/cloudflare/references/email-workers/README.md +151 -0
  159. package/skills/cloudflare/references/email-workers/api.md +237 -0
  160. package/skills/cloudflare/references/email-workers/configuration.md +112 -0
  161. package/skills/cloudflare/references/email-workers/gotchas.md +125 -0
  162. package/skills/cloudflare/references/email-workers/patterns.md +102 -0
  163. package/skills/cloudflare/references/flagship/README.md +59 -0
  164. package/skills/cloudflare/references/flagship/api.md +390 -0
  165. package/skills/cloudflare/references/flagship/configuration.md +202 -0
  166. package/skills/cloudflare/references/flagship/gotchas.md +178 -0
  167. package/skills/cloudflare/references/flagship/patterns.md +469 -0
  168. package/skills/cloudflare/references/graphql-api/README.md +147 -0
  169. package/skills/cloudflare/references/graphql-api/api.md +175 -0
  170. package/skills/cloudflare/references/graphql-api/configuration.md +118 -0
  171. package/skills/cloudflare/references/graphql-api/gotchas.md +110 -0
  172. package/skills/cloudflare/references/graphql-api/patterns.md +225 -0
  173. package/skills/cloudflare/references/hyperdrive/README.md +82 -0
  174. package/skills/cloudflare/references/hyperdrive/api.md +143 -0
  175. package/skills/cloudflare/references/hyperdrive/configuration.md +159 -0
  176. package/skills/cloudflare/references/hyperdrive/gotchas.md +77 -0
  177. package/skills/cloudflare/references/hyperdrive/patterns.md +190 -0
  178. package/skills/cloudflare/references/images/README.md +61 -0
  179. package/skills/cloudflare/references/images/api.md +96 -0
  180. package/skills/cloudflare/references/images/configuration.md +211 -0
  181. package/skills/cloudflare/references/images/gotchas.md +99 -0
  182. package/skills/cloudflare/references/images/patterns.md +115 -0
  183. package/skills/cloudflare/references/kv/README.md +89 -0
  184. package/skills/cloudflare/references/kv/api.md +160 -0
  185. package/skills/cloudflare/references/kv/configuration.md +144 -0
  186. package/skills/cloudflare/references/kv/gotchas.md +131 -0
  187. package/skills/cloudflare/references/kv/patterns.md +196 -0
  188. package/skills/cloudflare/references/miniflare/README.md +105 -0
  189. package/skills/cloudflare/references/miniflare/api.md +187 -0
  190. package/skills/cloudflare/references/miniflare/configuration.md +173 -0
  191. package/skills/cloudflare/references/miniflare/gotchas.md +160 -0
  192. package/skills/cloudflare/references/miniflare/patterns.md +181 -0
  193. package/skills/cloudflare/references/network-interconnect/README.md +99 -0
  194. package/skills/cloudflare/references/network-interconnect/api.md +199 -0
  195. package/skills/cloudflare/references/network-interconnect/configuration.md +114 -0
  196. package/skills/cloudflare/references/network-interconnect/gotchas.md +165 -0
  197. package/skills/cloudflare/references/network-interconnect/patterns.md +166 -0
  198. package/skills/cloudflare/references/observability/README.md +88 -0
  199. package/skills/cloudflare/references/observability/api.md +164 -0
  200. package/skills/cloudflare/references/observability/configuration.md +169 -0
  201. package/skills/cloudflare/references/observability/gotchas.md +115 -0
  202. package/skills/cloudflare/references/observability/patterns.md +105 -0
  203. package/skills/cloudflare/references/pages/README.md +88 -0
  204. package/skills/cloudflare/references/pages/api.md +204 -0
  205. package/skills/cloudflare/references/pages/configuration.md +201 -0
  206. package/skills/cloudflare/references/pages/gotchas.md +203 -0
  207. package/skills/cloudflare/references/pages/patterns.md +204 -0
  208. package/skills/cloudflare/references/pages-functions/README.md +98 -0
  209. package/skills/cloudflare/references/pages-functions/api.md +143 -0
  210. package/skills/cloudflare/references/pages-functions/configuration.md +122 -0
  211. package/skills/cloudflare/references/pages-functions/gotchas.md +94 -0
  212. package/skills/cloudflare/references/pages-functions/patterns.md +137 -0
  213. package/skills/cloudflare/references/pipelines/README.md +90 -0
  214. package/skills/cloudflare/references/pipelines/api.md +124 -0
  215. package/skills/cloudflare/references/pipelines/configuration.md +155 -0
  216. package/skills/cloudflare/references/pipelines/gotchas.md +58 -0
  217. package/skills/cloudflare/references/pipelines/patterns.md +130 -0
  218. package/skills/cloudflare/references/pulumi/README.md +100 -0
  219. package/skills/cloudflare/references/pulumi/api.md +200 -0
  220. package/skills/cloudflare/references/pulumi/configuration.md +198 -0
  221. package/skills/cloudflare/references/pulumi/gotchas.md +181 -0
  222. package/skills/cloudflare/references/pulumi/patterns.md +191 -0
  223. package/skills/cloudflare/references/queues/README.md +96 -0
  224. package/skills/cloudflare/references/queues/api.md +206 -0
  225. package/skills/cloudflare/references/queues/configuration.md +144 -0
  226. package/skills/cloudflare/references/queues/gotchas.md +206 -0
  227. package/skills/cloudflare/references/queues/patterns.md +220 -0
  228. package/skills/cloudflare/references/r2/README.md +95 -0
  229. package/skills/cloudflare/references/r2/api.md +200 -0
  230. package/skills/cloudflare/references/r2/configuration.md +165 -0
  231. package/skills/cloudflare/references/r2/gotchas.md +190 -0
  232. package/skills/cloudflare/references/r2/patterns.md +193 -0
  233. package/skills/cloudflare/references/r2-data-catalog/README.md +75 -0
  234. package/skills/cloudflare/references/r2-data-catalog/api.md +122 -0
  235. package/skills/cloudflare/references/r2-data-catalog/configuration.md +98 -0
  236. package/skills/cloudflare/references/r2-data-catalog/gotchas.md +55 -0
  237. package/skills/cloudflare/references/r2-data-catalog/patterns.md +122 -0
  238. package/skills/cloudflare/references/r2-sql/README.md +64 -0
  239. package/skills/cloudflare/references/r2-sql/api.md +121 -0
  240. package/skills/cloudflare/references/r2-sql/configuration.md +50 -0
  241. package/skills/cloudflare/references/r2-sql/gotchas.md +39 -0
  242. package/skills/cloudflare/references/r2-sql/patterns.md +118 -0
  243. package/skills/cloudflare/references/realtime-sfu/README.md +65 -0
  244. package/skills/cloudflare/references/realtime-sfu/api.md +158 -0
  245. package/skills/cloudflare/references/realtime-sfu/configuration.md +137 -0
  246. package/skills/cloudflare/references/realtime-sfu/gotchas.md +133 -0
  247. package/skills/cloudflare/references/realtime-sfu/patterns.md +174 -0
  248. package/skills/cloudflare/references/realtimekit/README.md +113 -0
  249. package/skills/cloudflare/references/realtimekit/api.md +212 -0
  250. package/skills/cloudflare/references/realtimekit/configuration.md +203 -0
  251. package/skills/cloudflare/references/realtimekit/gotchas.md +169 -0
  252. package/skills/cloudflare/references/realtimekit/patterns.md +223 -0
  253. package/skills/cloudflare/references/sandbox/README.md +96 -0
  254. package/skills/cloudflare/references/sandbox/api.md +198 -0
  255. package/skills/cloudflare/references/sandbox/configuration.md +143 -0
  256. package/skills/cloudflare/references/sandbox/gotchas.md +194 -0
  257. package/skills/cloudflare/references/sandbox/patterns.md +201 -0
  258. package/skills/cloudflare/references/secrets-store/README.md +74 -0
  259. package/skills/cloudflare/references/secrets-store/api.md +200 -0
  260. package/skills/cloudflare/references/secrets-store/configuration.md +185 -0
  261. package/skills/cloudflare/references/secrets-store/gotchas.md +97 -0
  262. package/skills/cloudflare/references/secrets-store/patterns.md +207 -0
  263. package/skills/cloudflare/references/smart-placement/README.md +138 -0
  264. package/skills/cloudflare/references/smart-placement/api.md +183 -0
  265. package/skills/cloudflare/references/smart-placement/configuration.md +196 -0
  266. package/skills/cloudflare/references/smart-placement/gotchas.md +174 -0
  267. package/skills/cloudflare/references/smart-placement/patterns.md +183 -0
  268. package/skills/cloudflare/references/snippets/README.md +68 -0
  269. package/skills/cloudflare/references/snippets/api.md +198 -0
  270. package/skills/cloudflare/references/snippets/configuration.md +227 -0
  271. package/skills/cloudflare/references/snippets/gotchas.md +86 -0
  272. package/skills/cloudflare/references/snippets/patterns.md +135 -0
  273. package/skills/cloudflare/references/spectrum/README.md +52 -0
  274. package/skills/cloudflare/references/spectrum/api.md +181 -0
  275. package/skills/cloudflare/references/spectrum/configuration.md +194 -0
  276. package/skills/cloudflare/references/spectrum/gotchas.md +145 -0
  277. package/skills/cloudflare/references/spectrum/patterns.md +196 -0
  278. package/skills/cloudflare/references/static-assets/README.md +65 -0
  279. package/skills/cloudflare/references/static-assets/api.md +199 -0
  280. package/skills/cloudflare/references/static-assets/configuration.md +186 -0
  281. package/skills/cloudflare/references/static-assets/gotchas.md +162 -0
  282. package/skills/cloudflare/references/static-assets/patterns.md +189 -0
  283. package/skills/cloudflare/references/stream/README.md +114 -0
  284. package/skills/cloudflare/references/stream/api-live.md +195 -0
  285. package/skills/cloudflare/references/stream/api.md +199 -0
  286. package/skills/cloudflare/references/stream/configuration.md +141 -0
  287. package/skills/cloudflare/references/stream/gotchas.md +130 -0
  288. package/skills/cloudflare/references/stream/patterns.md +184 -0
  289. package/skills/cloudflare/references/tail-workers/README.md +89 -0
  290. package/skills/cloudflare/references/tail-workers/api.md +200 -0
  291. package/skills/cloudflare/references/tail-workers/configuration.md +176 -0
  292. package/skills/cloudflare/references/tail-workers/gotchas.md +192 -0
  293. package/skills/cloudflare/references/tail-workers/patterns.md +180 -0
  294. package/skills/cloudflare/references/terraform/README.md +102 -0
  295. package/skills/cloudflare/references/terraform/api.md +178 -0
  296. package/skills/cloudflare/references/terraform/configuration.md +197 -0
  297. package/skills/cloudflare/references/terraform/gotchas.md +150 -0
  298. package/skills/cloudflare/references/terraform/patterns.md +174 -0
  299. package/skills/cloudflare/references/tunnel/README.md +129 -0
  300. package/skills/cloudflare/references/tunnel/api.md +193 -0
  301. package/skills/cloudflare/references/tunnel/configuration.md +157 -0
  302. package/skills/cloudflare/references/tunnel/gotchas.md +147 -0
  303. package/skills/cloudflare/references/tunnel/networking.md +168 -0
  304. package/skills/cloudflare/references/tunnel/patterns.md +192 -0
  305. package/skills/cloudflare/references/turn/README.md +82 -0
  306. package/skills/cloudflare/references/turn/api.md +239 -0
  307. package/skills/cloudflare/references/turn/configuration.md +179 -0
  308. package/skills/cloudflare/references/turn/gotchas.md +231 -0
  309. package/skills/cloudflare/references/turn/patterns.md +213 -0
  310. package/skills/cloudflare/references/turnstile/README.md +99 -0
  311. package/skills/cloudflare/references/turnstile/api.md +240 -0
  312. package/skills/cloudflare/references/turnstile/configuration.md +222 -0
  313. package/skills/cloudflare/references/turnstile/gotchas.md +218 -0
  314. package/skills/cloudflare/references/turnstile/patterns.md +193 -0
  315. package/skills/cloudflare/references/vectorize/README.md +133 -0
  316. package/skills/cloudflare/references/vectorize/api.md +88 -0
  317. package/skills/cloudflare/references/vectorize/configuration.md +88 -0
  318. package/skills/cloudflare/references/vectorize/gotchas.md +76 -0
  319. package/skills/cloudflare/references/vectorize/patterns.md +90 -0
  320. package/skills/cloudflare/references/waf/README.md +113 -0
  321. package/skills/cloudflare/references/waf/api.md +202 -0
  322. package/skills/cloudflare/references/waf/configuration.md +203 -0
  323. package/skills/cloudflare/references/waf/gotchas.md +204 -0
  324. package/skills/cloudflare/references/waf/patterns.md +197 -0
  325. package/skills/cloudflare/references/web-analytics/README.md +141 -0
  326. package/skills/cloudflare/references/web-analytics/configuration.md +76 -0
  327. package/skills/cloudflare/references/web-analytics/gotchas.md +82 -0
  328. package/skills/cloudflare/references/web-analytics/integration.md +60 -0
  329. package/skills/cloudflare/references/web-analytics/patterns.md +91 -0
  330. package/skills/cloudflare/references/workerd/README.md +78 -0
  331. package/skills/cloudflare/references/workerd/api.md +185 -0
  332. package/skills/cloudflare/references/workerd/configuration.md +183 -0
  333. package/skills/cloudflare/references/workerd/gotchas.md +139 -0
  334. package/skills/cloudflare/references/workerd/patterns.md +192 -0
  335. package/skills/cloudflare/references/workers/README.md +108 -0
  336. package/skills/cloudflare/references/workers/api.md +195 -0
  337. package/skills/cloudflare/references/workers/configuration.md +185 -0
  338. package/skills/cloudflare/references/workers/frameworks.md +197 -0
  339. package/skills/cloudflare/references/workers/gotchas.md +137 -0
  340. package/skills/cloudflare/references/workers/patterns.md +198 -0
  341. package/skills/cloudflare/references/workers-ai/README.md +197 -0
  342. package/skills/cloudflare/references/workers-ai/api.md +112 -0
  343. package/skills/cloudflare/references/workers-ai/configuration.md +97 -0
  344. package/skills/cloudflare/references/workers-ai/gotchas.md +114 -0
  345. package/skills/cloudflare/references/workers-ai/patterns.md +120 -0
  346. package/skills/cloudflare/references/workers-for-platforms/README.md +89 -0
  347. package/skills/cloudflare/references/workers-for-platforms/api.md +196 -0
  348. package/skills/cloudflare/references/workers-for-platforms/configuration.md +167 -0
  349. package/skills/cloudflare/references/workers-for-platforms/gotchas.md +134 -0
  350. package/skills/cloudflare/references/workers-for-platforms/patterns.md +188 -0
  351. package/skills/cloudflare/references/workers-playground/README.md +127 -0
  352. package/skills/cloudflare/references/workers-playground/api.md +101 -0
  353. package/skills/cloudflare/references/workers-playground/configuration.md +163 -0
  354. package/skills/cloudflare/references/workers-playground/gotchas.md +88 -0
  355. package/skills/cloudflare/references/workers-playground/patterns.md +132 -0
  356. package/skills/cloudflare/references/workers-vpc/README.md +127 -0
  357. package/skills/cloudflare/references/workers-vpc/api.md +202 -0
  358. package/skills/cloudflare/references/workers-vpc/configuration.md +147 -0
  359. package/skills/cloudflare/references/workers-vpc/gotchas.md +167 -0
  360. package/skills/cloudflare/references/workers-vpc/patterns.md +209 -0
  361. package/skills/cloudflare/references/workflows/README.md +77 -0
  362. package/skills/cloudflare/references/workflows/api.md +218 -0
  363. package/skills/cloudflare/references/workflows/configuration.md +152 -0
  364. package/skills/cloudflare/references/workflows/gotchas.md +90 -0
  365. package/skills/cloudflare/references/workflows/patterns.md +175 -0
  366. package/skills/cloudflare/references/wrangler/README.md +135 -0
  367. package/skills/cloudflare/references/wrangler/api.md +188 -0
  368. package/skills/cloudflare/references/wrangler/configuration.md +197 -0
  369. package/skills/cloudflare/references/wrangler/gotchas.md +197 -0
  370. package/skills/cloudflare/references/wrangler/patterns.md +209 -0
  371. package/skills/cloudflare/references/zaraz/IMPLEMENTATION_SUMMARY.md +121 -0
  372. package/skills/cloudflare/references/zaraz/README.md +111 -0
  373. package/skills/cloudflare/references/zaraz/api.md +112 -0
  374. package/skills/cloudflare/references/zaraz/configuration.md +90 -0
  375. package/skills/cloudflare/references/zaraz/gotchas.md +81 -0
  376. package/skills/cloudflare/references/zaraz/patterns.md +74 -0
  377. package/skills/cloudflare-email-service/SKILL.md +103 -0
  378. package/skills/cloudflare-email-service/references/cli-and-mcp.md +125 -0
  379. package/skills/cloudflare-email-service/references/deliverability.md +285 -0
  380. package/skills/cloudflare-email-service/references/rest-api.md +184 -0
  381. package/skills/cloudflare-email-service/references/routing.md +199 -0
  382. package/skills/cloudflare-email-service/references/sending.md +252 -0
  383. package/skills/cloudflare-one/SKILL.md +176 -0
  384. package/skills/cloudflare-one-migrations/SKILL.md +110 -0
  385. package/skills/durable-objects/SKILL.md +186 -0
  386. package/skills/durable-objects/references/rules.md +295 -0
  387. package/skills/durable-objects/references/testing.md +264 -0
  388. package/skills/durable-objects/references/workers.md +346 -0
  389. package/skills/sandbox-migrate-to-next/SKILL.md +185 -0
  390. package/skills/sandbox-next/SKILL.md +91 -0
  391. package/skills/sandbox-next/references/api-quick-ref.md +94 -0
  392. package/skills/sandbox-next/references/examples.md +15 -0
  393. package/skills/sandbox-stable/SKILL.md +110 -0
  394. package/skills/turnstile-spin/README.md +51 -0
  395. package/skills/turnstile-spin/SKILL.md +330 -0
  396. package/skills/turnstile-spin/references/astro.md +199 -0
  397. package/skills/turnstile-spin/references/hugo.md +114 -0
  398. package/skills/turnstile-spin/references/nextjs-app.md +261 -0
  399. package/skills/turnstile-spin/references/nextjs-pages.md +82 -0
  400. package/skills/turnstile-spin/references/sveltekit.md +191 -0
  401. package/skills/turnstile-spin/references/vanilla-html.md +157 -0
  402. package/skills/turnstile-spin/scripts/auth-probe.sh +285 -0
  403. package/skills/turnstile-spin/scripts/persist-skill.sh +114 -0
  404. package/skills/turnstile-spin/scripts/validate.sh +137 -0
  405. package/skills/turnstile-spin/scripts/widget-create.sh +121 -0
  406. package/skills/turnstile-spin/tests/validation.md +62 -0
  407. package/skills/workers-best-practices/SKILL.md +127 -0
  408. package/skills/workers-best-practices/references/review.md +174 -0
  409. package/skills/workers-best-practices/references/rules.md +467 -0
  410. package/skills/wrangler/SKILL.md +922 -0
@@ -0,0 +1,346 @@
1
+ # Cloudflare Workers Best Practices
2
+
3
+ High-level guidance for Workers that invoke Durable Objects.
4
+
5
+ ## Wrangler Configuration
6
+
7
+ ### wrangler.jsonc (Recommended)
8
+
9
+ ```jsonc
10
+ {
11
+ "$schema": "node_modules/wrangler/config-schema.json",
12
+ "name": "my-worker",
13
+ "main": "src/index.ts",
14
+ "compatibility_date": "2024-12-01",
15
+ "compatibility_flags": ["nodejs_compat"],
16
+
17
+ "durable_objects": {
18
+ "bindings": [
19
+ { "name": "CHAT_ROOM", "class_name": "ChatRoom" },
20
+ { "name": "USER_SESSION", "class_name": "UserSession" }
21
+ ]
22
+ },
23
+
24
+ "migrations": [
25
+ { "tag": "v1", "new_sqlite_classes": ["ChatRoom", "UserSession"] }
26
+ ],
27
+
28
+ // Environment variables
29
+ "vars": {
30
+ "ENVIRONMENT": "production"
31
+ },
32
+
33
+ // KV namespaces
34
+ "kv_namespaces": [
35
+ { "binding": "CONFIG", "id": "abc123" }
36
+ ],
37
+
38
+ // R2 buckets
39
+ "r2_buckets": [
40
+ { "binding": "UPLOADS", "bucket_name": "my-uploads" }
41
+ ],
42
+
43
+ // D1 databases
44
+ "d1_databases": [
45
+ { "binding": "DB", "database_id": "xyz789" }
46
+ ]
47
+ }
48
+ ```
49
+
50
+ ### wrangler.toml (Alternative)
51
+
52
+ ```toml
53
+ name = "my-worker"
54
+ main = "src/index.ts"
55
+ compatibility_date = "2024-12-01"
56
+ compatibility_flags = ["nodejs_compat"]
57
+
58
+ [[durable_objects.bindings]]
59
+ name = "CHAT_ROOM"
60
+ class_name = "ChatRoom"
61
+
62
+ [[migrations]]
63
+ tag = "v1"
64
+ new_sqlite_classes = ["ChatRoom"]
65
+
66
+ [vars]
67
+ ENVIRONMENT = "production"
68
+ ```
69
+
70
+ ## TypeScript Types
71
+
72
+ ### Environment Interface
73
+
74
+ ```typescript
75
+ // src/types.ts
76
+ import { ChatRoom } from "./durable-objects/chat-room";
77
+ import { UserSession } from "./durable-objects/user-session";
78
+
79
+ export interface Env {
80
+ // Durable Objects
81
+ CHAT_ROOM: DurableObjectNamespace<ChatRoom>;
82
+ USER_SESSION: DurableObjectNamespace<UserSession>;
83
+
84
+ // KV
85
+ CONFIG: KVNamespace;
86
+
87
+ // R2
88
+ UPLOADS: R2Bucket;
89
+
90
+ // D1
91
+ DB: D1Database;
92
+
93
+ // Environment variables
94
+ ENVIRONMENT: string;
95
+ API_KEY: string; // From secrets
96
+ }
97
+ ```
98
+
99
+ ### Export Durable Object Classes
100
+
101
+ ```typescript
102
+ // src/index.ts
103
+ export { ChatRoom } from "./durable-objects/chat-room";
104
+ export { UserSession } from "./durable-objects/user-session";
105
+
106
+ export default {
107
+ async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
108
+ // Worker handler
109
+ },
110
+ };
111
+ ```
112
+
113
+ ## Worker Handler Pattern
114
+
115
+ ```typescript
116
+ export default {
117
+ async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
118
+ const url = new URL(request.url);
119
+
120
+ try {
121
+ // Route to appropriate handler
122
+ if (url.pathname.startsWith("/api/rooms")) {
123
+ return handleRooms(request, env);
124
+ }
125
+ if (url.pathname.startsWith("/api/users")) {
126
+ return handleUsers(request, env);
127
+ }
128
+
129
+ return new Response("Not Found", { status: 404 });
130
+ } catch (error) {
131
+ console.error("Request failed:", error);
132
+ return new Response("Internal Server Error", { status: 500 });
133
+ }
134
+ },
135
+ };
136
+
137
+ async function handleRooms(request: Request, env: Env): Promise<Response> {
138
+ const url = new URL(request.url);
139
+ const roomId = url.searchParams.get("room");
140
+
141
+ if (!roomId) {
142
+ return Response.json({ error: "Missing room parameter" }, { status: 400 });
143
+ }
144
+
145
+ const stub = env.CHAT_ROOM.getByName(roomId);
146
+
147
+ if (request.method === "POST") {
148
+ const body = await request.json<{ userId: string; message: string }>();
149
+ const result = await stub.sendMessage(body.userId, body.message);
150
+ return Response.json(result);
151
+ }
152
+
153
+ const messages = await stub.getMessages();
154
+ return Response.json(messages);
155
+ }
156
+ ```
157
+
158
+ ## Request Validation
159
+
160
+ ```typescript
161
+ import { z } from "zod";
162
+
163
+ const SendMessageSchema = z.object({
164
+ userId: z.string().min(1),
165
+ message: z.string().min(1).max(1000),
166
+ });
167
+
168
+ async function handleSendMessage(request: Request, env: Env): Promise<Response> {
169
+ const body = await request.json();
170
+ const result = SendMessageSchema.safeParse(body);
171
+
172
+ if (!result.success) {
173
+ return Response.json(
174
+ { error: "Validation failed", details: result.error.issues },
175
+ { status: 400 }
176
+ );
177
+ }
178
+
179
+ const stub = env.CHAT_ROOM.getByName(result.data.userId);
180
+ const message = await stub.sendMessage(result.data.userId, result.data.message);
181
+ return Response.json(message);
182
+ }
183
+ ```
184
+
185
+ ## Observability & Logging
186
+
187
+ ### Structured Logging
188
+
189
+ ```typescript
190
+ function log(level: "info" | "warn" | "error", message: string, data?: Record<string, unknown>) {
191
+ console.log(JSON.stringify({
192
+ level,
193
+ message,
194
+ timestamp: new Date().toISOString(),
195
+ ...data,
196
+ }));
197
+ }
198
+
199
+ // Usage
200
+ log("info", "Request received", { path: url.pathname, method: request.method });
201
+ log("error", "DO call failed", { roomId, error: String(error) });
202
+ ```
203
+
204
+ ### Request Tracing
205
+
206
+ ```typescript
207
+ async function handleRequest(request: Request, env: Env): Promise<Response> {
208
+ const requestId = crypto.randomUUID();
209
+ const startTime = Date.now();
210
+
211
+ try {
212
+ const response = await processRequest(request, env);
213
+
214
+ log("info", "Request completed", {
215
+ requestId,
216
+ duration: Date.now() - startTime,
217
+ status: response.status,
218
+ });
219
+
220
+ return response;
221
+ } catch (error) {
222
+ log("error", "Request failed", {
223
+ requestId,
224
+ duration: Date.now() - startTime,
225
+ error: String(error),
226
+ });
227
+ throw error;
228
+ }
229
+ }
230
+ ```
231
+
232
+ ### Tail Workers (Production)
233
+
234
+ For production logging, use Tail Workers to forward logs:
235
+
236
+ ```jsonc
237
+ // wrangler.jsonc
238
+ {
239
+ "tail_consumers": [
240
+ { "service": "log-collector" }
241
+ ]
242
+ }
243
+ ```
244
+
245
+ ## Error Handling
246
+
247
+ ### Graceful DO Errors
248
+
249
+ ```typescript
250
+ async function callDO(stub: DurableObjectStub<ChatRoom>, method: string): Promise<Response> {
251
+ try {
252
+ const result = await stub.getMessages();
253
+ return Response.json(result);
254
+ } catch (error) {
255
+ if (error instanceof Error) {
256
+ // DO threw an error
257
+ log("error", "DO operation failed", { error: error.message });
258
+ return Response.json(
259
+ { error: "Service temporarily unavailable" },
260
+ { status: 503 }
261
+ );
262
+ }
263
+ throw error;
264
+ }
265
+ }
266
+ ```
267
+
268
+ ### Timeout Handling
269
+
270
+ ```typescript
271
+ async function withTimeout<T>(promise: Promise<T>, ms: number): Promise<T> {
272
+ const timeout = new Promise<never>((_, reject) =>
273
+ setTimeout(() => reject(new Error("Timeout")), ms)
274
+ );
275
+ return Promise.race([promise, timeout]);
276
+ }
277
+
278
+ // Usage
279
+ const result = await withTimeout(stub.processData(data), 5000);
280
+ ```
281
+
282
+ ## CORS Handling
283
+
284
+ ```typescript
285
+ function corsHeaders(): HeadersInit {
286
+ return {
287
+ "Access-Control-Allow-Origin": "*",
288
+ "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE, OPTIONS",
289
+ "Access-Control-Allow-Headers": "Content-Type, Authorization",
290
+ };
291
+ }
292
+
293
+ export default {
294
+ async fetch(request: Request, env: Env): Promise<Response> {
295
+ if (request.method === "OPTIONS") {
296
+ return new Response(null, { headers: corsHeaders() });
297
+ }
298
+
299
+ const response = await handleRequest(request, env);
300
+
301
+ // Add CORS headers to response
302
+ const newHeaders = new Headers(response.headers);
303
+ Object.entries(corsHeaders()).forEach(([k, v]) => newHeaders.set(k, v));
304
+
305
+ return new Response(response.body, {
306
+ status: response.status,
307
+ headers: newHeaders,
308
+ });
309
+ },
310
+ };
311
+ ```
312
+
313
+ ## Secrets Management
314
+
315
+ Set secrets via wrangler CLI (not in config files):
316
+
317
+ ```bash
318
+ wrangler secret put API_KEY
319
+ wrangler secret put DATABASE_URL
320
+ ```
321
+
322
+ Access in code:
323
+ ```typescript
324
+ export default {
325
+ async fetch(request: Request, env: Env): Promise<Response> {
326
+ const apiKey = env.API_KEY; // From secret
327
+ // ...
328
+ },
329
+ };
330
+ ```
331
+
332
+ ## Development Commands
333
+
334
+ ```bash
335
+ # Local development
336
+ wrangler dev
337
+
338
+ # Deploy
339
+ wrangler deploy
340
+
341
+ # Tail logs
342
+ wrangler tail
343
+
344
+ # List DOs
345
+ wrangler d1 execute DB --command "SELECT * FROM _cf_DO"
346
+ ```
@@ -0,0 +1,185 @@
1
+ ---
2
+ name: sandbox-migrate-to-next
3
+ description: Use when porting a Cloudflare Sandbox app from stable @cloudflare/sandbox to @cloudflare/sandbox@next (Sandbox SDK 1.0 preview), or when the user asks to migrate or upgrade to Sandbox 1.0 / @next. Not for day-to-day stable work (sandbox-stable) or new @next apps (sandbox-next).
4
+ ---
5
+
6
+ # Migrate stable → Sandbox SDK 1.0 preview (`@next`)
7
+
8
+ **Perform** the port. Follow the steps in order. Depth lives in docs—fetch the linked page when a step needs detail.
9
+
10
+ Human guide: [Migrate](https://developers.cloudflare.com/sandbox/1-0-preview/migrate/) · [1.0 preview](https://developers.cloudflare.com/sandbox/1-0-preview/)
11
+
12
+ **New projects** should start on `@next` (**`sandbox-next`**), not this skill. **Day-to-day stable work** → **`sandbox-stable`**. Deprecated-API cleanup **without** moving to `@next` → [2026 deprecation guide](https://developers.cloudflare.com/sandbox/guides/2026-deprecation/) first if needed.
13
+
14
+ Existing apps should migrate **when you can**, so you are ready when 1.0 becomes the stable release. Do **not** force production cutover without the user agreeing.
15
+
16
+ **Prefer installed `@next` types and the migrate doc over memory.**
17
+
18
+ ## Workflow
19
+
20
+ 1. **Review** hard rules and the replacement map
21
+ 2. **Audit** the codebase; list hits and target shapes
22
+ 3. **Clarify** with the user (cutover, bridge, Python image, unclear sites)
23
+ 4. **Upgrade** package, image, and code
24
+ 5. **Validate**
25
+
26
+ Stop after any step that needs a user decision.
27
+
28
+ ## Hard rules
29
+
30
+ - Worker package and container image must be the **same** `@next` line.
31
+ - Production cutover uses **immediate** container rollout. Stable and `@next` control protocols are incompatible both ways; gradual rollout leaves a broken mixed window. In-flight container work can stop.
32
+ - After cutover, `await sandbox.exec(...)` means process **started**, not command **finished**.
33
+ - Argv is as-is (no implicit shell). Shell syntax needs an explicit shell binary.
34
+ - Process handles have **no stdin** → terminals for interactive input.
35
+ - Observation `timeout` / `AbortSignal` cancel the **wait only**, not the process.
36
+ - No single retry loop for every error.
37
+ - Do not invent APIs (`gitCheckout` on core, process stdin, string-exec completion helper).
38
+ - Self-deployed bridge stays on **stable** (not part of the preview line yet).
39
+
40
+ ## Replacement map
41
+
42
+ | Stable | `@next` |
43
+ | ------ | ------- |
44
+ | `SANDBOX_TRANSPORT` / `transport` / `setTransport` | Remove — RPC only |
45
+ | `await sandbox.exec("cmd")` → buffered result | `await sandbox.exec(argv)` → handle, then `output` / waits |
46
+ | `execStream` / `startProcess` | Same handle: `logs`, `waitFor*`, `kill` |
47
+ | Default / named sessions | Gone — `cwd`/`env` per launch, or one shell script |
48
+ | `sandbox.terminal(request)` / session terminal | `createTerminal` + `terminal.connect(request)` |
49
+ | xterm `sessionId` | `terminalId` |
50
+ | Interpreter methods on `Sandbox` | `withInterpreter` → `sandbox.interpreter.*` |
51
+ | `gitCheckout` | argv `git` via `exec` |
52
+ | String kill signals | Numeric only |
53
+ | Files, mounts, backups, ports, tunnels, `proxyToSandbox` | Mostly unchanged (ignore session/transport bits on stable pages) |
54
+
55
+ Depth: [Migrate](https://developers.cloudflare.com/sandbox/1-0-preview/migrate/) · after port, day-to-day → **`sandbox-next`**
56
+
57
+ ## Audit
58
+
59
+ ```sh
60
+ rg 'SANDBOX_TRANSPORT|transport:|setTransport|enableDefaultSession|createSession|getSession|deleteSession|execStream\(|startProcess\(|killProcess\(|sandbox\.terminal\(|sessionId|gitCheckout\(|SandboxTransport|ExecutionSession'
61
+ ```
62
+
63
+ Also: string `exec(`, `cd` then a later `exec`, bare `createCodeContext` / `runCode` on `Sandbox`.
64
+
65
+ ## Clarify (ask when needed)
66
+
67
+ - OK to cut production with `--containers-rollout=immediate` (live processes/terminals/streams may stop)?
68
+ - Self-deployed bridge? Leave on stable.
69
+ - Python interpreter → **`-python`** image variant?
70
+ - Call sites not covered by the map?
71
+
72
+ ## Upgrade
73
+
74
+ ### Package and image
75
+
76
+ ```sh
77
+ npm install @cloudflare/sandbox@next
78
+ ```
79
+
80
+ ```dockerfile
81
+ FROM cloudflare/sandbox:next
82
+ # Python: cloudflare/sandbox:next-python
83
+ ```
84
+
85
+ Same prerelease tag on Worker and image when not on floating `next`.
86
+
87
+ ### Code by area
88
+
89
+ Apply replacements from the map. For each area, implement from the doc—not from stable habits:
90
+
91
+ | Area | Doc |
92
+ | ---- | --- |
93
+ | Commands / handles / waits | [Processes](https://developers.cloudflare.com/sandbox/1-0-preview/processes/) · [Processes API](https://developers.cloudflare.com/sandbox/1-0-preview/api/processes/) |
94
+ | `cwd` / `env` / secrets | [Environment](https://developers.cloudflare.com/sandbox/1-0-preview/environment/) · [Outbound traffic](https://developers.cloudflare.com/sandbox/guides/outbound-traffic/) |
95
+ | Drop sessions | [Migrate](https://developers.cloudflare.com/sandbox/1-0-preview/migrate/) · [Lifecycle](https://developers.cloudflare.com/sandbox/1-0-preview/lifecycle/) |
96
+ | Terminals | [Terminals](https://developers.cloudflare.com/sandbox/1-0-preview/terminals/) |
97
+ | Interpreter | [Interpreter](https://developers.cloudflare.com/sandbox/1-0-preview/interpreter/) |
98
+ | Errors | [Errors](https://developers.cloudflare.com/sandbox/1-0-preview/errors/) |
99
+ | Durable job across requests | [Process execution — lifetime / durability](https://developers.cloudflare.com/sandbox/1-0-preview/processes/) |
100
+
101
+ **Commands (shape):**
102
+
103
+ ```ts
104
+ // Before (stable)
105
+ const result = await sandbox.exec("npm test");
106
+
107
+ // After (@next)
108
+ const process = await sandbox.exec(["/bin/bash", "-lc", "npm test"]);
109
+ const result = await process.output({ encoding: "utf8" });
110
+ ```
111
+
112
+ ```ts
113
+ const server = await sandbox.exec(["/bin/bash", "-lc", "npm run dev"], {
114
+ cwd: "/workspace/app",
115
+ });
116
+ await server.waitForPort(3000, { timeout: 60_000 });
117
+ await server.kill(); // numeric; default 15
118
+ ```
119
+
120
+ **Terminals (shape):**
121
+
122
+ ```ts
123
+ const terminal = await sandbox.createTerminal({ command: ["bash"], cwd: "/workspace" });
124
+ const t = await sandbox.getTerminal(terminal.id);
125
+ if (!t) return new Response("terminal gone", { status: 410 });
126
+ return t.connect(request, { cursor, cols, rows });
127
+ ```
128
+
129
+ **Interpreter (shape):**
130
+
131
+ ```ts
132
+ import { Sandbox as BaseSandbox } from "@cloudflare/sandbox";
133
+ import { withInterpreter } from "@cloudflare/sandbox/interpreter";
134
+
135
+ export class Sandbox extends BaseSandbox<Env> {
136
+ interpreter = withInterpreter(this);
137
+ }
138
+ ```
139
+
140
+ **Git (shape):**
141
+
142
+ ```ts
143
+ const clone = await sandbox.exec(
144
+ ["git", "clone", "--depth", "1", "--", repoUrl, "/workspace/repo"],
145
+ { cwd: "/workspace" },
146
+ );
147
+ const result = await clone.output({ encoding: "utf8" });
148
+ ```
149
+
150
+ Delete transport settings entirely. Remove session APIs. Isolate users with **separate sandbox IDs**.
151
+
152
+ ### Deploy cutover
153
+
154
+ Staging/branch first. Production is **one** deploy of matching Worker + image:
155
+
156
+ ```sh
157
+ npx wrangler deploy --containers-rollout=immediate
158
+ ```
159
+
160
+ Leave `rollout_active_grace_period` at default `0` (or set `0` if raised). After cutover, pre-deploy process/terminal IDs are invalid. Details: [Migrate](https://developers.cloudflare.com/sandbox/1-0-preview/migrate/) · [Container rollouts](https://developers.cloudflare.com/containers/platform-details/rollouts/)
161
+
162
+ ## Validate
163
+
164
+ 1. Lockfile + Dockerfile on the same `@next` line
165
+ 2. Typecheck against `@next`
166
+ 3. Smoke argv `exec` + `output({ encoding: "utf8" })`
167
+ 4. Smoke long process / terminal / interpreter if used
168
+ 5. Errors distinguished: unavailable / interrupted-RPC / stale / local wait
169
+ 6. No live secrets in sandbox env
170
+ 7. Grep again for removed APIs
171
+ 8. Production used `--containers-rollout=immediate`
172
+
173
+ Then day-to-day work uses **`sandbox-next`**.
174
+
175
+ ## Red flags — stop and fix
176
+
177
+ - Mixing `@next` Worker with stable image (or reverse)
178
+ - Gradual container rollout for this cutover
179
+ - Treating `await exec` as command completion
180
+ - Assuming `cd` / exports persist across `exec` calls
181
+ - One retry wrapper for every error
182
+ - Inventing `gitCheckout`, process stdin, or undocumented APIs
183
+ - Keeping pre-cutover process/terminal IDs after deploy
184
+ - Forcing production cutover without user agreement
185
+ - Putting live secrets in `setEnvVars` / launch `env`
@@ -0,0 +1,91 @@
1
+ ---
2
+ name: sandbox-next
3
+ description: Use when building or changing Cloudflare Sandbox apps on @cloudflare/sandbox@next (Sandbox SDK 1.0 preview)—code execution, AI runners, interpreters, CI-like jobs, terminals, files, mounts, tunnels, preview URLs, lifecycle, or errors. Not for the default stable package (use sandbox-stable) or for porting stable to @next (use sandbox-migrate-to-next).
4
+ ---
5
+
6
+ # Sandbox SDK — `@next` (1.0 preview)
7
+
8
+ Isolated Linux environments on [Cloudflare Containers](https://developers.cloudflare.com/containers/), driven from Workers.
9
+
10
+ **Prefer preview docs and installed `@next` types over memory.** APIs change; this skill is a gate, a contract, and a retrieval map—not a full manual.
11
+
12
+ We recommend **new projects** on this line. Apps still on the default package use **`sandbox-stable`**. Port only when asked, via **`sandbox-migrate-to-next`**.
13
+
14
+ ## 1. Gate — confirm the package line
15
+
16
+ Before writing code, inspect the app:
17
+
18
+ | Check | Must match |
19
+ | ----- | ---------- |
20
+ | npm dependency | `@cloudflare/sandbox@next` (or another preview tag) |
21
+ | Container image | Same line (e.g. `cloudflare/sandbox:next`, `next-python`) |
22
+
23
+ | If you find… | Action |
24
+ | ------------ | ------ |
25
+ | Default `@cloudflare/sandbox` (no `@next`) | **Stop.** Load **`sandbox-stable`**. Do not apply this skill’s APIs. |
26
+ | User wants to port stable → `@next` | **Stop.** Load **`sandbox-migrate-to-next`**. |
27
+ | Self-deployed **bridge** only | Bridge is **not** on the 1.0 preview line yet. Keep bridge on stable package + image. [Bridge (stable)](https://developers.cloudflare.com/sandbox/bridge/) |
28
+
29
+ Never mix an `@next` Worker package with a stable container image (or the reverse).
30
+
31
+ Skills install: [Agent setup](https://developers.cloudflare.com/agent-setup/) · [cloudflare/skills](https://github.com/cloudflare/skills)
32
+
33
+ ## 2. Contract — non-negotiables
34
+
35
+ - `sandbox.exec(argv)` takes an **argv** list and resolves when the process **starts**. It returns a **handle**, not a finished command result.
36
+ - Collect results with handle methods: `output()`, `logs()`, `waitForExit()`, `waitForPort()`, `waitForLog()`, `kill(signal?)`.
37
+ - No implicit shell. Shell syntax needs an explicit shell, e.g. `["/bin/bash", "-lc", script]`.
38
+ - Each launch is independent. A `cd` / `export` in one `exec` is not visible to the next. Pass `cwd` and `env` per launch, or one shell script.
39
+ - Process handles have **no stdin**. Interactive use → terminals (`createTerminal` + `connect`).
40
+ - Local wait `timeout` / `AbortSignal` cancel the **wait only**. They do not kill the process. Use `kill` or `exec`’s remote `timeout`.
41
+ - `getProcess` / `listProcesses` / `getTerminal` / `listTerminals` do **not** start a container; they return `null` / `[]` when none is up.
42
+ - Process and terminal IDs belong to the **current container**, not forever to a sandbox ID. For work that must survive replace, store the full job (argv, cwd, env, app state)—not only an id.
43
+ - Non-secret config only in `setEnvVars` / launch `env`. Live credentials stay in the Worker; use outbound handlers when the sandbox calls external APIs.
44
+ - Do **not** invent removed stable APIs (`gitCheckout` on core, string-`exec` completion, session execution, `sandbox.terminal(request)`).
45
+ - Do **not** use one retry loop for every error (see Errors docs).
46
+
47
+ Minimal shape:
48
+
49
+ ```ts
50
+ import { getSandbox, proxyToSandbox, Sandbox } from "@cloudflare/sandbox";
51
+
52
+ export { Sandbox };
53
+
54
+ const sandbox = getSandbox(env.Sandbox, "user-123");
55
+ const process = await sandbox.exec(["python3", "-c", "print(2 + 2)"]);
56
+ const result = await process.output({ encoding: "utf8" });
57
+ // result.stdout, result.exitCode
58
+ ```
59
+
60
+ Optional **non-exhaustive** cheatsheet (process/terminal/interpreter only): [references/api-quick-ref.md](references/api-quick-ref.md)
61
+ Examples index (`next` branch): [references/examples.md](references/examples.md)
62
+
63
+ ## 3. Retrieve — open the doc for the task
64
+
65
+ Fetch the page before implementing. Installed `@next` types win over guesses.
66
+
67
+ | You need to… | Open |
68
+ | ------------ | ---- |
69
+ | Orient / choose preview | [1.0 preview overview](https://developers.cloudflare.com/sandbox/1-0-preview/) |
70
+ | First Worker, wrangler, Dockerfile | [Get started](https://developers.cloudflare.com/sandbox/1-0-preview/get-started/) |
71
+ | `exec`, handles, readiness, durability | [Process execution](https://developers.cloudflare.com/sandbox/1-0-preview/processes/) |
72
+ | Process API signatures | [Processes API](https://developers.cloudflare.com/sandbox/1-0-preview/api/processes/) |
73
+ | Sandbox ID vs container vs sleep/destroy | [Lifecycle](https://developers.cloudflare.com/sandbox/1-0-preview/lifecycle/) |
74
+ | `cwd` / `env` / `setEnvVars` | [Environment](https://developers.cloudflare.com/sandbox/1-0-preview/environment/) |
75
+ | Interactive PTY / browser terminal | [Terminals](https://developers.cloudflare.com/sandbox/1-0-preview/terminals/) · [Terminals API](https://developers.cloudflare.com/sandbox/1-0-preview/api/terminals/) |
76
+ | Python/JS code interpreter | [Interpreter](https://developers.cloudflare.com/sandbox/1-0-preview/interpreter/) · [Interpreter API](https://developers.cloudflare.com/sandbox/1-0-preview/api/interpreter/) |
77
+ | Extensions model | [Extensions](https://developers.cloudflare.com/sandbox/1-0-preview/extensions/) |
78
+ | Error classes and recovery | [Errors](https://developers.cloudflare.com/sandbox/1-0-preview/errors/) · [Errors API](https://developers.cloudflare.com/sandbox/1-0-preview/api/errors/) |
79
+ | Common failures | [Troubleshooting](https://developers.cloudflare.com/sandbox/1-0-preview/troubleshooting/) |
80
+ | API hub | [API reference](https://developers.cloudflare.com/sandbox/1-0-preview/api/) |
81
+ | Files, mounts, backups, ports, tunnels, `proxyToSandbox` | Main docs for shared surfaces (ignore stable-only session/transport/`sandbox.terminal`): [Files](https://developers.cloudflare.com/sandbox/api/files/) · [Storage / mounts](https://developers.cloudflare.com/sandbox/api/storage/) · [Ports](https://developers.cloudflare.com/sandbox/api/ports/) · [Tunnels](https://developers.cloudflare.com/sandbox/api/tunnels/) · [Backups](https://developers.cloudflare.com/sandbox/api/backups/) · [Outbound traffic](https://developers.cloudflare.com/sandbox/guides/outbound-traffic/) · [Expose services](https://developers.cloudflare.com/sandbox/guides/expose-services/) · [Production](https://developers.cloudflare.com/sandbox/guides/production-deployment/) |
82
+ | Example apps | [examples on `next`](https://github.com/cloudflare/sandbox-sdk/tree/next/examples) |
83
+ | Still on stable package | **`sandbox-stable`** · [Main Sandbox docs](https://developers.cloudflare.com/sandbox/) |
84
+ | Porting an existing stable app | **`sandbox-migrate-to-next`** · [Migrate](https://developers.cloudflare.com/sandbox/1-0-preview/migrate/) |
85
+
86
+ ## 4. Before you ship
87
+
88
+ - Lockfile and Dockerfile on the **same** `@next` line
89
+ - Typecheck against installed `@next` types
90
+ - No live secrets in sandbox env
91
+ - Production preview hostnames need wildcard DNS on a custom domain when using those URL patterns