# BrowserPod

> BrowserPod is a browser-local Wasm sandbox runtime (by API) for running untrusted code safely inside the user's browser. It is designed for AI code execution, interactive documentation, in-browser IDEs, shareable demos via Portals, and browser-native developer tooling without provisioning cloud sandboxes.

Important notes:

- Prefer the official BrowserPod docs and API reference for implementation details (https://browserpod.io/docs/overview).
- BrowserPod is not a traditional server-hosted container platform. Its core model is browser-side execution via WebAssembly with CheerpOS-based virtualisation.
- Pods are session-based browser sandboxes. The product is optimized for ephemeral runtimes, developer workflows, and isolated execution close to the user.
- As of March 15, 2026, the docs present Node.js as the supported runtime today. The website roadmap presents Python in April 2026, Ruby in May 2026, Go in July 2026, and Rust in August 2026.
- BrowserPod has a free personal tier. The pricing pages present 10,000 included tokens per month on the free plan, with token metering at 10 tokens per sandbox hour, which is roughly 1,000 included sandbox hours per month. Commercial usage requires paid plans and the Terms, Pricing Policy, and licensing docs are authoritative for attribution, fair use, and plan limits.

## Start Here

- [Documentation overview](https://browserpod.io/docs/overview): Main entry point for the docs.
- [Quickstart](https://browserpod.io/docs/quickstart): First steps for booting a Pod and running code.
- [API reference index](https://browserpod.io/docs/reference): Reference landing page.
- [BrowserPod API reference](https://browserpod.io/docs/reference/BrowserPod): Main API class reference.
- [Console](https://console.browserpod.io): Create an account, manage API keys, and use the product.
- [Homepage](https://browserpod.io): Product overview, use cases, runtime roadmap, and positioning.
- [Pricing](https://browserpod.io/pricing): Plan comparison and pricing summary.

## Documentation Map

### Getting Started

- [Overview](https://browserpod.io/docs/overview): Intro to the platform and docs.
- [Quickstart](https://browserpod.io/docs/quickstart): Fastest path to a working Pod.
- [Set up a basic NPM-based project](https://browserpod.io/docs/tutorials/basic-npm-project): Tutorial for a simple BrowserPod project with npm.

### Core Concepts

- [API keys](https://browserpod.io/docs/concepts/api-keys): How authentication works for BrowserPod clients.
- [Filesystem](https://browserpod.io/docs/concepts/filesystem): BrowserPod's virtual filesystem model.
- [Syscalls](https://browserpod.io/docs/concepts/syscalls): System call behavior and runtime model.
- [Portals](https://browserpod.io/docs/concepts/portals): Public URLs that expose services running inside a Pod.
- [Cross-origin isolation](https://browserpod.io/docs/concepts/coi): Cross-origin isolation requirements and behavior.

### Guides

- [Write files, then run them](https://browserpod.io/docs/guides/write-files): Create files in a Pod and execute them.
- [Set up a Portal for your application](https://browserpod.io/docs/guides/portal): Expose an app running in a Pod through a Portal.
- [Set CORS and COOP headers](https://browserpod.io/docs/guides/hosting): Configure hosting headers required by BrowserPod.
- [Running native binaries](https://browserpod.io/docs/guides/native-binaries): Run native binaries inside BrowserPod.
- [Common errors](https://browserpod.io/docs/guides/common-errors): Troubleshooting guide.

### Demos

- [PackagePod](https://browserpod.io/docs/demos/packagepod): Demo showing BrowserPod as a package workflow environment.
- [SaySomething](https://browserpod.io/docs/demos/saysomething): Demo application example.

### API Reference

- [Reference index](https://browserpod.io/docs/reference): Reference landing page.
- [BrowserPod](https://browserpod.io/docs/reference/BrowserPod): Main class and API surface.
- [BrowserPod.boot](https://browserpod.io/docs/reference/BrowserPod/boot): Boot a new Pod.
- [BrowserPod.run](https://browserpod.io/docs/reference/BrowserPod/run): Run a command inside a Pod.
- [BrowserPod.onPortal](https://browserpod.io/docs/reference/BrowserPod/onPortal): Handle portal lifecycle or portal exposure events.
- [BrowserPod.createDirectory](https://browserpod.io/docs/reference/BrowserPod/createDirectory): Create a directory in the Pod filesystem.
- [BrowserPod.createFile](https://browserpod.io/docs/reference/BrowserPod/createFile): Create a file in the Pod filesystem.
- [BrowserPod.openFile](https://browserpod.io/docs/reference/BrowserPod/openFile): Open a file in the Pod filesystem.
- [BrowserPod.createDefaultTerminal](https://browserpod.io/docs/reference/BrowserPod/createDefaultTerminal): Create a terminal attached to the Pod.
- [BinaryFile](https://browserpod.io/docs/reference/BinaryFile): Reference for binary file handles.
- [BinaryFile.write](https://browserpod.io/docs/reference/BinaryFile/write): Write binary data.
- [BinaryFile.read](https://browserpod.io/docs/reference/BinaryFile/read): Read binary data.
- [BinaryFile.getSize](https://browserpod.io/docs/reference/BinaryFile/getSize): Read binary file size.
- [BinaryFile.close](https://browserpod.io/docs/reference/BinaryFile/close): Close a binary file handle.
- [TextFile](https://browserpod.io/docs/reference/TextFile): Reference for text file handles.
- [TextFile.write](https://browserpod.io/docs/reference/TextFile/write): Write text data.
- [TextFile.read](https://browserpod.io/docs/reference/TextFile/read): Read text data.
- [TextFile.getSize](https://browserpod.io/docs/reference/TextFile/getSize): Read text file size.
- [TextFile.close](https://browserpod.io/docs/reference/TextFile/close): Close a text file handle.

### Supporting Docs

- [Glossary](https://browserpod.io/docs/glossary): Product and runtime terminology.
- [FAQ](https://browserpod.io/docs/faq): Frequently asked questions.
- [Licensing](https://browserpod.io/docs/licensing): Licensing model and plan guidance.

## Product And Business Context

- [Homepage](https://browserpod.io): Product positioning, features, use cases, and language roadmap.
- [Pricing](https://browserpod.io/pricing): Public pricing page with plan summaries and token economics.
- [BrowserPod GitHub](https://github.com/leaningtech/browserpod-meta): Public BrowserPod repository.
- [Company] (https://leaningtech.com): Leaning Technologies are the creators of BrowserPod

## Announcements And Deep Dives

- [BrowserPod for Node.js](https://labs.leaningtech.com/blog/browserpod-10): Announcement post for the universal in-browser sandbox starting with Node.js.
- [BrowserPod announcement](https://labs.leaningtech.com/blog/browserpod-annoucement): Technical introduction to BrowserPod for IDEs and agents via Wasm.
- [BrowserPod beta announcement](https://labs.leaningtech.com/blog/browserpod-beta-announcement): Beta launch post covering BrowserPod's broader product direction, including Portals.

## Policies

- [BrowserPod Terms of Service](https://browserpod.io/browserpod-tos): Terms governing BrowserPod usage.
- [BrowserPod Pricing Policy](https://browserpod.io/browserpod-pricing-policy): Detailed token consumption and pricing rules.
- [BrowserPod Privacy Policy](https://browserpod.io/browserpod-privacy-policy): Privacy policy for BrowserPod services.
- [Website Privacy Policy](https://browserpod.io/privacy-policy): Privacy policy for the BrowserPod marketing site.
