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 Sandbox;
async
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox()
await sandbox.exec('mkdir /workspace')
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
- Bring your own VFS
- Snapshots
- Limits and observability
- Security model
- Comparison with just-bash
- 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 reserves heavyweight isolation (Wasmtime) for the one thing that actually runs untrusted code: agent-authored JavaScript. 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
Rust
use Sandbox;
async
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 Sandbox;
use OpenMode;
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox()
await sandbox.fs.mkdir('/workspace')
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
and runs as a native builtin over the same VFS and pipes as the rest of the
sandbox.
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. All enforced before evaluation starts:
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.
Resource behavior. Output is streamed: jq checks the sandbox wall-clock
limit between output values and inside the tinysandbox-provided range, and
stops promptly when a downstream pipe closes, so
jq -n 'range(0;1000000000)' | head does not buffer unbounded output. jaq
does not expose a fully preemptive evaluator or an allocator limit, so some
non-output-producing filters only time out at the command boundary while the
blocking worker runs until jaq yields again, and evaluation memory is bounded
by wall time plus host memory rather than a jq-specific heap cap. Hosts
running untrusted filters should set wall_time conservatively.
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, 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 |
Not there on purpose: timers, an event loop, direct networking, 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 =
.join;
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, SYSCALLS/syscalls,
FETCH/fetch, and SESSION_EPHEMERAL/sessionEphemeral or
SESSION_PERSISTENT/sessionPersistent (pick the one matching
persist_session). Skip JS when the js feature is off, SYSCALLS when
no syscalls are registered, and FETCH when no fetch handler is set. 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 ;
use AsyncWriteExt;
async
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. Register host syscalls for synchronous sandbox.* functions, add a
prelude to shape the guest API, and grant fetch only when you want agent JS
to reach an embedder-provided transport.
Syscalls
Syscalls are async host functions registered by name. The guest sees them as
synchronous sandbox.<name>(args) functions that JSON round-trip one value in
and one value out. Names must match [A-Za-z_][A-Za-z0-9_]*; fetch is
reserved for the global fetch transport.
The generated sandbox object is enumerable, so Object.keys(sandbox) gives
the script a discoverable list of granted capabilities, similar to how /bin
is synthesized from the command registry.
Rust
use json;
use ;
async
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
syscalls: {
kvGet: async ({ key }) => ({ value: `value-for-${key}` })
}
})
const result = await sandbox.exec(
`js -e 'console.log(Object.keys(sandbox).join(",")); console.log(sandbox.kvGet({ key: "a" }).value)'`
)
console.assert(result.stdout === 'kvGet\nvalue-for-a\n')
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 syscall.
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 json;
use Sandbox;
async
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
syscalls: {
secretGet: () => ({ value: 'redacted' })
},
jsPrelude: 'const secretGet = sandbox.secretGet; globalThis.readSecret = () => secretGet({}).value; delete globalThis.sandbox'
})
const result = await sandbox.exec("js -e 'console.log(readSecret(), typeof sandbox)'")
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 ;
async
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')
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 Arc;
use Sandbox;
let sandbox = builder
.vfs
.build;
// Or share one VFS between sandboxes / keep a handle for yourself:
let vfs = new;
let sandbox = builder.vfs_arc.build;
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
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
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 ;
TypeScript
The Node binding exposes live VFS operations and JS-backed VFS adapters. Snapshot capture/restore/branch is currently Rust-only.
Sandbox::vfs() returns Arc<dyn Vfs>, so snapshot-aware callers should keep
their own concrete handle and pass a clone into the builder:
Rust
use Arc;
use Sandbox;
use ;
async
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
Every Sandbox enforces wall-clock timeouts (exit 124, like GNU timeout),
stdout/stderr caps with head+tail truncation, a per-exec command budget,
VFS byte/file quotas (surfacing as ENOSPC), a wasm memory cap for JS, and a
fetch response body cap for embedder-backed fetch. All configurable via
Limits:
Rust
use Duration;
use ;
TypeScript
import { Sandbox } from '@tinysandbox/tinysandbox'
const sandbox = new Sandbox({
limits: {
wallTimeMs: 5000,
wasmMemoryBytes: 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
- Native code never runs agent input. The shell and builtins only interpret command text against the VFS; the only thing that executes agent-authored code is the wasm guest.
- 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. - Resources are bounded per execution: memory (ResourceLimiter), CPU (epoch interruption), wall clock, output size, file quotas.
..traversal is contained at the VFS root;/binis read-only.
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. - Agent code always runs in WebAssembly. In tinysandbox, the only thing that executes agent-authored code is the capability-free QuickJS wasm guest, with hard memory and CPU limits enforced by Wasmtime. just-bash interprets the shell and its commands in the host JavaScript engine and relies on language-level hardening against engine breakouts.
- Host language. tinysandbox is a Rust crate with Node.js bindings; just-bash is TypeScript and runs in Node or the browser.s
Feature flags
| Feature | Default | Effect |
|---|---|---|
js |
on | The js command, Wasmtime, and the embedded QuickJS module (~600 KB). Disable with default-features = false for a shell-and-coreutils-only sandbox with a much smaller dependency tree. |
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_syscalls— host syscalls, 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_syscalls.ts— TypeScript syscalls, prelude wrappers, and fetch transportjs_vfs.ts— TypeScript-backed VFS callbacks plusrunConformance
License
Licensed under either of MIT or Apache-2.0, at your option.