Borealis Docs
Borealis documentation
Give your code a place to run commands, work with files, and start services, whether you drive it yourself or an agent does. These guides cover the web app, the public API, and the tools built on it.
Start with a working sandbox
Follow Create your first sandbox to choose an image, run a command, and stop the environment when you are finished. You can use the Borealis app or the official CLI.
A sandbox is a managed execution environment with an image, resource allocation, lifecycle, and workspace. A host pool is the capacity on which sandboxes run. Access depends on your account, organisation, permissions, and plan.
Find the right guide
| I want to… | Read |
|---|---|
| Create, start, stop, or remove an environment | Sandbox lifecycle |
| Reuse a configuration or private image | Images, registries, and templates |
| Run a script or open a terminal | Commands and terminals |
| Reach a service running inside a sandbox | Ports and previews |
| Preserve an installed environment | Environment snapshots |
| Move files into or out of a workspace | Workspace transfers |
| Bring my own compute capacity | Host pools |
| Integrate an application or agent | Public API · MCP |
Know what is being preserved
An environment snapshot and a workspace archive solve different problems. Snapshots preserve supported environment state; workspace transfers move files under /workspace. Neither captures a running process’s memory. Read both guides before treating either as a recovery plan.
Operate with confidence
Use authentication and organisations to understand access, usage and billing to understand resource limits, and troubleshooting when an operation does not finish as expected. The blog covers product announcements and engineering stories.