@cloudflare/sandbox 0.0.0-c0d9d33 → 0.0.0-c39674b

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 (87) hide show
  1. package/CHANGELOG.md +245 -0
  2. package/Dockerfile +136 -9
  3. package/README.md +147 -50
  4. package/dist/chunk-BFVUNTP4.js +104 -0
  5. package/dist/chunk-BFVUNTP4.js.map +1 -0
  6. package/dist/chunk-EKSWCBCA.js +86 -0
  7. package/dist/chunk-EKSWCBCA.js.map +1 -0
  8. package/dist/chunk-JXZMAU2C.js +559 -0
  9. package/dist/chunk-JXZMAU2C.js.map +1 -0
  10. package/dist/chunk-UZQBJBJF.js +7 -0
  11. package/dist/chunk-UZQBJBJF.js.map +1 -0
  12. package/dist/chunk-YEZBBFK7.js +2420 -0
  13. package/dist/chunk-YEZBBFK7.js.map +1 -0
  14. package/dist/chunk-Z532A7QC.js +78 -0
  15. package/dist/chunk-Z532A7QC.js.map +1 -0
  16. package/dist/file-stream.d.ts +43 -0
  17. package/dist/file-stream.js +9 -0
  18. package/dist/file-stream.js.map +1 -0
  19. package/dist/index.d.ts +9 -0
  20. package/dist/index.js +67 -0
  21. package/dist/index.js.map +1 -0
  22. package/dist/interpreter.d.ts +33 -0
  23. package/dist/interpreter.js +8 -0
  24. package/dist/interpreter.js.map +1 -0
  25. package/dist/request-handler.d.ts +18 -0
  26. package/dist/request-handler.js +13 -0
  27. package/dist/request-handler.js.map +1 -0
  28. package/dist/sandbox-DMlNr93l.d.ts +596 -0
  29. package/dist/sandbox.d.ts +4 -0
  30. package/dist/sandbox.js +13 -0
  31. package/dist/sandbox.js.map +1 -0
  32. package/dist/security.d.ts +31 -0
  33. package/dist/security.js +13 -0
  34. package/dist/security.js.map +1 -0
  35. package/dist/sse-parser.d.ts +28 -0
  36. package/dist/sse-parser.js +11 -0
  37. package/dist/sse-parser.js.map +1 -0
  38. package/dist/version.d.ts +8 -0
  39. package/dist/version.js +7 -0
  40. package/dist/version.js.map +1 -0
  41. package/package.json +14 -8
  42. package/src/clients/base-client.ts +280 -0
  43. package/src/clients/command-client.ts +115 -0
  44. package/src/clients/file-client.ts +269 -0
  45. package/src/clients/git-client.ts +92 -0
  46. package/src/clients/index.ts +64 -0
  47. package/src/clients/interpreter-client.ts +329 -0
  48. package/src/clients/port-client.ts +105 -0
  49. package/src/clients/process-client.ts +177 -0
  50. package/src/clients/sandbox-client.ts +41 -0
  51. package/src/clients/types.ts +84 -0
  52. package/src/clients/utility-client.ts +119 -0
  53. package/src/errors/adapter.ts +180 -0
  54. package/src/errors/classes.ts +469 -0
  55. package/src/errors/index.ts +105 -0
  56. package/src/file-stream.ts +164 -0
  57. package/src/index.ts +83 -119
  58. package/src/interpreter.ts +159 -0
  59. package/src/request-handler.ts +170 -0
  60. package/src/sandbox.ts +997 -0
  61. package/src/security.ts +104 -0
  62. package/src/sse-parser.ts +143 -0
  63. package/src/version.ts +6 -0
  64. package/startup.sh +3 -0
  65. package/tests/base-client.test.ts +328 -0
  66. package/tests/command-client.test.ts +407 -0
  67. package/tests/file-client.test.ts +643 -0
  68. package/tests/file-stream.test.ts +306 -0
  69. package/tests/get-sandbox.test.ts +110 -0
  70. package/tests/git-client.test.ts +328 -0
  71. package/tests/port-client.test.ts +301 -0
  72. package/tests/process-client.test.ts +658 -0
  73. package/tests/sandbox.test.ts +465 -0
  74. package/tests/sse-parser.test.ts +290 -0
  75. package/tests/utility-client.test.ts +332 -0
  76. package/tests/version.test.ts +16 -0
  77. package/tests/wrangler.jsonc +35 -0
  78. package/tsconfig.json +9 -1
  79. package/vitest.config.ts +31 -0
  80. package/container_src/index.ts +0 -2900
  81. package/container_src/package.json +0 -9
  82. package/src/client.ts +0 -1929
  83. package/tests/client.example.ts +0 -308
  84. package/tests/connection-test.ts +0 -81
  85. package/tests/simple-test.ts +0 -81
  86. package/tests/test1.ts +0 -281
  87. package/tests/test2.ts +0 -929
