@cloudflare/sandbox 0.0.0-0608f1e → 0.0.0-08ea6f4

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 (58) hide show
  1. package/CHANGELOG.md +266 -0
  2. package/Dockerfile +125 -56
  3. package/README.md +169 -0
  4. package/dist/index.d.ts +1889 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +3146 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +16 -7
  9. package/src/clients/base-client.ts +295 -0
  10. package/src/clients/command-client.ts +115 -0
  11. package/src/clients/file-client.ts +300 -0
  12. package/src/clients/git-client.ts +91 -0
  13. package/src/clients/index.ts +60 -0
  14. package/src/clients/interpreter-client.ts +333 -0
  15. package/src/clients/port-client.ts +105 -0
  16. package/src/clients/process-client.ts +180 -0
  17. package/src/clients/sandbox-client.ts +39 -0
  18. package/src/clients/types.ts +88 -0
  19. package/src/clients/utility-client.ts +123 -0
  20. package/src/errors/adapter.ts +238 -0
  21. package/src/errors/classes.ts +594 -0
  22. package/src/errors/index.ts +109 -0
  23. package/src/file-stream.ts +169 -0
  24. package/src/index.ts +94 -14
  25. package/src/interpreter.ts +168 -0
  26. package/src/request-handler.ts +94 -55
  27. package/src/sandbox.ts +907 -317
  28. package/src/security.ts +34 -28
  29. package/src/sse-parser.ts +8 -11
  30. package/src/version.ts +6 -0
  31. package/startup.sh +3 -0
  32. package/tests/base-client.test.ts +364 -0
  33. package/tests/command-client.test.ts +444 -0
  34. package/tests/file-client.test.ts +831 -0
  35. package/tests/file-stream.test.ts +310 -0
  36. package/tests/get-sandbox.test.ts +149 -0
  37. package/tests/git-client.test.ts +415 -0
  38. package/tests/port-client.test.ts +293 -0
  39. package/tests/process-client.test.ts +683 -0
  40. package/tests/request-handler.test.ts +292 -0
  41. package/tests/sandbox.test.ts +706 -0
  42. package/tests/sse-parser.test.ts +291 -0
  43. package/tests/utility-client.test.ts +339 -0
  44. package/tests/version.test.ts +16 -0
  45. package/tests/wrangler.jsonc +35 -0
  46. package/tsconfig.json +9 -1
  47. package/tsdown.config.ts +12 -0
  48. package/vitest.config.ts +31 -0
  49. package/container_src/handler/exec.ts +0 -337
  50. package/container_src/handler/file.ts +0 -844
  51. package/container_src/handler/git.ts +0 -182
  52. package/container_src/handler/ports.ts +0 -314
  53. package/container_src/handler/process.ts +0 -640
  54. package/container_src/index.ts +0 -361
  55. package/container_src/package.json +0 -9
  56. package/container_src/types.ts +0 -103
  57. package/src/client.ts +0 -1038
  58. package/src/types.ts +0 -386
