Skip to main content

shellsim

Shellsim is a BusyBox for containers: one small, deterministic process that provides a useful Unix-shaped environment without starting a VM, container runtime, or host subprocess. It is built for experimentation and testing with reinforcement-learning rollouts and agentic environments, where fast startup, reproducibility, isolation, and explicit resource limits matter more than cycle-accurate emulation.

Shell programs, common command-line tools, logical processes, and Python run in-process against an in-memory filesystem. Simulated code cannot access the host filesystem, processes, network, environment, or clock. A trusted harness may copy a selected project into the virtual filesystem before execution; changes never write back to the host.

Compatibility

Shellsim aims for broad compatibility inside clear boundaries. A supported facility should handle almost all ordinary uses, even when obscure flags or legacy behavior remain out of scope. A module or command with no coherent useful subset is omitted instead of being exposed as a misleading stub. Unsupported syntax, options, executable formats, and capabilities fail visibly and are included in structured results.

The current environment includes:

  • a Bash-like shell with pipelines, redirections, functions, common expansions, control flow, background jobs, signals, and job control;
  • common filesystem, text, archive, Git, Make, process, and system commands;
  • deterministic virtual time, network fixtures, /proc, /dev, processes, descriptors, and bounded pipes;
  • a mostly complete Python language runtime with a deliberately selected standard-library and third-party module surface.

Python is source-compatible where supported, not ABI-compatible with CPython. Native extensions, network package installation, and arbitrary host machine code are outside the simulation boundary. A limited Wasm-hosted C toolchain can be supplied as a virtual executable. The simulated pip and uv paths can activate packages already bundled with shellsim; they reject other packages instead of fetching them. See Python in shellsim for the current contract.

git provides a porcelain subset backed by the virtual filesystem: staging, commits, history, diffs, branches, tags, merges, stashes, and search, with output that matches real Git where an agent is likely to parse it. Networked subcommands and content conflicts are refused rather than approximated. See Git in shellsim for the supported surface and its boundaries.

Common utilities accept clustered short options, long options, option values, and -- through a shared parser. Each utility declares its supported options. For example, grep supports ordinary basic and extended regular expressions, recursive search, fixed strings, word and whole-line matching, pattern files, include and exclude filters, context, counts, line numbers, match limits, and common output controls. sed covers addresses and ranges plus the common substitution, selection, text, transliteration, and early-exit commands. awk parses a typed language subset with record rules, control flow, fields, associative arrays, arithmetic, regular expressions, and the usual scalar functions. Unsupported syntax and options exit nonzero with a direct diagnostic; text processing is UTF-8-only unless a command documents a byte-oriented mode.

Install and run

Install the Python package and console command:

python -m pip install shellsim
shellsim -c 'printf "b\na\n" | sort'
shellsim --root ./project -c 'python3.14 test.py'

--root copies the selected host tree into a disposable /work snapshot. With no -c and a terminal attached, shellsim starts a persistent interactive session.

To build the Rust binaries from source:

cargo build --release
./target/release/shellsim -c 'echo hello'
./target/release/shellsim eval --cpu 100k --memory 8m -c 'make test'
./target/release/shellsim-python ./project/main.py -- arg1

Limits accept k, m, and g binary suffixes. eval emits a structured result containing the exit status, stdout and stderr, resource use, command trace, and unsupported behavior. unsupported_commands lists recognized or attempted commands that crossed the capability boundary; invocation records include trust, status, and the unsupported reason.

The Python API exposes fresh and persistent environments:

import shellsim

environment = shellsim.Environment(cpu=100_000)
environment.write_file("/work/main.py", "print(6 * 7)\n")
result = environment.run("python3.14 /work/main.py")
assert result.returncode == 0
assert result.stdout == b"42\n"

environment.run() reuses the default shell. To keep independent shell state in one machine, create additional sessions; they share the virtual filesystem and resource limits:

first = environment.create_shell()
second = environment.create_shell()
first.run("cd /work; export LABEL=first")
assert first.run("printf '%s' \"$LABEL\"").stdout == b"first"
assert second.run("printf '%s' \"${LABEL-unset}\"").stdout == b"unset"

Static HTTP fixtures use the same isolated environment. They do not enable sockets, DNS, TLS, or host-network access:

environment = shellsim.Environment(http={
    "https://api.test/items/*": shellsim.HttpResponse(
        status=200,
        headers={"Content-Type": "application/json"},
        body='{"items": []}',
    ),
})
result = environment.run("curl -s https://api.test/items/1")

