77 </p >
88</div >
99
10- <!-- toc -->
11-
12- - [ ✨ Overview] ( #%E2%9C%A8-overview )
13- - [ 🎯 Features] ( #%F0%9F%8E%AF-features )
14- - [ 🚀 Quick Start] ( #%F0%9F%9A%80-quick-start )
15- - [ 📚 API Reference] ( #%F0%9F%93%9A-api-reference )
16- - [ 🌐 Port Forwarding] ( #%F0%9F%8C%90-port-forwarding )
17- - [ 💡 Examples] ( #%F0%9F%92%A1-examples )
18- - [ 🏗️ Architecture] ( #%F0%9F%8F%97%EF%B8%8F-architecture )
19- - [ 🛠️ Advanced Usage] ( #%F0%9F%9B%A0%EF%B8%8F-advanced-usage )
20- - [ 🔍 Debugging] ( #%F0%9F%94%8D-debugging )
21- - [ 🚧 Known Limitations] ( #%F0%9F%9A%A7-known-limitations )
22- - [ 🤝 Contributing] ( #%F0%9F%A4%9D-contributing )
23- - [ 📄 License] ( #%F0%9F%93%84-license )
24- - [ 🙌 Acknowledgments] ( #%F0%9F%99%8C-acknowledgments )
25-
26- <!-- tocstop -->
27-
28- ## ✨ Overview
10+ <!-- START doctoc generated TOC please keep comment here to allow auto update -->
11+ <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
12+
13+ - [ ✨ Overview] ( #overview )
14+ - [ 🎯 Features] ( #features )
15+ - [ 🚀 Quick Start] ( #quick-start )
16+ - [ Installation] ( #installation )
17+ - [ Basic Setup] ( #basic-setup )
18+ - [ 📚 API Reference] ( #api-reference )
19+ - [ Core Methods] ( #core-methods )
20+ - [ 🌐 Port Forwarding] ( #port-forwarding )
21+ - [ Utility Methods] ( #utility-methods )
22+ - [ 💡 Examples] ( #examples )
23+ - [ Run a Node.js App] ( #run-a-nodejs-app )
24+ - [ Build and Test Code] ( #build-and-test-code )
25+ - [ Interactive Development Environment] ( #interactive-development-environment )
26+ - [ Expose Services with Preview URLs] ( #expose-services-with-preview-urls )
27+ - [ 🏗️ Architecture] ( #architecture )
28+ - [ 🛠️ Advanced Usage] ( #advanced-usage )
29+ - [ AsyncIterable Streaming Support] ( #asynciterable-streaming-support )
30+ - [ Session Management] ( #session-management )
31+ - [ 🔍 Debugging] ( #debugging )
32+ - [ 🚧 Known Limitations] ( #known-limitations )
33+ - [ 🤝 Contributing] ( #contributing )
34+ - [ 📄 License] ( #license )
35+ - [ 🙌 Acknowledgments] ( #acknowledgments )
36+
37+ <!-- END doctoc generated TOC please keep comment here to allow auto update -->
38+
39+ <h2 id =" overview " >✨ Overview</h2 >
2940
3041The Cloudflare Sandbox SDK enables you to run isolated code environments directly on Cloudflare's edge network using Durable Objects and the Cloudflare Containers. Execute commands, manage files, run services, and expose them via public URLs - all within secure, sandboxed containers.
3142
32- ## 🎯 Features
43+ < h2 id = " features " > 🎯 Features</ h2 >
3344
3445- ** 🔒 Secure Isolation** : Each sandbox runs in its own container with full process isolation
3546- ** ⚡ Edge-Native** : Runs on Cloudflare's global network for low latency worldwide
@@ -40,7 +51,7 @@ The Cloudflare Sandbox SDK enables you to run isolated code environments directl
4051- ** 🚀 Streaming Support** : Real-time output streaming for long-running commands
4152- ** 🎮 Session Management** : Maintain state across multiple operations
4253
43- ## 🚀 Quick Start
54+ < h2 id = " quick-start " > 🚀 Quick Start</ h2 >
4455
4556### Installation
4657
@@ -113,7 +124,7 @@ export default {
113124};
114125```
115126
116- ## 📚 API Reference
127+ < h2 id = " api-reference " > 📚 API Reference</ h2 >
117128
118129### Core Methods
119130
@@ -217,7 +228,7 @@ await sandbox.gitCheckout("https://github.com/user/repo", {
217228- ` unexposePort(port) ` - Remove port exposure
218229- ` getExposedPorts() ` - List all exposed ports with their URLs
219230
220- ## 🌐 Port Forwarding
231+ < h2 id = " port-forwarding " > 🌐 Port Forwarding</ h2 >
221232
222233The SDK automatically handles preview URL routing for exposed ports. Just add one line to your worker:
223234
@@ -276,7 +287,7 @@ For more details, see the [Cloudflare Containers local development guide](https:
276287- ` ping() ` - Health check for the sandbox
277288- ` containerFetch(request) ` - Direct container communication
278289
279- ## 💡 Examples
290+ < h2 id = " examples " > 💡 Examples</ h2 >
280291
281292### Run a Node.js App
282293
@@ -375,7 +386,7 @@ console.log(`Service available at: ${preview.url}`);
375386// See the example in examples/basic/src/index.ts for the routing implementation.
376387```
377388
378- ## 🏗️ Architecture
389+ < h2 id = " architecture " > 🏗️ Architecture</ h2 >
379390
380391The SDK leverages Cloudflare's infrastructure:
381392
@@ -384,7 +395,7 @@ The SDK leverages Cloudflare's infrastructure:
384395- ** Workers** : Handles HTTP routing and API interface
385396- ** Edge Network** : Enables global distribution and low latency
386397
387- ## 🛠️ Advanced Usage
398+ < h2 id = " advanced-usage " > 🛠️ Advanced Usage</ h2 >
388399
389400### AsyncIterable Streaming Support
390401
@@ -474,7 +485,7 @@ await sandbox.exec("npm install", { sessionId });
474485const app = await sandbox .startProcess (" npm start" , { sessionId });
475486```
476487
477- ## 🔍 Debugging
488+ < h2 id = " debugging " > 🔍 Debugging</ h2 >
478489
479490Enable verbose logging:
480491
@@ -487,13 +498,13 @@ sandbox.client.onCommandComplete = (success, code) =>
487498 console .log (` Completed: ${success } (${code }) ` );
488499```
489500
490- ## 🚧 Known Limitations
501+ < h2 id = " known-limitations " > 🚧 Known Limitations</ h2 >
491502
492503- Maximum container runtime is limited by Durable Object constraints
493504- WebSocket support for preview URLs coming soon
494505- Some system calls may be restricted in the container environment
495506
496- ## 🤝 Contributing
507+ < h2 id = " contributing " > 🤝 Contributing</ h2 >
497508
498509We welcome contributions! Please see our [ Contributing Guide] ( CONTRIBUTING.md ) for details.
499510
@@ -512,11 +523,11 @@ npm test
512523npm run build
513524```
514525
515- ## 📄 License
526+ < h2 id = " license " > 📄 License</ h2 >
516527
517528[ MIT License] ( LICENSE )
518529
519- ## 🙌 Acknowledgments
530+ < h2 id = " acknowledgments " > 🙌 Acknowledgments</ h2 >
520531
521532Built with ❤️ by the Cloudflare team. Special thanks to all early adopters and contributors.
522533
0 commit comments