@cloudflare/sandbox 0.0.0-60af265 → 0.0.0-633bd10

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 (79) hide show
  1. package/CHANGELOG.md +189 -0
  2. package/Dockerfile +166 -9
  3. package/README.md +149 -50
  4. package/dist/chunk-BCJ7SF3Q.js +117 -0
  5. package/dist/chunk-BCJ7SF3Q.js.map +1 -0
  6. package/dist/chunk-BFVUNTP4.js +104 -0
  7. package/dist/chunk-BFVUNTP4.js.map +1 -0
  8. package/dist/chunk-EKSWCBCA.js +86 -0
  9. package/dist/chunk-EKSWCBCA.js.map +1 -0
  10. package/dist/chunk-HGF554LH.js +2236 -0
  11. package/dist/chunk-HGF554LH.js.map +1 -0
  12. package/dist/chunk-Z532A7QC.js +78 -0
  13. package/dist/chunk-Z532A7QC.js.map +1 -0
  14. package/dist/file-stream.d.ts +43 -0
  15. package/dist/file-stream.js +9 -0
  16. package/dist/file-stream.js.map +1 -0
  17. package/dist/index.d.ts +9 -0
  18. package/dist/index.js +55 -0
  19. package/dist/index.js.map +1 -0
  20. package/dist/interpreter.d.ts +33 -0
  21. package/dist/interpreter.js +8 -0
  22. package/dist/interpreter.js.map +1 -0
  23. package/dist/request-handler.d.ts +18 -0
  24. package/dist/request-handler.js +12 -0
  25. package/dist/request-handler.js.map +1 -0
  26. package/dist/sandbox-D9K2ypln.d.ts +583 -0
  27. package/dist/sandbox.d.ts +4 -0
  28. package/dist/sandbox.js +12 -0
  29. package/dist/sandbox.js.map +1 -0
  30. package/dist/security.d.ts +31 -0
  31. package/dist/security.js +13 -0
  32. package/dist/security.js.map +1 -0
  33. package/dist/sse-parser.d.ts +28 -0
  34. package/dist/sse-parser.js +11 -0
  35. package/dist/sse-parser.js.map +1 -0
  36. package/package.json +11 -9
  37. package/src/clients/base-client.ts +280 -0
  38. package/src/clients/command-client.ts +115 -0
  39. package/src/clients/file-client.ts +269 -0
  40. package/src/clients/git-client.ts +92 -0
  41. package/src/clients/index.ts +63 -0
  42. package/src/clients/interpreter-client.ts +329 -0
  43. package/src/clients/port-client.ts +105 -0
  44. package/src/clients/process-client.ts +177 -0
  45. package/src/clients/sandbox-client.ts +41 -0
  46. package/src/clients/types.ts +84 -0
  47. package/src/clients/utility-client.ts +94 -0
  48. package/src/errors/adapter.ts +180 -0
  49. package/src/errors/classes.ts +469 -0
  50. package/src/errors/index.ts +105 -0
  51. package/src/file-stream.ts +164 -0
  52. package/src/index.ts +83 -126
  53. package/src/interpreter.ts +159 -0
  54. package/src/request-handler.ts +170 -0
  55. package/src/sandbox.ts +917 -0
  56. package/src/security.ts +104 -0
  57. package/src/sse-parser.ts +143 -0
  58. package/startup.sh +3 -0
  59. package/tests/base-client.test.ts +328 -0
  60. package/tests/command-client.test.ts +407 -0
  61. package/tests/file-client.test.ts +643 -0
  62. package/tests/file-stream.test.ts +306 -0
  63. package/tests/git-client.test.ts +328 -0
  64. package/tests/port-client.test.ts +301 -0
  65. package/tests/process-client.test.ts +658 -0
  66. package/tests/sandbox.test.ts +465 -0
  67. package/tests/sse-parser.test.ts +290 -0
  68. package/tests/utility-client.test.ts +266 -0
  69. package/tests/wrangler.jsonc +35 -0
  70. package/tsconfig.json +9 -1
  71. package/vitest.config.ts +31 -0
  72. package/container_src/index.ts +0 -2906
  73. package/container_src/package.json +0 -9
  74. package/src/client.ts +0 -1960
  75. package/tests/client.example.ts +0 -308
  76. package/tests/connection-test.ts +0 -81
  77. package/tests/simple-test.ts +0 -81
  78. package/tests/test1.ts +0 -281
  79. package/tests/test2.ts +0 -929
