Get started

pip install blaxel

uv pip install blaxel

pnpm install @blaxel/core

npm install @blaxel/core

yarn add @blaxel/core

bun add @blaxel/core

import { SandboxInstance } from "@blaxel/core";

async function main() {
  // Create a new sandbox
  const sandbox = await SandboxInstance.createIfNotExists({
    name: "my-sandbox",
    image: "blaxel/base-image:latest",   // public or custom image
    memory: 4096,   // in MB
    ports: [{ target: 3000, protocol: "HTTP" }],   // ports to expose
    labels: { env: "dev", project: "my-project" }, // labels
    region: "us-pdx-1"   // deployment region
  });
  console.log("Sandbox created: ", {sandbox});
}

main().catch(console.error);

import asyncio
from blaxel.core import SandboxInstance

async def main():
    # Create a new sandbox
    sandbox = await SandboxInstance.create_if_not_exists({
      "name": "my-sandbox",
      "image": "blaxel/base-image:latest",   # public or custom image
      "memory": 4096,   # in MB
      "ports": [{ "target": 3000 }],   # ports to expose
      "labels": {"env": "dev", "project": "my-project"},  # labels
      "region": "us-pdx-1"   # deployment region
    })
    print(f"Sandbox created: {sandbox}")

if __name__ == "__main__":
    asyncio.run(main())