result = environment.run_python("""
from urllib.request import urlopen
print(urlopen('https://api.test/items/1').read())
""")
assert result.network_requests[0].matched

Python source can bypass shell parsing and quoting while using the same isolated runtime:

result = shellsim.python.run("print(sum(range(10)))", argv=["example"])
result.check_returncode()

environment = shellsim.Environment()
result = environment.run_python("print('persistent VFS, fresh Python interpreter')")

Clock modes

A machine runs on virtual time by default: when every process waits on a timer, the scheduler jumps the clock to the next deadline, so sleep 3600 costs no host time and runs are reproducible. An embedder can boot a machine with Environment::with_limits_and_clock(limits, ClockMode::RealTime), or with the CLI's --real-time option, for interactive demos. Its clock then follows physical time from boot: shell, Python, and Wasm sleeps take real time, and clock reads report elapsed time. Polling never blocks in either mode. An idle real-time machine reports that it is blocked, and Environment::host_wait_until says how long to wait. Simulated programs cannot choose the mode, and a snapshot of a real-time machine is not reproducible.

Experimental Wasm executables

An executable VFS file beginning with the WebAssembly magic bytes runs through a fuel-metered Wasmtime engine. The WASI Preview 1 adapter provides standard streams, arguments, exported environment variables, the virtual clock, deterministic random bytes, and basic regular file access relative to the virtual working directory. It does not expose host files, processes, network, environment, or time. Invalid modules and imports outside the WASI namespace fail with a diagnostic. Unavailable WASI calls trap if reached; they never report fake success.

A Wasm executable runs as its own scheduled process on that process's virtual descriptors. A read or write that would block suspends the guest until the pipe or terminal is ready, so a guest can answer a prompt, sit in the middle of a pipeline, or be stopped by kill or timeout. A write to a pipe with no reader ends the guest with status 141. Fuel yields keep a compute-bound guest from starving other processes, and consumed fuel counts against the machine's CPU budget while the guest runs. A harness fork taken while a guest is running gets a copy of that process that fails with status 126 and a diagnostic, since a live Wasmtime stack cannot be cloned. Clock subscriptions to poll_oneoff, which back libc sleep and nanosleep, block the guest on virtual time like the native sleep command.

This is not full WASI process support. Descriptor subscriptions to poll_oneoff fail with ENOTSUP; sockets and guest process creation remain unsupported. No C compiler is installed by default. The engine accepts Wasm exception instructions. A pinned external TinyCC package and permissively licensed wasi-libc sysroot can be installed into the VFS by a caller; integration tests compile and run C programs through that virtual toolchain. This is a tested subset of libc, not full POSIX support. A prebuilt wasm32-wasip1 command that uses only the listed imports can be written to the VFS with executable permissions and invoked by path or through PATH.

The virtual display lets a Wasm guest present RGBA frames and poll bounded key events. A host-driven session can resume the guest between frames without granting it ambient display, input, or network access.

Agent harness

shellsim serve --root ./project runs a persistent newline-delimited JSON session. It supports bounded execution, streaming actions, VFS operations, checkpoints, workspace diffs, process and resource inspection, and deterministic session forks. shellsim mcp exposes the same environment as a stdio MCP server. shellsim replay scenario.ndjson reruns checked action transcripts. shellsim corpus manifest.json runs frozen shell and Python workloads under a versioned stock environment and emits a classified JSON report. See compatibility testing.

printf '%s\n' \
  '{"id":1,"op":"execute","source":"printf hello > result"}' \
  '{"id":2,"op":"workspace_diff"}' \
  | shellsim serve --root ./project

Resource model

CPU is deterministic fuel, memory is modeled working set, disk is current virtual-filesystem usage, and output bounds materialized stdout and stderr. The defaults are 10,000,000 CPU units, 64 MiB memory, 64 MiB disk, and 4 MiB output. Costs use simple, stable approximations intended to be correct within an order of magnitude. They bound runaway work and make runs comparable; they do not model allocator layouts or instruction timing exactly. Exhaustion is observable and never falls back to an ambient host implementation.

Every CLI command that boots a machine accepts the same options: --cpu, --memory, --disk, and --output (counts accept k, m, or g suffixes), and --real-time. They may precede the command, as in shellsim --cpu 1m -c 'make'. Commands without script arguments (shell, eval, serve, mcp, replay) also accept them after the command name.

