@boxfab/code-interpreter
v0.1.0-alpha.2
Published
BoxFab Code Interpreter: run AI-generated code in BoxFab sandboxes, Jupyter-style
Readme
BoxFab Code Interpreter (JavaScript / TypeScript)
Run AI-generated code in isolated BoxFab sandboxes, Jupyter-style: Python, JavaScript, TypeScript, R, Java and Bash, with results such as text, tables and charts returned as data.
Getting started
1. Install the SDK
npm install @boxfab/code-interpreter2. Get a BoxFab API key
Get a key from the BoxFab dashboard and set it as BOXFAB_API_KEY.
The SDK reads only BOXFAB_* variables.
3. Execute code with code interpreter inside Sandbox
import { Sandbox } from '@boxfab/code-interpreter'
const sbx = await Sandbox.create()
await sbx.runCode('x = 1')
const execution = await sbx.runCode('x+=1; x')
console.log(execution.text) // outputs 24. Bind the configuration to a client
The top-level Sandbox export reads its configuration from the environment variables. To use an explicit configuration — e.g. several API keys or domains in one process — create a BoxFab client and use the resources it exposes:
import { BoxFab } from '@boxfab/code-interpreter'
const client = new BoxFab({ apiKey: 'e2b_***', domain: 'us-west.boxfab.dev' })
const sbx = await client.Sandbox.create()
const execution = await sbx.runCode('x = 1; x += 1; x')
// The core resources are bound to the client's configuration as well.
const volume = await client.Volume.create('my-volume')
const exists = await client.Template.exists('my-template')
await client.Secret.create('openai-api-key', 'sk-***')
// The classes can be destructured and used like the top-level ones.
const { Sandbox } = client
const paginator = Sandbox.list()Per-call options still take precedence over the client's options, and clients are isolated from each other and from the env-configured top-level exports.
Under the hood
Sandboxes are created from the code-interpreter-v1 template, which BoxFab provides to every team:
a Jupyter server with common data-science packages. BoxFab sandboxes are
Firecracker microVMs, run on the open-source
E2B sandbox infrastructure. This package is derived from the
open-source E2B Code Interpreter SDK;
UPSTREAM.md lists every change.
Using the E2B Code Interpreter SDKs. BoxFab serves the same API and provides the
code-interpreter-v1 template, so the E2B Code Interpreter SDKs work with it as well. Set both
variables, the domain first:
export E2B_DOMAIN=us-west.boxfab.dev
export E2B_API_KEY="<your BoxFab API key>"Without E2B_DOMAIN, the E2B SDKs send requests, including the key, to E2B's own service.
Tested against BoxFab with e2b-code-interpreter 2.11.6 (Python) and @e2b/code-interpreter 2.9.0
(JavaScript).
License
MIT, as the E2B Code Interpreter SDK it is derived from; see LICENSE.
BoxFab is a product of ContextFab, Inc.
