Node.js Quick Start

Installation

npm install @boxlite-ai/boxlite

Requirements:

Node.js 18 or later
Platform with hardware virtualization (see Installation)

Verify Installation:

import { SimpleBox } from '@boxlite-ai/boxlite';
console.log('BoxLite loaded successfully');

Basic Execution

Create a file hello.js

import { SimpleBox } from '@boxlite-ai/boxlite';

async function main() {
  const box = new SimpleBox({ image: 'python:slim' });
  try {
    const result = await box.exec('python', '-c', "print('Hello from BoxLite!')");
    console.log(result.stdout);
  } finally {
    await box.stop();
  }
}

main();

Run it

node hello.js

What’s happening:

BoxLite pulls the python:slim OCI image (first run only)
Creates a lightweight VM with the image
Executes the Python command inside the VM
Streams output back to your application
Cleans up when stop() is called

TypeScript 5.2+ (Async Disposal)

import { SimpleBox } from '@boxlite-ai/boxlite';

async function main() {
  await using box = new SimpleBox({ image: 'alpine:latest' });
  const result = await box.exec('echo', 'Hello!');
  console.log(result.stdout);
  // Box automatically stopped when leaving scope
}

main();

Code Execution (AI Agents)

Create a file codebox.js

import { CodeBox } from '@boxlite-ai/boxlite';

async function main() {
  const codebox = new CodeBox();
  try {
    // Execute untrusted code safely
    const code = `
import requests
response = requests.get('https://api.github.com/zen')
print(response.text)
`;
    const result = await codebox.run(code);
    console.log(result);
  } finally {
    await codebox.stop();
  }
}

main();

Run it

node codebox.js

What’s happening:

CodeBox automatically installs required packages (requests)
Executes the code in complete isolation
Returns the output as a string
Your host system remains completely safe

Running Examples

BoxLite includes 5 Node.js examples:

Clone and build the SDK

# Clone the repository
git clone https://github.com/boxlite-ai/boxlite.git
cd boxlite/sdks/node

# Build the SDK
npm install && npm run build
npm link

Run the examples

cd ../../examples/node
npm link @boxlite-ai/boxlite

node simplebox.js
node codebox.js
node browserbox.js
node computerbox.js
node interactivebox.js

Examples overview:

#	Example	Description
1	simplebox.js	Basic command execution
2	codebox.js	Python code execution sandbox
3	browserbox.js	Browser automation with CDP
4	computerbox.js	Desktop automation (mouse, keyboard, screenshots)
5	interactivebox.js	Interactive terminal sessions

Next Steps

Core concepts

Understand the different box types (SimpleBox, CodeBox, BrowserBox, and more), lifecycle, images, and resource configuration.

Execute AI-generated code

Learn to use CodeBox for safe code execution — auto-install packages, run untrusted code, and capture output.

Node.js SDK Reference

Complete API reference for SimpleBox, CodeBox, BrowserBox, ComputerBox, and more.

Getting Started

Tutorials

Guides

SDK Reference

Architecture

Resources

Development

Installation

Basic Execution

TypeScript 5.2+ (Async Disposal)

Code Execution (AI Agents)

Running Examples

Next Steps

Core concepts

Execute AI-generated code

Node.js SDK Reference

​Installation

​Basic Execution

​TypeScript 5.2+ (Async Disposal)

​Code Execution (AI Agents)

​Running Examples

​Next Steps

Core concepts

Execute AI-generated code

Node.js SDK Reference

Installation

Basic Execution

TypeScript 5.2+ (Async Disposal)

Code Execution (AI Agents)

Running Examples

Next Steps