Flexbe Sandbox SDK

A TypeScript SDK for communicating with Flexbe Sandbox Controller, providing the same API structure as CodeSandbox SDK.

Installation

npm install @flexbe/sandbox-sdk

Quick Start

import { SandboxSDK } from '@flexbe/sandbox-sdk';

const client = new SandboxSDK({
    id: 'my-sandbox',
    url: 'http://localhost:8080',
    token: 'your-auth-token'
});

// Test connection
const isConnected = await client.ping();
console.log('Connected:', isConnected);

Documentation

• Getting Started
• Commands API
• Tasks API
• File System API
• Ports API
• WebSocket & Events
• Examples

Examples

To run the examples:

# Run filesystem operations demo
bun examples/filesystem.ts

# Run commands demo
bun examples/commands.ts

# Run ports demo
bun examples/ports.ts

# Run WebSocket demo
bun examples/websocket-test.ts

# Run heartbeat & connection monitoring demo
bun examples/heartbeat-demo.ts

# Run simple file watching test
bun examples/simple-watch-test.ts