Expand description
§tinysandbox
An ultra-minimal, Linux-like sandbox for AI agents — a shell, coreutils, a filesystem, and a secure JavaScript runtime in a single Rust crate, with no containers, no VMs, and no access to the host.
§Rust
use tinysandbox::sandbox::Sandbox;
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder().build();
sandbox
.exec("echo 'hello from the sandbox' > /workspace/greeting.txt")
.await;
let result = sandbox
.exec("cat /workspace/greeting.txt | grep -c sandbox")
.await;
assert_eq!(result.stdout, "1\n");
}§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox()
await sandbox.exec("echo 'hello from the sandbox' > /workspace/greeting.txt")
const result = await sandbox.exec('cat /workspace/greeting.txt | grep -c sandbox')
console.assert(result.stdout === '1\n')§Table of contents
- Why
- Quickstart
- What’s inside
- Prompt chunks
- Custom commands
- JavaScript host capabilities
- Filesystem backends
- Filesystem mounts
- Local directory VFS
- S3 VFS
- Bring your own VFS
- Snapshots
- Limits and observability
- Security model
- Comparison with just-bash
- Performance
- Feature flags
- Examples
- License
§Why
Agents are good at bash and JavaScript because the training data is full of both. But giving an agent a real shell means giving it your filesystem, your network, and your process table — so the usual answer is a container or a microVM, which costs seconds of startup, megabytes of memory per instance, and an orchestration layer you now own.
tinysandbox takes a different trade. It executes a bash-compatible shell and GNU-faithful coreutils natively in your process against a virtual filesystem, and runs agent-authored JavaScript and jq filters inside Wasmtime with enforced guest memory limits and CPU interruption. The result:
- Boot is instant and idle sandboxes cost kilobytes. A
Sandboxis a plain struct around an in-memory filesystem.echo hello > out.txtis microseconds — no VM, no fork/exec, no syscall filter. - The happy path feels exactly like Linux. Supported commands, flags,
and JS APIs match their GNU/bash/Node counterparts precisely (verified
against the real tools in the test suite). You don’t have to tell your
agent it’s in a special environment — probing with
ls /binorwhich grepbehaves like it would anywhere else. - Everything outside the subset fails loudly. Unsupported flags, shell constructs, and JS APIs produce clear errors, never silently different behavior.
- The host stays unreachable. Files live in a quota-enforced VFS. JS runs in a WebAssembly guest whose module has no filesystem imports at all — there is no code path from a script to your disk or network.
§Quickstart
cargo add tinysandbox tokio
npm i @tinysandbox/tinysandbox§Rust
use tinysandbox::sandbox::Sandbox;
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder().build();
// By default, each exec starts from the builder's cwd/env. The VFS persists.
sandbox.exec("mkdir -p /workspace/data").await;
sandbox
.exec("echo 'alpha\nbeta\nalpha' > /workspace/data/words.txt")
.await;
// GNU-faithful output shapes, down to wc padding stdin counts to width 7.
let result = sandbox.exec("sort -u /workspace/data/words.txt | wc -l").await;
assert_eq!(result.stdout, " 2\n");
assert_eq!(result.exit_code, 0);
// JavaScript with a Node-compatible fs API, sandboxed under Wasmtime.
sandbox
.exec(r#"echo 'const fs = require("fs"); console.log(fs.readFileSync("/workspace/data/words.txt", "utf8").length)' > /workspace/count.js"#)
.await;
let result = sandbox.exec("js /workspace/count.js").await;
assert_eq!(result.stdout, "17\n");
}§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox()
// By default, each exec starts from the builder's cwd/env. The VFS persists.
await sandbox.exec('mkdir -p /workspace/data')
await sandbox.exec("echo 'alpha\nbeta\nalpha' > /workspace/data/words.txt")
// GNU-faithful output shapes, down to wc padding stdin counts to width 7.
const result = await sandbox.exec('sort -u /workspace/data/words.txt | wc -l')
console.assert(result.stdout === ' 2\n')
console.assert(result.exitCode === 0)
// JavaScript with a Node-compatible fs API, sandboxed under Wasmtime.
await sandbox.exec(`echo 'const fs = require("fs"); console.log(fs.readFileSync("/workspace/data/words.txt", "utf8").length)' > /workspace/count.js`)
const counted = await sandbox.exec('js /workspace/count.js')
console.assert(counted.stdout === '17\n')The host can also work with the filesystem directly — useful for seeding input files or reading results without going through the shell:
§Rust
use tinysandbox::sandbox::Sandbox;
use tinysandbox::vfs::OpenMode;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let sandbox = Sandbox::builder().build();
let vfs = sandbox.vfs();
let handle = vfs.open("/workspace/report.txt", OpenMode::write_only().create())?;
vfs.write_at(handle, 0, b"direct host access")?;
vfs.close(handle)?;
Ok(())
}§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox()
await sandbox.fs.writeFile('/workspace/report.txt', Buffer.from('direct host access'))§What’s inside
§Shell
A hand-rolled, heavily tested parser and executor for the bash subset agents actually use. Semantics inside the subset are verified against real bash:
- Pipelines (
cat log | grep err | wc -l), lists (&&,||,;), newline separators, and line continuation after&&/||/| - Redirects:
>,>>,<,2>,2>>,2>&1— with bash-correct left-to-right fd resolution (cmd 2>&1 > fdiffers fromcmd > f 2>&1, as it should) - Quoting: single, double, backslash escapes, correct field splitting of
unquoted
$VARexpansions - Variables:
$VAR,${VAR},$?,VAR=x cmdprefixes, bare assignments,export/unset, and opt-in persistent cwd/env perSandbox - Loud, positioned errors for what’s not supported: globs,
$(...), backticks, heredocs,&, subshells, tilde expansion
§Builtins
Native Rust implementations running directly against the VFS — no processes spawned. GNU-faithful for supported flags, GNU-shaped error messages and exit codes; golden tests pin the output shapes against the real tools.
files: cat ls cp mv rm mkdir touch stat which pwd cd
text: grep head tail sort uniq wc sed echo
other: true false export unset jq js/bin is synthesized from the command registry, so ls /bin and
which cat work and writes to /bin fail with EACCES. One documented
deviation: grep and sed use Rust regex syntax (linear-time matching, so
hostile patterns can’t burn CPU) rather than POSIX BRE.
§jq
jq filter [files...] is powered by jaq
compiled to WebAssembly. A fresh Wasmtime instance parses, evaluates, and
serializes each invocation, using the same VFS and pipes as other commands.
Flags. The CLI surface is intentionally small: -r, -j, -c, -e,
-n, -s, -S, --tab, --indent N, --arg name value,
--argjson name json, and --, plus file operands and - for stdin.
Unsupported options fail loudly.
Input. Stdin when no files are passed, otherwise each file operand in
order (- reads stdin at that point in the list). Newline-delimited JSON is
accepted by default as a stream of JSON values; with -s, all values from
stdin and files are parsed first and passed to the filter as one array.
Limits. Input admission and guest resource limits:
-
Limits::jq_input_bytes/limits.jqInputBytescaps the total bytes read across stdin and files (default 8 MiB). -
JSON input and
--argjsonvalues are rejected past 1024 levels of array/object nesting, before bytes reach jaq’s recursive JSON parser. -
The filter program text (the expression argument, not input data) is rejected past 256 KiB of source, 512 levels of grouped/interpolation nesting, or 1024 significant syntax tokens — far beyond any hand-written filter, but enough to keep hostile programs out of jaq’s recursive parser.
-
Limits::jq_memory_bytes/limits.jqMemoryBytescaps the entire guest linear memory, including its stack, JSON parser, filter compiler, intermediate values, and serializer (default 64 MiB). Exceeding the cap fails the command with exit 5 andjq: memory limit exceeded; the sandbox remains usable.
Resource behavior. Wasmtime interrupts computation at the execution’s
absolute wall-clock deadline, including filters that never produce a value.
Cancellation also interrupts the worker; there is no native evaluator fallback.
Output uses 64 KiB chunks and a four-message channel with backpressure, so
jq -n 'range(0;1000000000)' | head stops when its downstream reader closes.
The guest has no filesystem, network, or process imports. now reads the host
clock; localtime and strflocaltime use UTC for deterministic timezone behavior.
env is empty: the guest cannot inspect the host process environment.
Isolation measurements report the latency and
memory tradeoff against the previous native evaluator.
The memory cap covers guest linear memory, not total process RSS: Wasmtime’s
shared code, bounded worker stacks, input buffers, and bounded host transfers
are additional costs. Each jq command owns fresh guest state, even after a trap.
Sandbox::builder().without_command("jq") (Node: disabledCommands: ['jq'])
can still exclude the command and its /bin entry.
Not included. User-defined jq functions (def ...), external module
loading, color output, and CLI flags outside the listed subset. Diagnostics
use tinysandbox/jaq-shaped wording.
§JavaScript runtime
js script.js [args...] and js -e 'code' run agent scripts on
quickjs-ng compiled to WebAssembly
and hosted by Wasmtime. The runtime targets Node fidelity for everything it
implements (the test suite runs the same scripts under real Node and pins
identical output):
| Area | Supported |
|---|---|
fs (sync) | readFileSync, readLinesSync (UTF-8 line iterator, 64KB buffer), writeFileSync, appendFileSync, mkdirSync, readdirSync (incl. withFileTypes), statSync, renameSync, rmSync, unlinkSync, rmdirSync, existsSync, copyFileSync, openSync, readSync, writeSync, ftruncateSync, closeSync |
require | Relative/absolute CommonJS: ./x, ../x, /x, extension inference (.js, .json), dir/index.js, module cache, Node cycle semantics, module.exports/exports aliasing, require.main, MODULE_NOT_FOUND shapes |
| Globals | console.log/info/warn/error (Node formatting incl. %s %d %j-style substitution), process.argv/env/cwd()/exit(), __filename, __dirname, Buffer (from, alloc, isBuffer, toString('utf8'/'hex'/'base64')) |
| Fetch | WHATWG-subset fetch, Headers, and Response backed only by an embedder-provided handler |
| Errors | Node-shaped: .code ('ENOENT'…), libuv-faithful .errno, .syscall, .path, messages like ENOENT: no such file or directory, open '/x' |
| Limits | Per-run memory cap (default 64 MB) with clean OOM errors, CPU deadline via epoch interruption (while(true){} exits 124), fetch response body cap, catchable RangeError on stack exhaustion |
The checked-in module starts with 19 WebAssembly pages (1,245,184 bytes, or
1.1875 MiB) of linear memory. The build links a 1 MiB C stack and gives QuickJS
a 768 KiB stack limit so exhaustion remains a catchable JavaScript exception.
Run
node scripts/inspect-quickjs-wasm.mjs to report the exact artifact size,
initial memory, imports, and exports. Initial linear memory is a deterministic
capacity floor; it is not an RSS measurement and unused pages may be committed
lazily by the operating system.
The separate zero-runtime-dependency
@tinysandbox/js-runtime
package runs the
same artifact and guest glue through standard WebAssembly APIs in Node/V8,
Chrome, and Convex-compatible V8 hosts. It accepts wasm bytes or a precompiled
WebAssembly.Module explicitly, then creates fresh physical wasm and QuickJS
state for every synchronous runCode() call. The host supplies bounded memory,
a monotonic deadline, separate QuickJS heap and stack limits, output/response
caps, and optional synchronous JSON-safe dotted globals. Supplying a
synchronous VFS additionally enables runFile(), the supported fs subset,
Buffer, and CommonJS file loading; omitting it leaves the runtime without
filesystem capability. The package does not include the shell, coreutils,
native bindings, a concrete storage backend, or ambient network access. Its
package README documents the small API and
host examples. A minimal
browser playground runs
editable source in the wasm guest and shows console output, the return value,
and peak linear memory side by side.
Not there on purpose: timers, an event loop, direct networking,
child_process/process spawning, built-in shell command execution from
JavaScript, and node_modules resolution — bare require('lodash') tells you
plainly that there is no npm in the sandbox. Async is intentionally narrow:
already-settled microtasks drain before exit, and fetch is available only
through an embedder-granted handler. All file access goes through the same VFS
and quotas as the shell. Known deviations (fetch subset details,
stack-frame naming, line-1 column offsets) are documented in the js module
docs.
§Prompt chunks
Both packages export ready-made system-prompt text describing the sandbox to an agent. Each chunk is a short, self-contained block covering one part of the environment — they assume the model already knows bash, coreutils, jq, and Node, and only state where this environment differs. Mix the chunks that match your configuration and join them with blank lines:
§Rust
let system_prompt = [
tinysandbox::prompts::OVERVIEW,
tinysandbox::prompts::SHELL,
tinysandbox::prompts::BUILTINS,
tinysandbox::prompts::SESSION_EPHEMERAL,
tinysandbox::prompts::JS,
]
.join("\n\n");§TypeScript
import { prompts } from '@tinysandbox/tinysandbox'
const systemPrompt = [
prompts.overview,
prompts.shell,
prompts.builtins,
prompts.sessionEphemeral,
prompts.js
].join('\n\n')Available chunks: OVERVIEW/overview, SHELL/shell,
BUILTINS/builtins, JQ/jq, JS/js, FETCH/fetch, and
SESSION_EPHEMERAL/sessionEphemeral or
SESSION_PERSISTENT/sessionPersistent (pick the one matching
persist_session). Skip JS when the js feature is off and FETCH when no
fetch handler is set. globals(names)/globals(names) is a function rather
than a constant: pass the names you bound so the chunk lists what the model can
call. Tests pin the builtins chunk to the actual command registry so the text
cannot drift from the sandbox.
§Custom commands
Anything registered with the builder is indistinguishable from a builtin: it
shows up in /bin, resolves via which, and composes in pipelines. A
command is just an async function from CommandContext (args, env, cwd,
stdio streams, a VFS handle, limits) to an exit code:
§Rust
use tinysandbox::sandbox::{CommandContext, CommandResult, Sandbox};
use tokio::io::AsyncWriteExt;
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder()
.command("greet", |mut ctx: CommandContext| async move {
let name = ctx.args.first().map_or("world", String::as_str);
let _ = ctx.stdout.write_all(format!("hello {name}\n").as_bytes()).await;
CommandResult::success()
})
.build();
let result = sandbox.exec("greet agent | wc -w").await; // pipes like any builtin
assert_eq!(result.stdout, " 2\n");
}§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
commands: {
greet: async ({ args }) => {
const name = args[0] ?? 'world'
return { stdout: Buffer.from(`hello ${name}\n`) }
}
}
})
const result = await sandbox.exec('greet agent | wc -w')
console.assert(result.stdout === ' 2\n')This is the intended way to expose tools to an agent — file converters, linters, API bridges — while the sandbox contains everything the agent’s own code does with the results.
§JavaScript host capabilities
The js runtime can receive a smaller capability surface than a whole shell
command. Bind host functions into the JavaScript global scope, add a prelude to
shape the guest API, and grant fetch only when you want agent JS to reach an
embedder-provided transport.
Custom shell commands registered with SandboxBuilder::command / commands
are available to the shell, not automatically to sandboxed JavaScript. If you
want JavaScript to call custom host functionality, bind it as a host global and
optionally wrap it with a JavaScript prelude.
§Host globals
Host globals are async host functions bound into the guest global scope by name. The guest calls them synchronously, JSON round-tripping one value in and one value out.
The name is a dotted path. A bare search becomes globalThis.search;
tools.search becomes globalThis.tools.search with the tools namespace
object created for you, so several names can share one namespace. Each segment
must match [A-Za-z_][A-Za-z0-9_]*. Names the runtime provides itself
(console, process, require, Buffer, fetch, …) are rejected when the
sandbox is built, and a name that collides with any other existing global, such
as a JavaScript intrinsic, fails the run instead of shadowing it. A name cannot
be both a function and a namespace: tools and tools.search conflict.
Rust
use serde_json::json;
use tinysandbox::sandbox::{HostError, Sandbox};
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder()
// Bare name: scripts call `whoami()`.
.js_global("whoami", |_args| async { Ok(json!({ "name": "agent-1" })) })
// Dotted name: scripts call `kv.get({ key })`.
.js_global("kv.get", |args| async move {
let key = args["key"].as_str().ok_or_else(|| {
HostError::new("key is required").with_code("E_KEY")
})?;
Ok(json!({ "value": format!("value-for-{key}") }))
})
.build();
let result = sandbox
.exec("js -e 'console.log(whoami().name); console.log(kv.get({ key: \"a\" }).value)'")
.await;
assert_eq!(result.stdout, "agent-1\nvalue-for-a\n");
}TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
globals: {
whoami: () => ({ name: 'agent-1' }),
'kv.get': async ({ key }) => ({ value: `value-for-${key}` })
}
})
const result = await sandbox.exec(
`js -e 'console.log(whoami().name); console.log(kv.get({ key: "a" }).value)'`
)
console.assert(result.stdout === 'agent-1\nvalue-for-a\n')Scripts can enumerate a namespace with Object.keys(tools), and
prompts::globals / prompts.globals builds the prompt chunk that names every
bound global, similar to how /bin is synthesized from the command registry.
If a handler throws or returns an error, sandboxed JS receives a normal
Error. A string code property on the thrown error is copied to
err.code. Returned values must be JSON values; non-JSON-serializable Node
returns fail the call.
§Changing globals between commands
SandboxBuilder::js_global fixes the surface when the sandbox is built. A live
sandbox can also change it, which is what an agent loop wants when each turn
grants a different set of tools:
use serde_json::json;
use tinysandbox::sandbox::{JsGlobals, Sandbox};
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder().build();
// One swap, validated as a whole.
sandbox
.replace_js_globals(
JsGlobals::new()
.with("tools.search", |_args| async { Ok(json!({ "hits": [] })) })
.with("tools.read_doc", |_args| async { Ok(json!("doc body")) }),
)
.expect("grant this turn's tools");
// Or add to what is already bound, leaving the rest in place.
sandbox
.extend_js_globals(JsGlobals::new().with("tools.trace", |_args| async { Ok(json!("ok")) }))
.expect("add this turn's extra tool");
// Or one name at a time.
sandbox
.set_js_global("whoami", |_args| async { Ok(json!("agent-1")) })
.expect("bind whoami");
assert!(sandbox.remove_js_global("whoami"));
assert_eq!(sandbox.js_global_names().len(), 3);
}Every js command snapshots the registry when it starts, which fixes what the
change is visible to:
- A command already running keeps the set it started with, so a script never sees a global appear or vanish mid-run, and a handler already executing is not cancelled by removing its name.
- The snapshot is taken per command, not per
exec, so injs a.js && js b.jsa change landing between the two is invisible to the first and visible to the second. replace_js_globalsmakes the surface exactly the set you pass, dropping everything else including globals registered on the builder. That is what a turn-scoped grant wants: a tool left out stops being callable. Re-include the names that should survive.extend_js_globalsmerges instead, replacing only names it repeats. Both validate the resulting surface before it lands, so a set that collides with a bound namespace leaves the live globals untouched.- Each call is one swap. A
remove_js_globalfollowed by aset_js_globalhas a window in between where a command would see neither, so change a set that must move together withextend_js_globalsorreplace_js_globals.
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({ globals: { whoami: () => 'agent-1' } })
// One swap, validated as a whole.
sandbox.replaceJsGlobals({
'tools.search': async ({ q }) => ({ hits: [] }),
'tools.readDoc': () => 'doc body'
})
// Or add to what is already bound, leaving the rest in place.
sandbox.extendJsGlobals({ 'tools.trace': () => 'ok' })
// Or one name at a time.
sandbox.setJsGlobal('whoami', () => 'agent-1')
sandbox.removeJsGlobal('whoami')
console.log(sandbox.jsGlobalNames()) // ['tools.readDoc', 'tools.search', 'tools.trace']§JavaScript prelude
js_prelude / jsPrelude is evaluated after tinysandbox installs its host
bindings and before the agent script. It runs before CommonJS globals exist,
so use it to define globals or wrap capabilities, not to require() modules.
Rust
use serde_json::json;
use tinysandbox::sandbox::Sandbox;
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder()
.js_global("secret_get", |_args| async { Ok(json!({ "value": "redacted" })) })
.js_prelude(
"const secretGet = globalThis.secret_get; \
globalThis.readSecret = () => secretGet({}).value; \
delete globalThis.secret_get",
)
.build();
let result = sandbox
.exec("js -e 'console.log(readSecret(), typeof secret_get)'")
.await;
assert_eq!(result.stdout, "redacted undefined\n");
}TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
globals: {
secretGet: () => ({ value: 'redacted' })
},
jsPrelude:
'const secretGet = globalThis.secretGet; globalThis.readSecret = () => secretGet({}).value; delete globalThis.secretGet'
})
const result = await sandbox.exec("js -e 'console.log(readSecret(), typeof secretGet)'")
console.assert(result.stdout === 'redacted undefined\n')§Fetch
fetch is not an HTTP client built into the crate. It is a guest API backed
by a handler you provide, so the host decides whether URLs map to HTTP,
service calls, fixtures, object storage, or nothing at all. Without a handler,
fetch() rejects with a network-unavailable cause.
The guest receives a WHATWG-style subset: fetch, Headers, Response, and
body helpers such as text(), json(), and arrayBuffer(). Streams,
AbortController, redirects, and the full browser/undici surface are outside
the subset; see the js module docs for precise deviations.
Limits::fetch_response_bytes / limits.fetchResponseBytes caps the response
body accepted from the host before it reaches the guest.
Rust
use tinysandbox::sandbox::{FetchResponse, HostError, Sandbox};
#[tokio::main]
async fn main() {
let sandbox = Sandbox::builder()
.fetch(|request| async move {
if request.url == "https://example.test/config" {
Ok(FetchResponse {
status: 200,
headers: vec![("content-type".to_owned(), "application/json".to_owned())],
body: br#"{"ok":true}"#.to_vec(),
})
} else {
Err(HostError::new("no route").with_code("ENOENT"))
}
})
.build();
let result = sandbox
.exec("js -e 'fetch(\"https://example.test/config\").then(r => r.json()).then(v => console.log(v.ok))'")
.await;
assert_eq!(result.stdout, "true\n");
}TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
limits: { fetchResponseBytes: 1024 * 1024 },
fetch: async ({ url, body }) => ({
status: 200,
headers: [['content-type', 'text/plain']],
body: `echo ${url} ${body?.toString('utf8') ?? ''}`
})
})
const result = await sandbox.exec(
`js -e 'fetch("https://example.test/echo", { method: "POST", body: Buffer.from("hi") }).then(r => r.text()).then(console.log)'`
)
console.assert(result.stdout === 'echo https://example.test/echo hi\n')§Filesystem backends
| Backend | Host storage | Mutability | Availability |
|---|---|---|---|
InMemoryVfs | Process memory | Read/write | Default |
LocalVfs | Contained host directory | Read/write | Unix |
S3Vfs | Bucket/key prefix | Read/write, or read-only by config | Cargo feature s3; included in Node |
§Filesystem mounts
The sandbox root is a read-only mount namespace. Backends are attached at
static, top-level names such as /workspace, /input, and /output. /bin
is reserved for the synthesized command registry. ls / lists both bin and
the configured mounts. Paths outside a mount return ENOENT, mount points
cannot be removed or renamed, and cross-mount renames fail with EXDEV.
Copying between mounts works normally.
By default, a sandbox has one in-memory workspace mount and starts with
cwd=/workspace. Rust callers can add or replace mounts through the builder:
let sandbox = Sandbox::builder()
.mount("workspace", LocalVfs::new("/srv/job/workspace")?)
.mount("input", S3Vfs::new(client, "agent-inputs", Some("job-42"))?)
.cwd("/workspace")
.build();clear_mounts() removes the default workspace and resets the builder cwd to
/. Mount names must be single path components and cannot be ., .., or
bin. Mounts are fixed after build().
In TypeScript, providing mounts replaces the default workspace exactly:
const sandbox = new Sandbox({
mounts: {
workspace: { type: 'memory', quota: { maxBytes: 64 * 1024 * 1024 } },
input: { type: 's3', bucket: 'agent-inputs', prefix: 'job-42' },
output: { type: 'local', root: '/srv/job/output' }
},
cwd: '/workspace'
})Each mount enforces its own quota. Sandbox::stats() reports the checked sum
of mounts that expose usage statistics. Mounts such as S3Vfs that do not
report usage are skipped.
§Local directory VFS
On Unix hosts, LocalVfs roots one mount in a directory on the host disk.
Files persist across sandboxes and process
restarts, existing content in the directory is visible inside, and host
tools can read what the agent writes.
Containment is strict: every sandbox path resolves beneath the root (.. is
clamped by normalization before touching the OS), symbolic links are never
followed (they are invisible to lookups and rejected with O_NOFOLLOW at
open time), and special files are refused. The same quota knobs as
InMemoryVfs apply, seeded by scanning the existing tree at construction.
Dedicate the directory to the sandbox — containment holds regardless, but
quota accounting assumes no other process mutates the tree while the sandbox
is live. LocalVfs passes the same conformance suite as InMemoryVfs.
When the host does legitimately touch the tree — or tracks usage out of band
entirely — rebaseline the counters from outside the sandbox: refresh()
rescans the directory, and set_usage() pushes externally computed numbers.
Enforcement then just answers “should this write be blocked” against the
current baseline, with live operations applying their deltas on top. From
TypeScript: await sandbox.refreshLocalVfs('workspace') and
sandbox.setLocalVfsUsage('workspace', { usedBytes, fileCount }).
§Rust
use tinysandbox::sandbox::Sandbox;
use tinysandbox::vfs::{LocalVfs, VfsQuota};
let sandbox = Sandbox::builder()
.mount("workspace", LocalVfs::new("/srv/agent-42-workspace")?)
.build();
// Or with quota limits:
let quota = VfsQuota { max_bytes: 64 << 20, max_files: 4096, max_file_size: 16 << 20 };
let sandbox = Sandbox::builder()
.mount("workspace", LocalVfs::with_quota("/srv/agent-42-workspace", quota)?)
.build();§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
mounts: {
workspace: {
type: 'local',
root: '/srv/agent-42-workspace',
quota: { maxBytes: 64 * 1024 * 1024 }
}
}
})§S3 VFS
The optional s3 Cargo feature provides S3Vfs, a read-write view of one S3
bucket/key prefix. The Node package includes the same backend as the s3 mount
type. The configured prefix becomes the backend root. An empty prefix exposes
the whole bucket, and a prefix with no matching keys is a valid empty virtual
root. Sandbox path normalization and a fixed prefix boundary prevent access to
adjacent keys.
Files are read with bounded S3 Range requests rather than whole-object
downloads. Shell and embedded-JavaScript streams use 64 KiB chunks, so an
early-exit pipeline such as cat /large.log | head -n 1 only fetches the
needed prefix. Open handles pin the object’s ETag with If-Match; replacement
during a read fails with EIO instead of combining revisions. Object bodies
and directory listings are not cached.
Directories are virtual: both implicit prefixes and zero-byte marker objects
ending in / appear as directories. If an object a and descendants under
a/ both exist, directory identity wins and the colliding object is hidden.
mkdir writes a marker object, and emptying a directory rewrites its marker so
the directory does not disappear with its last child. VFS quotas/stats,
snapshots, version-history browsing, S3 Express, and access points are not
supported.
§Writes
S3 has no partial-object update, so a writable handle stages its contents and
lands them as one object operation when the handle closes. Writes become
visible to other handles and other readers at that point, not before, and
close is the call that reports a write failure. Two handles open on one path
stage independently, so the last close wins.
How a handle stages depends on whether it needs the object’s existing bytes:
| Open mode | Staging | Size limit |
|---|---|---|
Write-only, creating or truncating (>, w, wx) | Forward-only writes flush through a multipart upload | None |
Append to an existing object (>>, a) | Whole body in memory | max_edit_bytes |
Read-write (r+, w+) | Whole body in memory | max_edit_bytes |
Modifying an object means reading it, applying the writes, and putting it back,
so its whole body is held in memory. max_edit_bytes caps that at 32 MiB by
default; a longer object fails with EFBIG and has to be rewritten rather than
edited. Setting it to zero removes the limit. A forward-only write is not
capped: it uploads 8 MiB parts and frees them as it goes, so a new object of
any size costs bounded memory. Seeking back below what a stream has already
uploaded also reports EFBIG, since those bytes are no longer in memory.
Handles that never write cost nothing extra: touch on an existing object and
a read-write open that is only read never download or replace it.
Writes carry preconditions so a concurrent replacement fails instead of being
silently overwritten: If-None-Match: * makes create_new a real exclusive
create, and If-Match on a read-modify-write turns a lost update into an
error. Set conditional_writes to false for a compatible service that rejects
them, which gives up both protections.
S3 has no atomic directory rename. Renaming a directory copies and then deletes
every key beneath it: two requests per key, and an interrupted rename leaves
keys under both prefixes. Set directory_rename to false to reject it with
EXDEV instead.
Read-only mounts stay available through S3VfsConfig::read_only(), which
refuses every write and path mutation with EACCES before issuing a request.
Credentials remain the enforcing boundary; the flag only stops the VFS from
issuing mutating requests with a client that would accept them.
§Rust
Enable the backend and add the AWS SDK used to configure its client:
cargo add tinysandbox --features s3
cargo add aws-config aws-sdk-s3
cargo add tokio --features macros,rt-multi-threaduse aws_sdk_s3::Client;
use tinysandbox::sandbox::Sandbox;
use tinysandbox::vfs::{S3Vfs, S3VfsConfig};
async fn run_with_client(client: Client) -> Result<(), Box<dyn std::error::Error>> {
let vfs = S3Vfs::new(client, "agent-workspaces", Some("tenant-42/jobs/current"))?;
let sandbox = Sandbox::builder()
.clear_mounts()
.mount("workspace", vfs)
.cwd("/workspace")
.build();
let result = sandbox
.exec("grep ERROR /workspace/logs/app.log | head > /workspace/errors.txt")
.await;
println!("{}", result.stdout);
Ok(())
}
async fn run_read_only(client: Client) -> Result<(), Box<dyn std::error::Error>> {
let vfs = S3Vfs::with_config(
client,
"agent-inputs",
Some("tenant-42/jobs/current"),
S3VfsConfig::read_only(),
)?;
let sandbox = Sandbox::builder().clear_mounts().mount("input", vfs).build();
println!("{}", sandbox.exec("cat /input/spec.md").await.stdout);
Ok(())
}Tune the write policy with S3Vfs::with_config:
use tinysandbox::vfs::S3VfsConfig;
let config = S3VfsConfig {
// Stage up to 128 MiB in memory to modify an existing object.
max_edit_bytes: 128 * 1024 * 1024,
// Reject `mv` on a directory instead of copying every key beneath it.
directory_rename: false,
..S3VfsConfig::default()
};S3Vfs accepts an already configured aws_sdk_s3::Client; endpoint,
credentials, region, retry, timeout, TLS, and path-style policy remain owned by
that client. This also supports S3-compatible services without adding a second
configuration layer to the VFS.
§TypeScript
The Node binding uses the AWS SDK’s default region and credential provider
chains when overrides are omitted. Explicit credentials must include both key
fields; endpointUrl and forcePathStyle support compatible services.
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
mounts: {
input: {
type: 's3',
bucket: 'agent-inputs',
prefix: 'tenant-42/jobs/current',
region: 'us-east-1',
endpointUrl: 'http://127.0.0.1:9000',
forcePathStyle: true,
credentials: {
accessKeyId: process.env.S3_ACCESS_KEY!,
secretAccessKey: process.env.S3_SECRET_KEY!
}
},
// Writes are on by default; opt a mount out explicitly.
reference: {
type: 's3',
bucket: 'agent-reference',
readOnly: true
}
},
cwd: '/input'
})
const firstLine = await sandbox.exec('cat /input/logs/app.log | head -n 1')
await sandbox.exec('grep ERROR /input/logs/app.log > /input/errors.txt')maxEditBytes, directoryRename, and conditionalWrites mirror the Rust
configuration fields.
A read-only mount needs only s3:GetObject on the exposed keys and
prefix-restricted s3:ListBucket on the bucket:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "s3:ListBucket",
"Resource": "arn:aws:s3:::agent-inputs",
"Condition": { "StringLike": { "s3:prefix": ["tenant-42/jobs/current", "tenant-42/jobs/current/*"] } }
},
{
"Effect": "Allow",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::agent-inputs/tenant-42/jobs/current/*"
}
]
}A writable mount also needs s3:PutObject, s3:DeleteObject, and
s3:AbortMultipartUpload on the same key scope. Multipart uploads use
s3:PutObject; s3:AbortMultipartUpload lets a failed or abandoned write
clean up its parts instead of leaving them billable. Because IAM is the
enforcing boundary, granting only read permissions keeps a mount effectively
read-only even at the default configuration.
Compatibility tests use a loopback-only, pinned S3-compatible container with throwaway credentials; the project test suite never contacts AWS or another public object store.
§Bring your own VFS
The filesystem is a trait, and the in-memory implementation is just the
default. Back it with SQLite, object storage, or a network service by
implementing tinysandbox::vfs::Vfs — eleven synchronous, FUSE-style methods
(stat, readdir, mkdir, rename, unlink, rmdir, open,
read_at, write_at, truncate, close). Blocking implementations are
fine: the sandbox dispatches VFS calls to worker threads unless your
implementation opts into the in-memory fast path via is_fast().
Attach it in the builder and the whole sandbox — shell, builtins, JS scripts, and direct host access — runs against it:
§Rust
use std::sync::Arc;
use tinysandbox::sandbox::Sandbox;
let sandbox = Sandbox::builder()
.mount("workspace", MyVfs::connect("s3://agent-42-workspace")?)
.build();
// Or share one VFS between sandboxes / keep a handle for yourself:
let vfs = Arc::new(MyVfs::connect("s3://agent-42-workspace")?);
let sandbox = Sandbox::builder().mount_arc("workspace", Arc::clone(&vfs)).build();§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
mounts: {
workspace: { type: 'custom', vfs: MyVfs.connect('s3://agent-42-workspace') }
}
})The crate ships the same conformance suite that validates InMemoryVfs, so
you can prove your implementation behaves like a POSIX filesystem —
open-mode enforcement, rename-over-existing, unlink-while-open handle
semantics, quota accounting, path containment, and more:
§Rust
#[test]
fn my_vfs_conforms() {
tinysandbox::vfs::conformance::run(|quota| MyVfs::new(quota));
}§TypeScript
import { runConformance } from '@tinysandbox/tinysandbox'
await runConformance((quota) => new MyVfs(quota))The JavaScript conformance runner covers the core VFS contract. Snapshot
conformance is Rust-only for now because VfsSnapshot uses an associated
snapshot type that does not map cleanly onto the callback-object adapter.
See the tinysandbox::vfs rustdoc for the full trait contract (errno
expectations per method, quota semantics, handle identity rules).
§Snapshots
InMemoryVfs supports cheap copy-on-write snapshots for rollback and
branching. A snapshot captures path-visible filesystem contents, not open file
handles; restoring one invalidates handles opened before the restore.
§Rust
use tinysandbox::vfs::{InMemoryVfs, OpenMode, Vfs, VfsQuota, VfsSnapshot};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let vfs = InMemoryVfs::new(VfsQuota::unlimited());
let handle = vfs.open("/draft.txt", OpenMode::write_only().create_new())?;
vfs.write_at(handle, 0, b"before")?;
vfs.close(handle)?;
let snapshot = vfs.snapshot()?;
let branch = vfs.branch(&snapshot)?;
vfs.unlink("/draft.txt")?;
assert!(vfs.stat("/draft.txt").is_err());
assert!(branch.stat("/draft.txt")?.is_file());
Ok(())
}§TypeScript
The Node binding exposes live VFS operations and JS-backed VFS adapters. Snapshot capture/restore/branch is currently Rust-only.
Sandbox::vfs() returns the composite mount namespace as Arc<dyn Vfs>, so
snapshot-aware callers should keep their own concrete backend handle and pass a
clone into the builder:
§Rust
use std::sync::Arc;
use tinysandbox::sandbox::Sandbox;
use tinysandbox::vfs::{InMemoryVfs, VfsQuota, VfsSnapshot};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let vfs = Arc::new(InMemoryVfs::new(VfsQuota::unlimited()));
let sandbox = Sandbox::builder().mount_arc("workspace", vfs.clone()).build();
let before_turn = vfs.snapshot()?;
let result = sandbox.exec("echo draft > /workspace/answer.txt").await;
if result.exit_code != 0 {
vfs.restore(&before_turn)?;
}
Ok(())
}§TypeScript
Snapshot-aware workflows should keep this part in Rust for now. TypeScript
VFS adapters can still validate the non-snapshot contract with
runConformance(vfsFactory).
§Limits and observability
Sandbox uses one wall-clock deadline for parsing, commands, hostcall
admission, and JS/jq execution. Exhausting it returns exit 124 and discards partial
captures and session changes. Dropping the exec future also cancels its
capabilities. New filesystem operations are rejected after cancellation;
already-running trusted VFS operations or callbacks may finish and their effects
are not rolled back. Cancellation releases handles and aborts staged S3 writes;
slow cleanup can outlive the result. Custom backends should override Vfs::abort
when closing would publish staged data; the default delegates to close.
Trusted host callbacks can opt into cooperative cancellation with Rust
js_global_with_context and fetch_with_context; existing one-argument
callbacks remain supported. HostContext exposes the monotonic deadline,
remaining time, is_cancelled(), and async cancelled(). Custom commands obtain
it through ctx.fs.host_context(). Native Node callbacks receive a second
context argument with an AbortSignal, remainingTimeMs(), and isCancelled().
Cancellation is signalled on callback settlement, timeout, execution completion,
and dropped Rust execution futures. Propagate the signal to downstream requests and bound host
allocations; synchronous blocking code cannot be preempted. A hard boundary
for arbitrary host code still requires separate process isolation.
Capture caps apply only to returned stdout/stderr. Pipes and files receive the original byte stream, with bounded chunks and backpressure. Duplicated output fds share one open handle and offset, including a single S3 commit.
Limits defaults include 1 MiB of shell source, 8 MiB per whole-file/host-input
operation, 8 MiB retained by tail, 1,024 simple command stages (including null
and assignment-only stages), and 1,024 simultaneously open files. sort and
jq have separate cumulative input caps. Shell expansion admits a whole pipeline
against the larger of shell_input_bytes and host_input_bytes, including
retained environment copies and field storage, before opening any redirects.
Normalized paths have a hard depth
ceiling of 256, which max_path_depth can lower per exec. Host sandbox.fs()
operations use the default whole-file and per-I/O caps; stream large files with
handles. Raw reads/writes allow at least one 64 KiB stream chunk even under a
smaller whole-file cap.
JS workers are admitted through 16 process-wide slots; synchronous filesystem work through 128 slots; isolated jq evaluation through 16 slots. Slots remain occupied until running work finishes. Jq input buffers are separately capped per command and collected before worker admission to let downstream pipes drain. Fallback handle cleanup uses four workers and shares a process-wide 16,384-open- file ceiling. Trusted host callbacks and VFS implementations must bound their own work. VFS quotas are backend-configured (memory quotas are unlimited unless set). JS memory, jq memory, and fetch-response limits are independently configurable:
§Rust
use std::time::Duration;
use tinysandbox::sandbox::{Limits, Sandbox};
fn main() {
let sandbox = Sandbox::builder()
.limits(Limits {
wall_time: Duration::from_secs(5),
wasm_memory_bytes: 32 * 1024 * 1024,
jq_memory_bytes: 32 * 1024 * 1024,
fetch_response_bytes: 1024 * 1024,
..Limits::default()
})
.build();
}§TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
limits: {
wallTimeMs: 5000,
wasmMemoryBytes: 32 * 1024 * 1024,
jqMemoryBytes: 32 * 1024 * 1024,
fetchResponseBytes: 1024 * 1024
}
})ExecResult carries per-run metrics (wall time, per-command timings, pipe
byte counts, truncation flags, peak wasm memory), and Sandbox::stats()
reports VFS usage and total commands run.
§Security model
- The shell and ordinary builtins interpret input in native Rust. JavaScript and jq execute inside separate Wasm guests. Trusted custom commands and host callbacks must bound their own resource use and cooperate with cancellation.
- The wasm guest is capability-free. The vendored QuickJS module
(see assets/PROVENANCE.md for the reproducible build) imports no WASI
filesystem functions — no preopens, no
path_open. Its only window to the world is the audited hostcall ABI, which routes through the same VFS, quotas, and path containment as everything else. - JS and jq linear memory are capped by Wasmtime, with CPU interruption, bounded host transfers, and an execution-wide deadline. These are not a total-process heap cap or a preemption guarantee for trusted host callbacks.
- Native artifacts are generated from the fixed JS and jq guests during the build and embedded in the binary. Applications cannot install external native artifacts through the sandbox API.
..traversal is contained at the virtual root./binand mount points are read-only. With the local directory VFS, each component is opened relative to an already-open directory without following symlinks; special files are refused. Replacing root or ancestor names cannot redirect traversal. An opened directory remains the same capability if the host moves it. The host must dedicate the tree to the sandbox and must not insert hard links or mounted content granting access to outside files. Hard links are unsupported; other external mutations make namespace/quota accounting stale until refreshed.
tinysandbox is one layer, not the whole story: for hostile multi-tenant workloads you should still run your process under OS-level defense in depth (non-root, seccomp/cgroups, or a microVM) appropriate to your threat model.
§Comparison with just-bash
just-bash is the closest neighbor: a TypeScript simulated bash with a virtual filesystem, also built for agents. Both give an agent a familiar shell without a container or VM, but the designs differ in ways that matter:
- Random file reads and writes. The tinysandbox VFS is handle-and-offset
based (
open,read_at,write_at), and the JS runtime exposes the matching fd APIs (fs.openSync/readSync/writeSyncwith explicit positions). just-bash’s filesystem interface is whole-file: reading one byte means materializing the entire file in memory. In tinysandbox, a VFS backed by object storage or a database can serve TB-scale files while the sandbox only touches the KBs actually read. - Streaming pipes and redirects. Pipeline stages exchange data through
bounded async streams, and redirects write through VFS handles while the
command runs. just-bash buffers command output before it can be consumed or
written back; tinysandbox can run
cat /huge | head -n 1without materializing the full input or output. - JavaScript runs in WebAssembly. QuickJS executes JavaScript inside a capability-free wasm guest, with linear-memory and CPU limits enforced by Wasmtime. jq uses a separate Wasm guest with the same engine-enforced isolation; ordinary shell commands are implemented in native Rust.
- Host language. tinysandbox is a Rust crate with Node.js bindings; just-bash is TypeScript and runs in Node or the browser.
§Performance
The repository includes memory benchmarks for the Rust crate and TypeScript
binding. Each benchmark runs every sandbox count in a fresh child process,
keeps all N sandboxes alive, samples resident set size (RSS), then runs a
small VFS workload on up to 1,000 live sandboxes and extrapolates that sampled
RSS delta across N.
cargo run --release --example memory_benchmark -- --counts 1000,10000,100000,1000000 --task-sample 1000
npm --prefix tinysandbox-node run benchmark:memory -- --counts 1000,10000,100000,1000000 --task-sample 1000Workload:
mkdir -p /bench && echo bench-payload > /bench/echo.txt && cat /bench/echo.txtMeasured on macOS 26.5.1 arm64 with rustc 1.96.0 and Node.js v24.15.0.
RSS includes runtime and allocator overhead for that process.
§Rust
| active sandboxes | active peak RSS | active delta / sandbox | create time | task sample | measured task peak | extrapolated task peak | task time |
|---|---|---|---|---|---|---|---|
| 1,000 | 8.84 MiB | 6.51 KiB | 49 ms | 1,000 | 12.08 MiB | 12.08 MiB | 60 ms |
| 10,000 | 60.78 MiB | 5.97 KiB | 75 ms | 1,000 | 64.09 MiB | 93.91 MiB | 55 ms |
| 100,000 | 580.58 MiB | 5.92 KiB | 312 ms | 1,000 | 583.86 MiB | 908.70 MiB | 55 ms |
| 1,000,000 | 5.64 GiB | 5.92 KiB | 2.56 s | 1,000 | 5.65 GiB | 8.92 GiB | 44 ms |
§TypeScript
| active sandboxes | active peak RSS | active delta / sandbox | create time | task sample | measured task peak | extrapolated task peak | task time |
|---|---|---|---|---|---|---|---|
| 1,000 | 85.02 MiB | 6.61 KiB | 3 ms | 1,000 | 88.83 MiB | 88.83 MiB | 33 ms |
| 10,000 | 126.55 MiB | 6.43 KiB | 30 ms | 1,000 | 130.55 MiB | 166.55 MiB | 37 ms |
| 100,000 | 680.95 MiB | 6.32 KiB | 315 ms | 1,000 | 685.83 MiB | 1.14 GiB | 38 ms |
| 1,000,000 | 6.16 GiB | 6.38 KiB | 3.04 s | 1,000 | 6.16 GiB | 9.03 GiB | 29 ms |
§JavaScript runtime startup
The build script turns quickjs.wasm into machine code for the crate’s target
and the binary embeds the result, so the first js command normally loads an
artifact that is already executable.
Runtime behavior with wasmtime 46:
| Step | Behavior |
|---|---|
First js command in a process | Loads the embedded precompiled artifact. |
| Fallback first command | Compiles the checked-in wasm when the embedded artifact is refused. |
One in-flight js command | Owns fresh wasm and QuickJS state for that run. |
Sandbox with no js command running | Retains no per-command QuickJS state. |
Each active run starts with 1,245,184 bytes of linear-memory capacity. This is a deterministic capacity floor, not an RSS measurement, and unused pages may be committed lazily by the operating system. The repository does not have a repeatable in-flight-JavaScript RSS harness, so it does not publish an RSS estimate for active JavaScript runs.
The artifact is pinned to the target triple with that architecture’s baseline CPU features, so it runs on any CPU of that architecture rather than only one as new as the build machine. It is also tied to this Wasmtime version. When either check fails — a target the build could not generate code for, an artifact from a different Wasmtime — the runtime compiles the module itself and keeps working at the cost of that first command. JS and jq share one Wasmtime engine and interruption timer, while each command keeps its own guest state and limits.
Two costs come with this. Wasmtime’s compiler is a build dependency as well as a
runtime one, so a cold cargo build compiles it twice; and the binary carries
the 2.7 MB artifact alongside the 0.6 MB wasm.
§Feature flags
| Feature | Default | Effect |
|---|---|---|
js | on | The js command and embedded QuickJS module (~600 KB). default-features = false removes JavaScript; Wasmtime and the isolated jq guest remain available. |
s3 | off | The prefix-rooted S3Vfs and AWS S3 SDK client adapter. The Node package enables this feature. |
§Examples
Runnable with cargo run --example <name>:
quickstart— sessions, pipelines, redirects, and reading results back from the hostcustom_command— registering a host command and composing it with builtinsjs_scripts— multi-file JS withrequire, thefsAPI, and a look at limits and metricsjs_dynamic_globals— changing the host global surface between commandsjs_globals— host globals, prelude wrappers, and embedder-backed fetch
Runnable with npm --prefix tinysandbox-node run examples after the package
dependencies are installed:
quickstart.ts— sessions, pipelines, redirects, and host readscustom_command.ts— registering a TypeScript host commandjs_scripts.ts— multi-file sandboxed JS with limits and metricsjs_globals.ts— TypeScript host globals, prelude wrappers, and fetch transportjs_dynamic_globals.ts— changing the host global surface between commandsjs_vfs.ts— TypeScript-backed VFS callbacks plusrunConformance
§License
Licensed under either of MIT or Apache-2.0, at your option.