package/CHANGELOG.md CHANGED
@@ -1,5 +1,271 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.14
4
+
5
+ ### Patch Changes
6
+
7
+ - [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Update dependencies
8
+
9
+ - [#176](https://github.com/cloudflare/sandbox-sdk/pull/176) [`7edbfa9`](https://github.com/cloudflare/sandbox-sdk/commit/7edbfa906668d75f540527f50b52483dc787192c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add cache mounts to Dockerfile for faster builds
10
+
11
+ Adds cache mounts for npm, apt, and pip package managers in the Dockerfile. This speeds up Docker image builds when dependencies change, particularly beneficial for users building from source.
12
+
13
+ - [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
14
+
15
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
16
+
17
+ - [#175](https://github.com/cloudflare/sandbox-sdk/pull/175) [`77cb937`](https://github.com/cloudflare/sandbox-sdk/commit/77cb93762a619523758f769a10509e665ca819fe) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Move .connect to .wsConnect within DO stub
18
+
19
+ ## 0.4.13
20
+
21
+ ### Patch Changes
22
+
23
+ - [#168](https://github.com/cloudflare/sandbox-sdk/pull/168) [`6b08f02`](https://github.com/cloudflare/sandbox-sdk/commit/6b08f02c061aef07cc98188abef2973ac92365f8) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
24
+
25
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
26
+
27
+ - [#162](https://github.com/cloudflare/sandbox-sdk/pull/162) [`c4db459`](https://github.com/cloudflare/sandbox-sdk/commit/c4db459389a7b86048a03410d67d4dd7bf4a6085) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Add WebSocket support via connect() method for routing client WebSocket connections directly to container services
28
+
29
+ ## 0.4.12
30
+
31
+ ### Patch Changes
32
+
33
+ - [#137](https://github.com/cloudflare/sandbox-sdk/pull/137) [`7f4442b`](https://github.com/cloudflare/sandbox-sdk/commit/7f4442b7a097587d8f8e8f9ff2f887df6943a3db) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add keepAlive flag to prevent containers from shutting down
34
+
35
+ ## 0.4.11
36
+
37
+ ### Patch Changes
38
+
39
+ - [#159](https://github.com/cloudflare/sandbox-sdk/pull/159) [`e16659a`](https://github.com/cloudflare/sandbox-sdk/commit/e16659a1815923f1cd1176f51a052725d820ee16) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Use latest containers package version
40
+
41
+ ## 0.4.10
42
+
43
+ ### Patch Changes
44
+
45
+ - [#156](https://github.com/cloudflare/sandbox-sdk/pull/156) [`b61841c`](https://github.com/cloudflare/sandbox-sdk/commit/b61841cfb3248022ee8136311e54955ed9faa1ee) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix WebSocket upgrade requests through exposed ports
46
+
47
+ ## 0.4.9
48
+
49
+ ### Patch Changes
50
+
51
+ - [#152](https://github.com/cloudflare/sandbox-sdk/pull/152) [`8e7773e`](https://github.com/cloudflare/sandbox-sdk/commit/8e7773ec9571a5f968cbbc5f48e38e01d7d13b77) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add exists() method to check if a file or directory exists
52
+
53
+ This adds a new `exists()` method to the SDK that checks whether a file or directory exists at a given path. The method returns a boolean indicating existence, similar to Python's `os.path.exists()` and JavaScript's `fs.existsSync()`.
54
+
55
+ The implementation is end-to-end:
56
+ - New `FileExistsResult` and `FileExistsRequest` types in shared package
57
+ - Handler endpoint at `/api/exists` in container layer
58
+ - Client method in `FileClient` and `Sandbox` classes
59
+ - Full test coverage (unit tests and E2E tests)
60
+
61
+ ## 0.4.8
62
+
63
+ ### Patch Changes
64
+
65
+ - [#153](https://github.com/cloudflare/sandbox-sdk/pull/153) [`f6a5c3e`](https://github.com/cloudflare/sandbox-sdk/commit/f6a5c3e1607fce5fc26f816e9206ae437898d5af) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix token extraction regex causing Invalid token errors
66
+
67
+ ## 0.4.7
68
+
69
+ ### Patch Changes
70
+
71
+ - [#141](https://github.com/cloudflare/sandbox-sdk/pull/141) [`c39674b`](https://github.com/cloudflare/sandbox-sdk/commit/c39674b8fe2e986e59a794b6bb3a5f51a87bae89) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix commands hanging when reading stdin by redirecting stdin to /dev/null
72
+
73
+ - [#143](https://github.com/cloudflare/sandbox-sdk/pull/143) [`276efc0`](https://github.com/cloudflare/sandbox-sdk/commit/276efc0ca8776bcc8de79e7e58dd24d9f418cc5c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Remove unnecessary existing session check
74
+
75
+ ## 0.4.6
76
+
77
+ ### Patch Changes
78
+
79
+ - [#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
80
+
81
+ ## 0.4.5
82
+
83
+ ### Patch Changes
84
+
85
+ - [#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
86
+
87
+ ## 0.4.4
88
+
89
+ ### Patch Changes
90
+
91
+ - [#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
92
+
93
+ ## 0.4.3
94
+
95
+ ### Patch Changes
96
+
97
+ - [#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)
98
+
99
+ ## 0.4.2
100
+
101
+ ### Patch Changes
102
+
103
+ - [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
104
+
105
+ ## 0.4.1
106
+
107
+ ### Patch Changes
108
+
109
+ - [#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
110
+
111
+ ## 0.4.0
112
+
113
+ ### Minor Changes
114
+
115
+ - [#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.
116
+
117
+ ### Patch Changes
118
+
119
+ - [#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
120
+
121
+ ## 0.3.3
122
+
123
+ ### Patch Changes
124
+
125
+ - [#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
126
+
127
+ ## 0.3.2
128
+
129
+ ### Patch Changes
130
+
131
+ - [#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.
132
+
133
+ ## 0.3.1
134
+
135
+ ### Patch Changes
136
+
137
+ - [#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
138
+
139
+ - [#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
140
+
141
+ - [#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
142
+
143
+ - [#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.
144
+
145
+ ## 0.3.0
146
+
147
+ ### Minor Changes
148
+
149
+ - [#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
150
+
151
+ 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.
152
+
153
+ **Key security improvements:**
154
+ - Control plane processes are hidden from sandboxed commands
155
+ - Platform secrets in `/proc/1/environ` are inaccessible
156
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
157
+
158
+ **Breaking changes:**
159
+ 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.
160
+
161
+ ```javascript
162
+ // Before: manual session management
163
+ await sandbox.exec('cd /app', { sessionId: 'my-session' });
164
+
165
+ // After: automatic session per sandbox
166
+ await sandbox.exec('cd /app');
167
+ ```
168
+
169
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
170
+
171
+ ```javascript
172
+ // Before: each exec was independent
173
+ await sandbox.exec('cd /app');
174
+ await sandbox.exec('pwd'); // Output: /workspace
175
+
176
+ // After: state persists in session
177
+ await sandbox.exec('cd /app');
178
+ await sandbox.exec('pwd'); // Output: /app
179
+ ```
180
+
181
+ **Migration guide:**
182
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
183
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
184
+ ```javascript
185
+ // Create independent sessions with different environments
186
+ const buildSession = await sandbox.createSession({
187
+ name: 'build',
188
+ env: { NODE_ENV: 'production' },
189
+ cwd: '/build'
190
+ });
191
+ const testSession = await sandbox.createSession({
192
+ name: 'test',
193
+ env: { NODE_ENV: 'test' },
194
+ cwd: '/test'
195
+ });
196
+ ```
197
+ - Environment variables set in one command persist to the next
198
+ - Background processes remain active until explicitly killed
199
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
200
+
201
+ ### Patch Changes
202
+
203
+ - [#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
204
+
205
+ ## 0.2.4
206
+
207
+ ### Patch Changes
208
+
209
+ - [#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
210
+
211
+ ## 0.2.3
212
+
213
+ ### Patch Changes
214
+
215
+ - [#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
216
+
217
+ ## 0.2.2
218
+
219
+ ### Patch Changes
220
+
221
+ - [#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
222
+
223
+ ## 0.2.1
224
+
225
+ ### Patch Changes
226
+
227
+ - [#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
228
+
229
+ ## 0.2.0
230
+
231
+ ### Minor Changes
232
+
233
+ - [#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
234
+
235
+ ## 0.1.4
236
+
237
+ ### Patch Changes
238
+
239
+ - [#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
240
+
241
+ - [#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
242
+
243
+ - [#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`
244
+
245
+ - [#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
246
+
247
+ ## 0.1.3
248
+
249
+ ### Patch Changes
250
+
251
+ - [#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
252
+
253
+ ## 0.1.2
254
+
255
+ ### Patch Changes
256
+
257
+ - [#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
258
+
259
+ - [#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
260
+
261
+ ## 0.1.1
262
+
263
+ ### Patch Changes
264
+
265
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
266
+
267
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
268
+
3
269
  ## 0.1.0
4
270
 
5
271
  ### Minor Changes
package/Dockerfile CHANGED
@@ -1,80 +1,149 @@
1
- # Sandbox base image with development tools, Python, Node.js, and Bun
2
- FROM ubuntu:22.04
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 with cache mount for npm packages
33
+ RUN --mount=type=cache,target=/root/.npm \
34
+ npm ci
35
+
36
+ # Copy pruned source code
37
+ COPY --from=pruner /app/out/full/ .
38
+
39
+ # Build all packages (Turborepo handles dependency order automatically)
40
+ # This builds @repo/shared first, then @repo/sandbox-container
41
+ RUN npx turbo run build
42
+
43
+ # ============================================================================
44
+ # Stage 3: Install production-only dependencies
45
+ # ============================================================================
46
+ FROM node:20-alpine AS prod-deps
47
+
48
+ WORKDIR /app
49
+
50
+ # Copy package files from builder
51
+ COPY --from=builder /app/package.json ./package.json
52
+ COPY --from=builder /app/package-lock.json ./package-lock.json
53
+ COPY --from=builder /app/packages ./packages
54
+ COPY --from=builder /app/tooling ./tooling
55
+
56
+ # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
57
+ RUN --mount=type=cache,target=/root/.npm \
58
+ npm ci --production
59
+
60
+ # ============================================================================
61
+ # Stage 4: Runtime - Ubuntu 22.04 with only runtime dependencies
62
+ # ============================================================================
63
+ FROM ubuntu:22.04 AS runtime
64
+
65
+ # Accept version as build argument (passed from npm_package_version)
66
+ ARG SANDBOX_VERSION=unknown
3
67
 
4
68
  # Prevent interactive prompts during package installation
5
69
  ENV DEBIAN_FRONTEND=noninteractive
6
70
 
7
- # Install essential system packages and development tools
8
- RUN apt-get update && apt-get install -y \
9
- # Basic utilities
71
+ # Set the sandbox version as an environment variable for version checking
72
+ ENV SANDBOX_VERSION=${SANDBOX_VERSION}
73
+
74
+ # Install essential runtime packages with cache mounts
75
+ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
76
+ --mount=type=cache,target=/var/lib/apt,sharing=locked \
77
+ rm -f /etc/apt/apt.conf.d/docker-clean && \
78
+ echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' >/etc/apt/apt.conf.d/keep-cache && \
79
+ apt-get update && apt-get install -y --no-install-recommends \
10
80
  curl \
11
81
  wget \
82
+ ca-certificates \
83
+ python3.11 \
84
+ python3-pip \
85
+ python3.11-venv \
86
+ procps \
12
87
  git \
13
88
  unzip \
14
89
  zip \
15
- # Process management
16
- procps \
17
- htop \
18
- # Build tools
19
- build-essential \
20
- pkg-config \
21
- # Network tools
22
- net-tools \
23
- iputils-ping \
24
- dnsutils \
25
- # Text processing
26
90
  jq \
27
- vim \
28
- nano \
29
- # Python dependencies
30
- python3.11 \
31
- python3.11-dev \
32
- python3-pip \
33
- # Other useful tools
34
- sudo \
35
- ca-certificates \
36
- gnupg \
37
- lsb-release \
38
- && rm -rf /var/lib/apt/lists/*
91
+ file
39
92
 
40
93
  # Set Python 3.11 as default python3
41
94
  RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
42
95
 
43
- # Install Node.js 22 LTS
44
- # Using the official NodeSource repository setup script
45
- RUN apt-get update && apt-get install -y ca-certificates curl gnupg \
46
- && mkdir -p /etc/apt/keyrings \
47
- && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
48
- && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \
49
- && apt-get update \
96
+ # Install Node.js 20 LTS using official NodeSource setup script
97
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
50
98
  && apt-get install -y nodejs \
51
99
  && rm -rf /var/lib/apt/lists/*
52
100
 
53
- # Install Bun using the official installation script
54
- RUN curl -fsSL https://bun.sh/install | bash \
55
- && mv /root/.bun/bin/bun /usr/local/bin/bun \
56
- && mv /root/.bun/bin/bunx /usr/local/bin/bunx \
57
- && rm -rf /root/.bun
101
+ # Install Bun runtime from official image
102
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
58
103
 
59
- # Install global npm packages as root
60
- RUN npm install -g yarn pnpm
104
+ # Install essential Python packages with cache mount
105
+ RUN --mount=type=cache,target=/root/.cache/pip \
106
+ pip3 install \
107
+ matplotlib \
108
+ numpy \
109
+ pandas \
110
+ ipython
61
111
 
62
- # Set up working directory
63
- WORKDIR /app
112
+ # Set up runtime container server directory
113
+ WORKDIR /container-server
114
+
115
+ # Copy built sandbox-container package
116
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
117
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
64
118
 
65
- # Verify installations
66
- RUN python3 --version && \
67
- node --version && \
68
- npm --version && \
69
- bun --version && \
70
- yarn --version && \
71
- pnpm --version
119
+ # Copy Python executor to runtime location
120
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
72
121
 
73
- # Copy container source files
74
- COPY container_src/ ./
122
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
123
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
124
+ COPY --from=prod-deps /app/node_modules ./node_modules
75
125
 
76
- # Expose the application port
126
+ # Copy workspace packages
127
+ COPY --from=prod-deps /app/packages/shared/dist ./packages/shared/dist
128
+ COPY --from=prod-deps /app/packages/shared/package.json ./packages/shared/package.json
129
+
130
+ # Configure process pool sizes (can be overridden at runtime)
131
+ ENV PYTHON_POOL_MIN_SIZE=3
132
+ ENV PYTHON_POOL_MAX_SIZE=15
133
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
134
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
135
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
136
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
137
+
138
+ # Create clean workspace directory for user code
139
+ RUN mkdir -p /workspace
140
+
141
+ # Expose the application port (3000 for control)
77
142
  EXPOSE 3000
78
143
 
79
- # Run the application
80
- CMD ["bun", "index.ts"]
144
+ # Copy and make startup script executable
145
+ COPY packages/sandbox/startup.sh ./
146
+ RUN chmod +x startup.sh
147
+
148
+ # Use startup script
149
+ CMD ["./startup.sh"]
package/README.md ADDED
@@ -0,0 +1,169 @@
1
+ <img width="1362" height="450" alt="Image" src="https://github.com/user-attachments/assets/6f770ae3-0a14-4d2b-9aed-a304ee5446c5" />
2
+
3
+ # Cloudflare Sandbox SDK
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@cloudflare/sandbox.svg)](https://www.npmjs.com/package/@cloudflare/sandbox)
6
+
7
+ **Build secure, isolated code execution environments on Cloudflare.**
8
+
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
36
+ ```
37
+
38
+ > **Note:** First run builds the Docker container (2-3 minutes). Subsequent runs are much faster.
39
+
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
48
+ ```
49
+
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.
61
+
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
+ };
72
+
73
+ export default {
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
+ }
97
+ };
98
+ ```
99
+
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
+ ## Contributing
120
+
121
+ We welcome contributions from the community! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on:
122
+
123
+ - Setting up your development environment
124
+ - Creating pull requests
125
+ - Code style and testing requirements
126
+
127
+ ## Development
128
+
129
+ This repository contains the SDK source code. Quick start:
130
+
131
+ ```bash
132
+ # Clone the repo
133
+ git clone https://github.com/cloudflare/sandbox-sdk
134
+ cd sandbox-sdk
135
+
136
+ # Install dependencies
137
+ npm install
138
+
139
+ # Run tests
140
+ npm test
141
+
142
+ # Build the project
143
+ npm run build
144
+
145
+ # Type checking and linting
146
+ npm run check
147
+ ```
148
+
149
+ ## Examples
150
+
151
+ See the [examples directory](./examples) for complete working examples:
152
+
153
+ - [Minimal](./examples/minimal) - Basic sandbox setup
154
+ - [Code Interpreter](./examples/code-interpreter) - Use sandbox as an interpreter tool with gpt-oss
155
+
156
+ ## Status
157
+
158
+ **Beta** - The SDK is in active development. APIs may change before v1.0.
159
+
160
+ ## License
161
+
162
+ [MIT License](LICENSE)
163
+
164
+ ## Links
165
+
166
+ - [Documentation](https://developers.cloudflare.com/sandbox/)
167
+ - [GitHub Issues](https://github.com/cloudflare/sandbox-sdk/issues)
168
+ - [Developer Discord](https://discord.cloudflare.com)
169
+ - [Cloudflare Developers](https://twitter.com/CloudflareDev)