just-bash README

The project's README from github.com/vercel-labs/just-bash. As one markdown file: README.md.

just-bash monorepo

This repository hosts the just-bash package and its examples.

Packages

Package Path Description
just-bash packages/just-bash A simulated bash environment with virtual filesystem

See the package's own README for usage documentation.

Layout

packages/         publishable npm packages
examples/         example consumers (bash-agent, cjs-consumer, website)
.github/          CI workflows

Working in the repo

pnpm install              # install all workspace deps
pnpm build                # build all packages
pnpm test:run             # run unit + comparison tests
pnpm test:dist            # smoke-test the bundled output
pnpm lint                 # biome + per-package banned-pattern checks
pnpm typecheck            # tsc across all packages

Per-package commands run via pnpm --filter <name> <script> — e.g. pnpm --filter just-bash test:wasm.

just-bash (vercel-labs/just-bash)

sandboxing
Searching Database…

What is this?just-bash is a simulated bash environment with a virtual filesystem, built so coding agents can run shell-like commands in a safe sandbox instead of touching the real file system. The repo describes the project as 'Bash for Agents'.
Is this a CLI tool or a library I import?It is a library: this repository is a monorepo that hosts the 'just-bash' package and its example code, not a standalone CLI you install globally.
How do I add just-bash to my project?You take the just-bash package from packages/just-bash in this monorepo; the root README only covers the repo layout, so the package's own README is where the actual install/usage steps live.
Do I need any extra tooling to build or test it?The monorepo is managed with pnpm workspaces, so you run per-package commands like 'pnpm --filter just-bash test:wasm'; the package itself declares no external runtime dependencies.
Is the full documentation here, or somewhere else?This top-level README is just a map of the monorepo; detailed behavior, API, and caveats of the virtual bash environment are documented in the just-bash package's own README, which isn't included in this file.
Does it run only in Node, or also in the browser?There's a dedicated 'build:worker' build step and a 'test:wasm' test suite alongside the regular TypeScript build, which points to a WebAssembly target meant to run outside plain Node (e.g. in a browser or worker sandbox) in addition to the normal package.
Is just-bash a real bash interpreter or just an approximation?It's described as a 'simulated bash environment', meaning it emulates bash-like commands over a virtual filesystem rather than being a full POSIX-compliant shell.
Why would an agent need a fake bash instead of the real shell?Running commands against a virtual filesystem lets an AI agent execute bash-like operations safely without risking damage to the host machine's real files.
Does just-bash pull in a lot of external dependencies?Its package metadata lists no external runtime dependencies, keeping the library self-contained.
Size
30 MB
Stars
4.4K
Age
9mo
Commits · 90 Days