package/CHANGELOG.md CHANGED
@@ -1,5 +1,194 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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
8
+
9
+ ## 0.4.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#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.
14
+
15
+ ### Patch Changes
16
+
17
+ - [#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
18
+
19
+ ## 0.3.3
20
+
21
+ ### Patch Changes
22
+
23
+ - [#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
24
+
25
+ ## 0.3.2
26
+
27
+ ### Patch Changes
28
+
29
+ - [#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.
30
+
31
+ ## 0.3.1
32
+
33
+ ### Patch Changes
34
+
35
+ - [#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
36
+
37
+ - [#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
38
+
39
+ - [#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
40
+
41
+ - [#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.
42
+
43
+ ## 0.3.0
44
+
45
+ ### Minor Changes
46
+
47
+ - [#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
48
+
49
+ 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.
50
+
51
+ **Key security improvements:**
52
+
53
+ - Control plane processes are hidden from sandboxed commands
54
+ - Platform secrets in `/proc/1/environ` are inaccessible
55
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
56
+
57
+ **Breaking changes:**
58
+
59
+ 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.
60
+
61
+ ```javascript
62
+ // Before: manual session management
63
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
64
+
65
+ // After: automatic session per sandbox
66
+ await sandbox.exec("cd /app");
67
+ ```
68
+
69
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
70
+
71
+ ```javascript
72
+ // Before: each exec was independent
73
+ await sandbox.exec("cd /app");
74
+ await sandbox.exec("pwd"); // Output: /workspace
75
+
76
+ // After: state persists in session
77
+ await sandbox.exec("cd /app");
78
+ await sandbox.exec("pwd"); // Output: /app
79
+ ```
80
+
81
+ **Migration guide:**
82
+
83
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
84
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
85
+ ```javascript
86
+ // Create independent sessions with different environments
87
+ const buildSession = await sandbox.createSession({
88
+ name: "build",
89
+ env: { NODE_ENV: "production" },
90
+ cwd: "/build",
91
+ });
92
+ const testSession = await sandbox.createSession({
93
+ name: "test",
94
+ env: { NODE_ENV: "test" },
95
+ cwd: "/test",
96
+ });
97
+ ```
98
+ - Environment variables set in one command persist to the next
99
+ - Background processes remain active until explicitly killed
100
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
101
+
102
+ ### Patch Changes
103
+
104
+ - [#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
105
+
106
+ ## 0.2.4
107
+
108
+ ### Patch Changes
109
+
110
+ - [#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
111
+
112
+ ## 0.2.3
113
+
114
+ ### Patch Changes
115
+
116
+ - [#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
117
+
118
+ ## 0.2.2
119
+
120
+ ### Patch Changes
121
+
122
+ - [#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
123
+
124
+ ## 0.2.1
125
+
126
+ ### Patch Changes
127
+
128
+ - [#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
129
+
130
+ ## 0.2.0
131
+
132
+ ### Minor Changes
133
+
134
+ - [#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
135
+
136
+ ## 0.1.4
137
+
138
+ ### Patch Changes
139
+
140
+ - [#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
141
+
142
+ - [#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
143
+
144
+ - [#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`
145
+
146
+ - [#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
147
+
148
+ ## 0.1.3
149
+
150
+ ### Patch Changes
151
+
152
+ - [#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
153
+
154
+ ## 0.1.2
155
+
156
+ ### Patch Changes
157
+
158
+ - [#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
159
+
160
+ - [#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
161
+
162
+ ## 0.1.1
163
+
164
+ ### Patch Changes
165
+
166
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
167
+
168
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
169
+
170
+ ## 0.1.0
171
+
172
+ ### Minor Changes
173
+
174
+ - [#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
175
+
176
+ ### Patch Changes
177
+
178
+ - [#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
179
+
180
+ ## 0.0.9
181
+
182
+ ### Patch Changes
183
+
184
+ - [#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
185
+
186
+ ## 0.0.8
187
+
188
+ ### Patch Changes
189
+
190
+ - [`60af265`](https://github.com/cloudflare/sandbox-sdk/commit/60af265d834e83fd30a921a3e1be232f13fe24da) Thanks [@threepointone](https://github.com/threepointone)! - update dependencies
191
+
3
192
  ## 0.0.7
4
193
 
5
194
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,16 +1,173 @@
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 full development environment
60
+ # ============================================================================
61
+ FROM ubuntu:22.04 AS runtime
9
62
 
10
- COPY container_src/* ./
11
- # RUN bun install
63
+ # Prevent interactive prompts during package installation
64
+ ENV DEBIAN_FRONTEND=noninteractive
12
65
 
66
+ # Install essential system packages and development tools
67
+ RUN apt-get update && apt-get install -y \
68
+ # Basic utilities
69
+ curl \
70
+ wget \
71
+ git \
72
+ unzip \
73
+ zip \
74
+ file \
75
+ # Process management
76
+ procps \
77
+ htop \
78
+ # Build tools
79
+ build-essential \
80
+ pkg-config \
81
+ # Network tools
82
+ net-tools \
83
+ iputils-ping \
84
+ dnsutils \
85
+ # Text processing
86
+ jq \
87
+ vim \
88
+ nano \
89
+ # Python dependencies
90
+ python3.11 \
91
+ python3.11-dev \
92
+ python3-pip \
93
+ python3.11-venv \
94
+ # Other useful tools
95
+ ca-certificates \
96
+ gnupg \
97
+ lsb-release \
98
+ strace \
99
+ && rm -rf /var/lib/apt/lists/*
100
+
101
+ # Set Python 3.11 as default python3
102
+ RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
103
+
104
+ # Install Node.js 20 LTS using official NodeSource setup script
105
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
106
+ && apt-get install -y nodejs \
107
+ && rm -rf /var/lib/apt/lists/*
108
+
109
+ # Install Bun runtime from official image
110
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
111
+ COPY --from=oven/bun:1 /usr/local/bin/bunx /usr/local/bin/bunx
112
+
113
+ # Install development tools globally
114
+ RUN npm install -g \
115
+ wrangler \
116
+ vite \
117
+ opencode-ai
118
+
119
+ # Install essential Python packages for code execution
120
+ RUN pip3 install --no-cache-dir \
121
+ matplotlib \
122
+ numpy \
123
+ pandas \
124
+ ipython
125
+
126
+ # Verify installations
127
+ RUN python3 --version && \
128
+ node --version && \
129
+ npm --version && \
130
+ bun --version
131
+
132
+ # Set up runtime container server directory
133
+ WORKDIR /container-server
134
+
135
+ # Copy built sandbox-container package
136
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
137
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
138
+
139
+ # Copy Python executor to runtime location
140
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
141
+
142
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
143
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
144
+ COPY --from=prod-deps /app/node_modules ./node_modules
145
+
146
+ # Copy workspace packages so node_modules symlinks work
147
+ # @repo/shared and @repo/typescript-config are symlinked in node_modules
148
+ COPY --from=prod-deps /app/packages/shared ./packages/shared
149
+ COPY --from=prod-deps /app/tooling/typescript-config ./tooling/typescript-config
150
+
151
+ # Configure process pool sizes (can be overridden at runtime)
152
+ ENV PYTHON_POOL_MIN_SIZE=3
153
+ ENV PYTHON_POOL_MAX_SIZE=15
154
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
155
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
156
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
157
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
158
+
159
+ # Create clean workspace directory for user code
160
+ # Architecture:
161
+ # /container-server/ - SDK infrastructure (server, executors, dependencies)
162
+ # /workspace/ - User's clean workspace for their code
163
+ RUN mkdir -p /workspace
164
+
165
+ # Expose the application port (3000 for control)
13
166
  EXPOSE 3000
14
- # Run
15
- CMD ["bun", "index.ts"]
16
167
 
168
+ # Copy and make startup script executable
169
+ COPY packages/sandbox/startup.sh ./
170
+ RUN chmod +x startup.sh
171
+
172
+ # Use startup script
173
+ CMD ["./startup.sh"]
package/README.md CHANGED
@@ -1,65 +1,164 @@
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
+ > **Note:** The latest published version of the SDK is on the [v03 branch](https://github.com/cloudflare/sandbox-sdk/tree/v03). This main branch is currently the development version and is not yet published.
14
+
15
+ ## Getting Started
16
+
17
+ ### Prerequisites
18
+
19
+ 1. Install [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (version 16.17.0 or later)
20
+ 2. Ensure Docker is running locally
21
+ 3. For deploying to production, sign up for a [Cloudflare account](https://dash.cloudflare.com/sign-up/workers-and-pages)
22
+
23
+ ### 1. Create a new project
24
+
25
+ Create a new Sandbox SDK project using the minimal template:
26
+
27
+ ```bash
28
+ npm create cloudflare@latest -- my-sandbox --template=cloudflare/sandbox-sdk/examples/minimal
29
+ cd my-sandbox
30
+ ```
31
+
32
+ ### 2. Test locally
33
+
34
+ Start the development server:
35
+
36
+ ```bash
37
+ npm run dev
34
38
  ```
35
39
 
36
- Then, export the Sandbox class in your worker:
40
+ > **Note:** First run builds the Docker container (2-3 minutes). Subsequent runs are much faster.
41
+
42
+ Test the endpoints:
43
+
44
+ ```bash
45
+ # Execute Python code
46
+ curl http://localhost:8787/run
47
+
48
+ # File operations
49
+ curl http://localhost:8787/file
50
+ ```
51
+
52
+ ### 3. Deploy to production
53
+
54
+ Deploy your Worker and container:
37
55
 
38
- ```ts
39
- export { Sandbox } from "@cloudflare/sandbox";
56
+ ```bash
57
+ npx wrangler deploy
40
58
  ```
41
59
 
42
- You can then use the Sandbox class in your worker:
60
+ > **Wait for provisioning:** After first deployment, wait 2-3 minutes before making requests.
43
61
 
44
- ```ts
45
- import { getSandbox } from "@cloudflare/sandbox";
62
+ **📖 [View the complete getting started guide](https://developers.cloudflare.com/sandbox/get-started/)** for detailed instructions and explanations.
63
+
64
+ ## Quick API Example
65
+
66
+ ```typescript
67
+ import { getSandbox, proxyToSandbox, type Sandbox } from '@cloudflare/sandbox';
68
+
69
+ export { Sandbox } from '@cloudflare/sandbox';
70
+
71
+ type Env = {
72
+ Sandbox: DurableObjectNamespace<Sandbox>;
73
+ };
46
74
 
47
75
  export default {
48
- async fetch(request: Request, env: Env) {
49
- const sandbox = getSandbox(env.Sandbox, "my-sandbox");
50
- return sandbox.exec("ls", ["-la"]);
51
- },
76
+ async fetch(request: Request, env: Env): Promise<Response> {
77
+ // Required for preview URLs
78
+ const proxyResponse = await proxyToSandbox(request, env);
79
+ if (proxyResponse) return proxyResponse;
80
+
81
+ const url = new URL(request.url);
82
+ const sandbox = getSandbox(env.Sandbox, 'my-sandbox');
83
+
84
+ // Execute Python code
85
+ if (url.pathname === '/run') {
86
+ const result = await sandbox.exec('python3 -c "print(2 + 2)"');
87
+ return Response.json({ output: result.stdout, success: result.success });
88
+ }
89
+
90
+ // Work with files
91
+ if (url.pathname === '/file') {
92
+ await sandbox.writeFile('/workspace/hello.txt', 'Hello, Sandbox!');
93
+ const file = await sandbox.readFile('/workspace/hello.txt');
94
+ return Response.json({ content: file.content });
95
+ }
96
+
97
+ return new Response('Try /run or /file');
98
+ }
52
99
  };
53
100
  ```
54
101
 
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.
102
+ ## Documentation
103
+
104
+ **📖 [Full Documentation](https://developers.cloudflare.com/sandbox/)**
105
+
106
+ - [Get Started Guide](https://developers.cloudflare.com/sandbox/get-started/) - Step-by-step tutorial
107
+ - [API Reference](https://developers.cloudflare.com/sandbox/api/) - Complete API docs
108
+ - [Guides](https://developers.cloudflare.com/sandbox/guides/) - Execute commands, manage files, expose services
109
+ - [Examples](https://developers.cloudflare.com/sandbox/tutorials/) - AI agents, data analysis, CI/CD pipelines
110
+
111
+ ## Key Features
112
+
113
+ - **Secure Isolation** - Each sandbox runs in its own container
114
+ - **Edge-Native** - Runs on Cloudflare's global network
115
+ - **Code Interpreter** - Execute Python and JavaScript with rich outputs
116
+ - **File System Access** - Read, write, and manage files
117
+ - **Command Execution** - Run any command with streaming support
118
+ - **Preview URLs** - Expose services with public URLs
119
+ - **Git Integration** - Clone repositories directly
120
+
121
+ ## Development
122
+
123
+ This repository contains the SDK source code. To contribute:
124
+
125
+ ```bash
126
+ # Clone the repo
127
+ git clone https://github.com/cloudflare/sandbox-sdk
128
+ cd sandbox-sdk
129
+
130
+ # Install dependencies
131
+ npm install
132
+
133
+ # Run tests
134
+ npm test
135
+
136
+ # Build the project
137
+ npm run build
138
+
139
+ # Type checking and linting
140
+ npm run check
141
+ ```
142
+
143
+ ## Examples
144
+
145
+ See the [examples directory](./examples) for complete working examples:
146
+
147
+ - [Minimal](./examples/minimal) - Basic sandbox setup
148
+ - [Code Interpreter](./examples/code-interpreter) - Use sandbox as an interpreter tool with gpt-oss
149
+ - [Complete](./examples/basic) - Huge example integrated with every sandbox feature
150
+
151
+ ## Status
152
+
153
+ **Beta** - The SDK is in active development. APIs may change before v1.0.
154
+
155
+ ## License
156
+
157
+ [MIT License](LICENSE)
158
+
159
+ ## Links
160
+
161
+ - [Documentation](https://developers.cloudflare.com/sandbox/)
162
+ - [GitHub Issues](https://github.com/cloudflare/sandbox-sdk/issues)
163
+ - [Developer Discord](https://discord.cloudflare.com)
164
+ - [Cloudflare Developers](https://twitter.com/CloudflareDev)