Installation
Repo install with npm i -D sootsim, global install, the optional setup-repo integration that wraps metro.config.js or vite.config.ts to expose /__soot, and the optional desktop app for macOS, Windows, and Linux.
SootSim is one npm package. Add it to a repo, or install it globally if you just want the CLI on your machine.
Repo install
This is the best default when a team wants the same setup everywhere:
terminal
Then either connect to a running dev server:
terminal
or install the optional dev-server integration:
terminal
sootsim setup-repo detects the app type and updates the right config:
Expo / bare React Native / Metro apps
- adds
sootsimas a dev dependency - wraps
metro.config.jswithwithSootsim()
One apps
- adds
sootsimas a dev dependency - adds
sootsimPlugin()tovite.config.ts
Both integrations are optional. They do not change your app code or create a
separate build target. They just expose a stable /__soot URL on the dev
server you already run.
Global install
If you want the CLI available everywhere on your machine:
terminal
Then use:
terminal
Desktop app
The desktop app is optional. It gives you a more simulator-like shell on top of the same SootSim runtime and works on macOS, Windows, and Linux.
Agentic use
The same sootsim CLI is how AI coding agents drive the sim — there is no
separate agent install and no MCP server to configure. Any agent that can run
shell commands (Claude Code, Claude Desktop, Cursor, Codex) uses sootsim
directly, with multi-agent claim leases and a persistent bridge daemon built
in.
terminal
See Agents → Setup to verify the bridge, Agents → CLI Use for the day-to-day commands, and MCP & Agent Tools for why the CLI is the integration surface instead of MCP.