For internals and contribution workflow, see implementation, Python, and CONTRIBUTING.md.

Metadata

Release files for shellsim 0.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shellsim 0.1.20
File Size Uploaded
shellsim-0.1.20.tar.gz 839.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for shellsim 0.1.20
File
shellsim-0.1.20-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details
shellsim-0.1.20-cp39-abi3-manylinux_2_28_x86_64.whl CPython 3.9 abi3 Linux glibc 2.28+ x86-64 Details
shellsim-0.1.20-cp39-abi3-manylinux_2_28_aarch64.whl CPython 3.9 abi3 Linux glibc 2.28+ ARM64 Details
shellsim-0.1.20-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details
shellsim-0.1.20-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details

Total release size: 24.3 MB

Release files / shellsim-0.1.20.tar.gz

Download URL shellsim-0.1.20.tar.gz
Size 839.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a295b4035c6155d060c33436bc5a309634fb79faac896693f78d37f4cc0bd392
BLAKE2b-256 checksum
How to use checksums
6e8de0c8cc07b07eb54d67e0bc5f3b8cf9e013bfffe86102344f520eaa25e09a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / shellsim-0.1.20-cp39-abi3-win_amd64.whl

Download URL shellsim-0.1.20-cp39-abi3-win_amd64.whl
Size 4.9 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
fbb84b700f5922c133a21f35dd3c3571130cc1350f68f19a5dbd6151d9b5b344
BLAKE2b-256 checksum
How to use checksums
9b6e37dc6eb45c02dd134d0243f673b8525e8f8c127474546582d99e62781bc1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / shellsim-0.1.20-cp39-abi3-manylinux_2_28_x86_64.whl

Download URL shellsim-0.1.20-cp39-abi3-manylinux_2_28_x86_64.whl
Size 5.0 MB
Tags CPython 3.9 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
fe551c681d6b5fd8c8162cf952d87137cccf2eb82a108310971867c5729b6910
BLAKE2b-256 checksum
How to use checksums
ea6875443d675750f89b36099d085a5d05263fd18f70c240f0e59e0835de0482
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / shellsim-0.1.20-cp39-abi3-manylinux_2_28_aarch64.whl

Download URL shellsim-0.1.20-cp39-abi3-manylinux_2_28_aarch64.whl
Size 4.7 MB
Tags CPython 3.9 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
e1b6cccb606deb1359d66dd8aee1ea65fc92ca51f70a61594308441f0848f6c5
BLAKE2b-256 checksum
How to use checksums
a0846ad3a8e550d1362131984d12a317e97e277a09a63a0b83f7446ee073da46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / shellsim-0.1.20-cp39-abi3-macosx_11_0_arm64.whl

Download URL shellsim-0.1.20-cp39-abi3-macosx_11_0_arm64.whl
Size 4.2 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
5995d21579559a2ab6e7ad94b0a26509045ce8ab287ff18c34a76588a22147ec
BLAKE2b-256 checksum
How to use checksums
575f243de4ae362ba43936f9cde8fb5f0d03e8ae32336e22553a91ec5cdaed6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / shellsim-0.1.20-cp39-abi3-macosx_10_12_x86_64.whl

Download URL shellsim-0.1.20-cp39-abi3-macosx_10_12_x86_64.whl
Size 4.6 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
6b2a4bc24f614465b02643e89450029dc6a06e459e03f4348e2c1507a58ccab6
BLAKE2b-256 checksum
How to use checksums
ddaa57eeec60c07d4c7dbe162630d22044fdeb0ebf459257c4868d05631703d8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release history Release notifications | RSS feed

0.1.37

4 release files

0.1.36

4 release files

0.1.35

4 release files

0.1.34

5 release files

0.1.33

5 release files

0.1.22

6 release files

0.1.21

6 release files

This release

0.1.20 This release

6 release files

0.1.19

6 release files

0.1.18

6 release files

0.1.17

6 release files

0.1.16

6 release files

0.1.15

6 release files

0.1.14

6 release files

0.1.13

6 release files

0.1.12

6 release files

0.1.11

6 release files

0.1.10

6 release files

0.1.9

6 release files

0.1.8

6 release files

0.1.7

6 release files

0.1.5

6 release files

0.1.4

6 release files

0.1.3

6 release files

0.1.2

6 release files

0.1.0

6 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page