package/CHANGELOG.md CHANGED
@@ -1,5 +1,250 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.6
4
+
5
+ ### Patch Changes
6
+
7
+ - [#133](https://github.com/cloudflare/sandbox-sdk/pull/133) [`da2cfb8`](https://github.com/cloudflare/sandbox-sdk/commit/da2cfb876675eb3445970c90b4d70d00288a7c74) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - feat: Add version sync detection between npm package and Docker image
8
+
9
+ ## 0.4.5
10
+
11
+ ### Patch Changes
12
+
13
+ - [#127](https://github.com/cloudflare/sandbox-sdk/pull/127) [`e79ac80`](https://github.com/cloudflare/sandbox-sdk/commit/e79ac80bc855a3ec527d44cc14585794b23cb129) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - configurable sleepAfter
14
+
15
+ ## 0.4.4
16
+
17
+ ### Patch Changes
18
+
19
+ - [#125](https://github.com/cloudflare/sandbox-sdk/pull/125) [`fddccfd`](https://github.com/cloudflare/sandbox-sdk/commit/fddccfdce8204ce2aa7dadc0ad9fb2acbdeaec51) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add docker image to pkg workflow
20
+
21
+ ## 0.4.3
22
+
23
+ ### Patch Changes
24
+
25
+ - [#114](https://github.com/cloudflare/sandbox-sdk/pull/114) [`8c1f440`](https://github.com/cloudflare/sandbox-sdk/commit/8c1f440ad6fd89a5c69f9ca9d055ad9b183dd1c3) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Debloat base docker image (2.63GB → 1.03GB)
26
+
27
+ ## 0.4.2
28
+
29
+ ### Patch Changes
30
+
31
+ - [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
32
+
33
+ ## 0.4.1
34
+
35
+ ### Patch Changes
36
+
37
+ - [#111](https://github.com/cloudflare/sandbox-sdk/pull/111) [`1b5496b`](https://github.com/cloudflare/sandbox-sdk/commit/1b5496bfceaee53c31911b409476ea87bebffe4c) Thanks [@threepointone](https://github.com/threepointone)! - trigger a release
38
+
39
+ ## 0.4.0
40
+
41
+ ### Minor Changes
42
+
43
+ - [#95](https://github.com/cloudflare/sandbox-sdk/pull/95) [`7aee736`](https://github.com/cloudflare/sandbox-sdk/commit/7aee736bf07a4bf9020e2109bdaaa70214d52a01) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Rewrite SDK with cleaner design patterns and tests. Remove the unnecessary isolation cruft and fix foundational issues with streaming, sessions, validations and error handling. Cover the SDK with unit & e2e tests.
44
+
45
+ ### Patch Changes
46
+
47
+ - [#106](https://github.com/cloudflare/sandbox-sdk/pull/106) [`da947cd`](https://github.com/cloudflare/sandbox-sdk/commit/da947cd9543fc99831eefb1e8741fc905cb8fa42) Thanks [@jahands](https://github.com/jahands)! - fix examples failing to deploy and prevent committing node_modules
48
+
49
+ ## 0.3.3
50
+
51
+ ### Patch Changes
52
+
53
+ - [#83](https://github.com/cloudflare/sandbox-sdk/pull/83) [`eec5bb6`](https://github.com/cloudflare/sandbox-sdk/commit/eec5bb6203dd5d775b4b54e91c26de25eeb767ce) Thanks [@mikenomitch](https://github.com/mikenomitch)! - Bump containers package version
54
+
55
+ ## 0.3.2
56
+
57
+ ### Patch Changes
58
+
59
+ - [#76](https://github.com/cloudflare/sandbox-sdk/pull/76) [`ef9e320`](https://github.com/cloudflare/sandbox-sdk/commit/ef9e320dcef30e57797fef6ebd9a9383fa9720d9) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Replace Jupyter with lightweight interpreters for >90% faster cold starts for `.runCode` calls, while maintaining full code execution capabilities and rich output support.
60
+
61
+ ## 0.3.1
62
+
63
+ ### Patch Changes
64
+
65
+ - [#71](https://github.com/cloudflare/sandbox-sdk/pull/71) [`fb3c9c2`](https://github.com/cloudflare/sandbox-sdk/commit/fb3c9c22242d9d4f157c26f547f1e697ef7875f9) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Bump containers package version
66
+
67
+ - [#70](https://github.com/cloudflare/sandbox-sdk/pull/70) [`e1fa354`](https://github.com/cloudflare/sandbox-sdk/commit/e1fa354ab1bc7b0e89db4901b67028ebf1a93d0a) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix escaped quotes in file write operations
68
+
69
+ - [#68](https://github.com/cloudflare/sandbox-sdk/pull/68) [`69b91d1`](https://github.com/cloudflare/sandbox-sdk/commit/69b91d1a8f6afb63262cc381ea93e94a033ed5e8) Thanks [@CyrusNuevoDia](https://github.com/CyrusNuevoDia)! - Configurable timeouts via environment variables in isolation.ts
70
+
71
+ - [#66](https://github.com/cloudflare/sandbox-sdk/pull/66) [`eca93b9`](https://github.com/cloudflare/sandbox-sdk/commit/eca93b97e40fa0d3bd9dc27af2cc214ec355b696) Thanks [@peterp](https://github.com/peterp)! - Determine if the port is specified in the URL.
72
+
73
+ ## 0.3.0
74
+
75
+ ### Minor Changes
76
+
77
+ - [#59](https://github.com/cloudflare/sandbox-sdk/pull/59) [`b6757f7`](https://github.com/cloudflare/sandbox-sdk/commit/b6757f730c34381d5a70d513944bbf9840f598ab) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add process isolation for sandbox commands
78
+
79
+ Implements PID namespace isolation to protect control plane processes (Jupyter, Bun) from sandboxed code. Commands executed via `exec()` now run in isolated namespaces that cannot see or interact with system processes.
80
+
81
+ **Key security improvements:**
82
+
83
+ - Control plane processes are hidden from sandboxed commands
84
+ - Platform secrets in `/proc/1/environ` are inaccessible
85
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
86
+
87
+ **Breaking changes:**
88
+
89
+ 1. **Removed `sessionId` parameter**: The `sessionId` parameter has been removed from all methods (`exec()`, `execStream()`, `startProcess()`, etc.). Each sandbox now maintains its own persistent session automatically.
90
+
91
+ ```javascript
92
+ // Before: manual session management
93
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
94
+
95
+ // After: automatic session per sandbox
96
+ await sandbox.exec("cd /app");
97
+ ```
98
+
99
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
100
+
101
+ ```javascript
102
+ // Before: each exec was independent
103
+ await sandbox.exec("cd /app");
104
+ await sandbox.exec("pwd"); // Output: /workspace
105
+
106
+ // After: state persists in session
107
+ await sandbox.exec("cd /app");
108
+ await sandbox.exec("pwd"); // Output: /app
109
+ ```
110
+
111
+ **Migration guide:**
112
+
113
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
114
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
115
+ ```javascript
116
+ // Create independent sessions with different environments
117
+ const buildSession = await sandbox.createSession({
118
+ name: "build",
119
+ env: { NODE_ENV: "production" },
120
+ cwd: "/build",
121
+ });
122
+ const testSession = await sandbox.createSession({
123
+ name: "test",
124
+ env: { NODE_ENV: "test" },
125
+ cwd: "/test",
126
+ });
127
+ ```
128
+ - Environment variables set in one command persist to the next
129
+ - Background processes remain active until explicitly killed
130
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
131
+
132
+ ### Patch Changes
133
+
134
+ - [#62](https://github.com/cloudflare/sandbox-sdk/pull/62) [`4bedc3a`](https://github.com/cloudflare/sandbox-sdk/commit/4bedc3aba347f3d4090a6efe2c9778bac00ce74a) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix broken build due to bun lockfile not being used
135
+
136
+ ## 0.2.4
137
+
138
+ ### Patch Changes
139
+
140
+ - [#57](https://github.com/cloudflare/sandbox-sdk/pull/57) [`12bbd12`](https://github.com/cloudflare/sandbox-sdk/commit/12bbd1229c07ef8c1c0bf58a4235a27938155b08) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add listFiles method
141
+
142
+ ## 0.2.3
143
+
144
+ ### Patch Changes
145
+
146
+ - [#53](https://github.com/cloudflare/sandbox-sdk/pull/53) [`c87db11`](https://github.com/cloudflare/sandbox-sdk/commit/c87db117693a86cfb667bf09fb7720d6a6e0524d) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Improve jupyterlab config to speed up startup
147
+
148
+ ## 0.2.2
149
+
150
+ ### Patch Changes
151
+
152
+ - [#51](https://github.com/cloudflare/sandbox-sdk/pull/51) [`4aceb32`](https://github.com/cloudflare/sandbox-sdk/commit/4aceb3215c836f59afcb88b2b325016b3f623f46) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Handle intermittent interpreter failures and decouple jupyter startup
153
+
154
+ ## 0.2.1
155
+
156
+ ### Patch Changes
157
+
158
+ - [#49](https://github.com/cloudflare/sandbox-sdk/pull/49) [`d81d2a5`](https://github.com/cloudflare/sandbox-sdk/commit/d81d2a563c9af8947d5444019ed4d6156db563e3) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Implement code interpreter API
159
+
160
+ ## 0.2.0
161
+
162
+ ### Minor Changes
163
+
164
+ - [#47](https://github.com/cloudflare/sandbox-sdk/pull/47) [`8a93d0c`](https://github.com/cloudflare/sandbox-sdk/commit/8a93d0cae18a25bda6506b8b0a08d9e9eb3bb290) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Change default directory to a clean /workspace
165
+
166
+ ## 0.1.4
167
+
168
+ ### Patch Changes
169
+
170
+ - [#46](https://github.com/cloudflare/sandbox-sdk/pull/46) [`7de28be`](https://github.com/cloudflare/sandbox-sdk/commit/7de28be482d9634551572d548c7c4b5842df812d) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Update README
171
+
172
+ - [#44](https://github.com/cloudflare/sandbox-sdk/pull/44) [`215ab49`](https://github.com/cloudflare/sandbox-sdk/commit/215ab494427d7e2a92bb9a25384cb493a221c200) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Update example to use env & cwd
173
+
174
+ - [#42](https://github.com/cloudflare/sandbox-sdk/pull/42) [`bb72193`](https://github.com/cloudflare/sandbox-sdk/commit/bb72193ad75695979bd1132206f481e91fe37325) Thanks [@jonasnobile](https://github.com/jonasnobile)! - Propagate `cwd` and `env` options in `executeCommand`
175
+
176
+ - [#27](https://github.com/cloudflare/sandbox-sdk/pull/27) [`fd5ec7f`](https://github.com/cloudflare/sandbox-sdk/commit/fd5ec7f34bc12b06320a89356c4af07801f52d64) Thanks [@threepointone](https://github.com/threepointone)! - remove yarn and pnpm from the image
177
+
178
+ ## 0.1.3
179
+
180
+ ### Patch Changes
181
+
182
+ - [#32](https://github.com/cloudflare/sandbox-sdk/pull/32) [`1a42464`](https://github.com/cloudflare/sandbox-sdk/commit/1a4246479369c5d0160705caf192aa1816540d52) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Bring back package README
183
+
184
+ ## 0.1.2
185
+
186
+ ### Patch Changes
187
+
188
+ - [#30](https://github.com/cloudflare/sandbox-sdk/pull/30) [`30e5c25`](https://github.com/cloudflare/sandbox-sdk/commit/30e5c25cf7d4b07f9049724206c531e2d5d29d5c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Remove actions timeout
189
+
190
+ - [#29](https://github.com/cloudflare/sandbox-sdk/pull/29) [`d78508f`](https://github.com/cloudflare/sandbox-sdk/commit/d78508f7287a59e0423edd2999c2c83e9e34ccfd) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Create multi-platform Docker image and switch to Cloudflare official repo
191
+
192
+ ## 0.1.1
193
+
194
+ ### Patch Changes
195
+
196
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
197
+
198
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
199
+
200
+ ## 0.1.0
201
+
202
+ ### Minor Changes
203
+
204
+ - [#24](https://github.com/cloudflare/sandbox-sdk/pull/24) [`cecde0a`](https://github.com/cloudflare/sandbox-sdk/commit/cecde0a7530a87deffd8562fb8b01d66ee80ee19) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Redesign command execution API
205
+
206
+ ### Patch Changes
207
+
208
+ - [#22](https://github.com/cloudflare/sandbox-sdk/pull/22) [`f5fcd52`](https://github.com/cloudflare/sandbox-sdk/commit/f5fcd52025d1f7958a374e69d75e3fc590275f3f) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Allow setting env variables dynamically and remove command restrictions
209
+
210
+ ## 0.0.9
211
+
212
+ ### Patch Changes
213
+
214
+ - [#20](https://github.com/cloudflare/sandbox-sdk/pull/20) [`f106fda`](https://github.com/cloudflare/sandbox-sdk/commit/f106fdac98e7ef35677326290d45cbf3af88982c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - add preview URLs and dynamic port forwarding
215
+
216
+ ## 0.0.8
217
+
218
+ ### Patch Changes
219
+
220
+ - [`60af265`](https://github.com/cloudflare/sandbox-sdk/commit/60af265d834e83fd30a921a3e1be232f13fe24da) Thanks [@threepointone](https://github.com/threepointone)! - update dependencies
221
+
222
+ ## 0.0.7
223
+
224
+ ### Patch Changes
225
+
226
+ - [`d1c7c99`](https://github.com/cloudflare/sandbox-sdk/commit/d1c7c99df6555eff71bcd59852e4b8eed2ad8cb6) Thanks [@threepointone](https://github.com/threepointone)! - fix file operations
227
+
228
+ ## 0.0.6
229
+
230
+ ### Patch Changes
231
+
232
+ - [#9](https://github.com/cloudflare/sandbox-sdk/pull/9) [`24f5470`](https://github.com/cloudflare/sandbox-sdk/commit/24f547048d5a26137de4656cea13d83ad2cc0b43) Thanks [@ItsWendell](https://github.com/ItsWendell)! - fix baseUrl for stub and stub forwarding
233
+
234
+ ## 0.0.5
235
+
236
+ ### Patch Changes
237
+
238
+ - [#5](https://github.com/cloudflare/sandbox-sdk/pull/5) [`7c15b81`](https://github.com/cloudflare/sandbox-sdk/commit/7c15b817899e4d9e1f25747aaf439e5e9e880d15) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Make package ready for deployment
239
+
240
+ ## 0.0.4
241
+
242
+ ### Patch Changes
243
+
244
+ - [`c0d9d33`](https://github.com/cloudflare/sandbox-sdk/commit/c0d9d3396badee1eab45e6b4a73d48957f31409b) Thanks [@threepointone](https://github.com/threepointone)! - actually work
245
+
246
+ - [`444d2da`](https://github.com/cloudflare/sandbox-sdk/commit/444d2dafde9a0f190e50c879b0e768da1b289b51) Thanks [@threepointone](https://github.com/threepointone)! - add experimental label
247
+
3
248
  ## 0.0.3
4
249
 
5
250
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,16 +1,143 @@
1
- # syntax=docker/dockerfile:1
1
+ # Sandbox container image with full development environment
2
+ # Multi-stage build optimized for Turborepo monorepo
3
+
4
+ # ============================================================================
5
+ # Stage 1: Prune monorepo to only include necessary packages
6
+ # ============================================================================
7
+ FROM node:20-alpine AS pruner
8
+
9
+ WORKDIR /app
10
+
11
+ # Install Turborepo globally
12
+ RUN npm install -g turbo
13
+
14
+ # Copy entire monorepo
15
+ COPY . .
16
+
17
+ # Prune to only @repo/sandbox-container and its dependencies (@repo/shared)
18
+ # The --docker flag generates out/json and out/full directories
19
+ RUN turbo prune @repo/sandbox-container --docker
20
+
21
+ # ============================================================================
22
+ # Stage 2: Install dependencies and build packages
23
+ # ============================================================================
24
+ FROM node:20-alpine AS builder
25
+
26
+ WORKDIR /app
27
+
28
+ # Copy pruned lockfile and package.json files (for Docker layer caching)
29
+ COPY --from=pruner /app/out/json/ .
30
+ COPY --from=pruner /app/out/package-lock.json ./package-lock.json
31
+
32
+ # Install ALL dependencies (including devDependencies for build)
33
+ RUN npm ci
34
+
35
+ # Copy pruned source code
36
+ COPY --from=pruner /app/out/full/ .
37
+
38
+ # Build all packages (Turborepo handles dependency order automatically)
39
+ # This builds @repo/shared first, then @repo/sandbox-container
40
+ RUN npx turbo run build
41
+
42
+ # ============================================================================
43
+ # Stage 3: Install production-only dependencies
44
+ # ============================================================================
45
+ FROM node:20-alpine AS prod-deps
2
46
 
3
- FROM oven/bun:latest
4
- # Set destination for COPY
5
47
  WORKDIR /app
6
48
 
7
- # Install git
8
- RUN apt-get update && apt-get install -y git
49
+ # Copy package files from builder
50
+ COPY --from=builder /app/package.json ./package.json
51
+ COPY --from=builder /app/package-lock.json ./package-lock.json
52
+ COPY --from=builder /app/packages ./packages
53
+ COPY --from=builder /app/tooling ./tooling
54
+
55
+ # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
56
+ RUN npm ci --production
57
+
58
+ # ============================================================================
59
+ # Stage 4: Runtime - Ubuntu 22.04 with only runtime dependencies
60
+ # ============================================================================
61
+ FROM ubuntu:22.04 AS runtime
9
62
 
10
- COPY container_src/* ./
11
- # RUN bun install
63
+ # Accept version as build argument (passed from npm_package_version)
64
+ ARG SANDBOX_VERSION=unknown
12
65
 
66
+ # Prevent interactive prompts during package installation
67
+ ENV DEBIAN_FRONTEND=noninteractive
68
+
69
+ # Set the sandbox version as an environment variable for version checking
70
+ ENV SANDBOX_VERSION=${SANDBOX_VERSION}
71
+
72
+ # Install essential runtime packages
73
+ RUN apt-get update && apt-get install -y --no-install-recommends \
74
+ curl \
75
+ wget \
76
+ ca-certificates \
77
+ python3.11 \
78
+ python3-pip \
79
+ python3.11-venv \
80
+ procps \
81
+ git \
82
+ unzip \
83
+ zip \
84
+ jq \
85
+ file \
86
+ && rm -rf /var/lib/apt/lists/*
87
+
88
+ # Set Python 3.11 as default python3
89
+ RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
90
+
91
+ # Install Node.js 20 LTS using official NodeSource setup script
92
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
93
+ && apt-get install -y nodejs \
94
+ && rm -rf /var/lib/apt/lists/*
95
+
96
+ # Install Bun runtime from official image
97
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
98
+
99
+ # Install essential Python packages for code execution
100
+ RUN pip3 install --no-cache-dir \
101
+ matplotlib \
102
+ numpy \
103
+ pandas \
104
+ ipython
105
+
106
+ # Set up runtime container server directory
107
+ WORKDIR /container-server
108
+
109
+ # Copy built sandbox-container package
110
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
111
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
112
+
113
+ # Copy Python executor to runtime location
114
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
115
+
116
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
117
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
118
+ COPY --from=prod-deps /app/node_modules ./node_modules
119
+
120
+ # Copy workspace packages
121
+ COPY --from=prod-deps /app/packages/shared/dist ./packages/shared/dist
122
+ COPY --from=prod-deps /app/packages/shared/package.json ./packages/shared/package.json
123
+
124
+ # Configure process pool sizes (can be overridden at runtime)
125
+ ENV PYTHON_POOL_MIN_SIZE=3
126
+ ENV PYTHON_POOL_MAX_SIZE=15
127
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
128
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
129
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
130
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
131
+
132
+ # Create clean workspace directory for user code
133
+ RUN mkdir -p /workspace
134
+
135
+ # Expose the application port (3000 for control)
13
136
  EXPOSE 3000
14
- # Run
15
- CMD ["bun", "index.ts"]
16
137
 
138
+ # Copy and make startup script executable
139
+ COPY packages/sandbox/startup.sh ./
140
+ RUN chmod +x startup.sh
141
+
142
+ # Use startup script
143
+ CMD ["./startup.sh"]
package/README.md CHANGED
@@ -1,65 +1,162 @@
1
- ## @cloudflare/sandbox
1
+ <img width="1362" height="450" alt="Image" src="https://github.com/user-attachments/assets/6f770ae3-0a14-4d2b-9aed-a304ee5446c5" />
2
2
 
3
- > **⚠️ Experimental** - This library is currently experimental and we're actively seeking feedback. Please try it out and let us know what you think!
3
+ # Cloudflare Sandbox SDK
4
4
 
5
- A library to spin up a sandboxed environment.
5
+ [![npm version](https://img.shields.io/npm/v/@cloudflare/sandbox.svg)](https://www.npmjs.com/package/@cloudflare/sandbox)
6
6
 
7
- First, setup your wrangler.json to use the sandbox:
7
+ **Build secure, isolated code execution environments on Cloudflare.**
8
8
 
9
- ```jsonc
10
- {
11
- // ...
12
- "containers": [
13
- {
14
- "class_name": "Sandbox",
15
- "image": "./node_modules/@cloudflare/sandbox/Dockerfile",
16
- "name": "sandbox"
17
- }
18
- ],
19
- "durable_objects": {
20
- "bindings": [
21
- {
22
- "class_name": "Sandbox",
23
- "name": "Sandbox"
24
- }
25
- ]
26
- },
27
- "migrations": [
28
- {
29
- "new_sqlite_classes": ["Sandbox"],
30
- "tag": "v1"
31
- }
32
- ]
33
- }
9
+ The Sandbox SDK lets you run untrusted code safely in isolated containers. Execute commands, manage files, run background processes, and expose services — all from your Workers applications.
10
+
11
+ Perfect for AI code execution, interactive development environments, data analysis platforms, CI/CD systems, and any application that needs secure code execution at the edge.
12
+
13
+ ## Getting Started
14
+
15
+ ### Prerequisites
16
+
17
+ 1. Install [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (version 16.17.0 or later)
18
+ 2. Ensure Docker is running locally
19
+ 3. For deploying to production, sign up for a [Cloudflare account](https://dash.cloudflare.com/sign-up/workers-and-pages)
20
+
21
+ ### 1. Create a new project
22
+
23
+ Create a new Sandbox SDK project using the minimal template:
24
+
25
+ ```bash
26
+ npm create cloudflare@latest -- my-sandbox --template=cloudflare/sandbox-sdk/examples/minimal
27
+ cd my-sandbox
28
+ ```
29
+
30
+ ### 2. Test locally
31
+
32
+ Start the development server:
33
+
34
+ ```bash
35
+ npm run dev
34
36
  ```
35
37
 
36
- Then, export the Sandbox class in your worker:
38
+ > **Note:** First run builds the Docker container (2-3 minutes). Subsequent runs are much faster.
37
39
 
38
- ```ts
39
- export { Sandbox } from "@cloudflare/sandbox";
40
+ Test the endpoints:
41
+
42
+ ```bash
43
+ # Execute Python code
44
+ curl http://localhost:8787/run
45
+
46
+ # File operations
47
+ curl http://localhost:8787/file
40
48
  ```
41
49
 
42
- You can then use the Sandbox class in your worker:
50
+ ### 3. Deploy to production
51
+
52
+ Deploy your Worker and container:
53
+
54
+ ```bash
55
+ npx wrangler deploy
56
+ ```
57
+
58
+ > **Wait for provisioning:** After first deployment, wait 2-3 minutes before making requests.
59
+
60
+ **📖 [View the complete getting started guide](https://developers.cloudflare.com/sandbox/get-started/)** for detailed instructions and explanations.
43
61
 
44
- ```ts
45
- import { getSandbox } from "@cloudflare/sandbox";
62
+ ## Quick API Example
63
+
64
+ ```typescript
65
+ import { getSandbox, proxyToSandbox, type Sandbox } from '@cloudflare/sandbox';
66
+
67
+ export { Sandbox } from '@cloudflare/sandbox';
68
+
69
+ type Env = {
70
+ Sandbox: DurableObjectNamespace<Sandbox>;
71
+ };
46
72
 
47
73
  export default {
48
- async fetch(request: Request, env: Env) {
49
- const sandbox = getSandbox(env.Sandbox, "my-sandbox");
50
- return sandbox.exec("ls", ["-la"]);
51
- },
74
+ async fetch(request: Request, env: Env): Promise<Response> {
75
+ // Required for preview URLs
76
+ const proxyResponse = await proxyToSandbox(request, env);
77
+ if (proxyResponse) return proxyResponse;
78
+
79
+ const url = new URL(request.url);
80
+ const sandbox = getSandbox(env.Sandbox, 'my-sandbox');
81
+
82
+ // Execute Python code
83
+ if (url.pathname === '/run') {
84
+ const result = await sandbox.exec('python3 -c "print(2 + 2)"');
85
+ return Response.json({ output: result.stdout, success: result.success });
86
+ }
87
+
88
+ // Work with files
89
+ if (url.pathname === '/file') {
90
+ await sandbox.writeFile('/workspace/hello.txt', 'Hello, Sandbox!');
91
+ const file = await sandbox.readFile('/workspace/hello.txt');
92
+ return Response.json({ content: file.content });
93
+ }
94
+
95
+ return new Response('Try /run or /file');
96
+ }
52
97
  };
53
98
  ```
54
99
 
55
- ### Methods:
56
-
57
- - `exec(command: string, args: string[], options?: { stream?: boolean })`: Execute a command in the sandbox.
58
- - `gitCheckout(repoUrl: string, options: { branch?: string; targetDir?: string; stream?: boolean })`: Checkout a git repository in the sandbox.
59
- - `mkdir(path: string, options: { recursive?: boolean; stream?: boolean })`: Create a directory in the sandbox.
60
- - `writeFile(path: string, content: string, options: { encoding?: string; stream?: boolean })`: Write content to a file in the sandbox.
61
- - `readFile(path: string, options: { encoding?: string; stream?: boolean })`: Read content from a file in the sandbox.
62
- - `deleteFile(path: string, options?: { stream?: boolean })`: Delete a file from the sandbox.
63
- - `renameFile(oldPath: string, newPath: string, options?: { stream?: boolean })`: Rename a file in the sandbox.
64
- - `moveFile(sourcePath: string, destinationPath: string, options?: { stream?: boolean })`: Move a file from one location to another in the sandbox.
65
- - `ping()`: Ping the sandbox.
100
+ ## Documentation
101
+
102
+ **📖 [Full Documentation](https://developers.cloudflare.com/sandbox/)**
103
+
104
+ - [Get Started Guide](https://developers.cloudflare.com/sandbox/get-started/) - Step-by-step tutorial
105
+ - [API Reference](https://developers.cloudflare.com/sandbox/api/) - Complete API docs
106
+ - [Guides](https://developers.cloudflare.com/sandbox/guides/) - Execute commands, manage files, expose services
107
+ - [Examples](https://developers.cloudflare.com/sandbox/tutorials/) - AI agents, data analysis, CI/CD pipelines
108
+
109
+ ## Key Features
110
+
111
+ - **Secure Isolation** - Each sandbox runs in its own container
112
+ - **Edge-Native** - Runs on Cloudflare's global network
113
+ - **Code Interpreter** - Execute Python and JavaScript with rich outputs
114
+ - **File System Access** - Read, write, and manage files
115
+ - **Command Execution** - Run any command with streaming support
116
+ - **Preview URLs** - Expose services with public URLs
117
+ - **Git Integration** - Clone repositories directly
118
+
119
+ ## Development
120
+
121
+ This repository contains the SDK source code. To contribute:
122
+
123
+ ```bash
124
+ # Clone the repo
125
+ git clone https://github.com/cloudflare/sandbox-sdk
126
+ cd sandbox-sdk
127
+
128
+ # Install dependencies
129
+ npm install
130
+
131
+ # Run tests
132
+ npm test
133
+
134
+ # Build the project
135
+ npm run build
136
+
137
+ # Type checking and linting
138
+ npm run check
139
+ ```
140
+
141
+ ## Examples
142
+
143
+ See the [examples directory](./examples) for complete working examples:
144
+
145
+ - [Minimal](./examples/minimal) - Basic sandbox setup
146
+ - [Code Interpreter](./examples/code-interpreter) - Use sandbox as an interpreter tool with gpt-oss
147
+ - [Complete](./examples/basic) - Huge example integrated with every sandbox feature
148
+
149
+ ## Status
150
+
151
+ **Beta** - The SDK is in active development. APIs may change before v1.0.
152
+
153
+ ## License
154
+
155
+ [MIT License](LICENSE)
156
+
157
+ ## Links
158
+
159
+ - [Documentation](https://developers.cloudflare.com/sandbox/)
160
+ - [GitHub Issues](https://github.com/cloudflare/sandbox-sdk/issues)
161
+ - [Developer Discord](https://discord.cloudflare.com)
162
+ - [Cloudflare Developers](https://twitter.com/CloudflareDev)