Installation

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:

npm i -D sootsim

Then either connect to a running dev server:

npx sootsim open 8081

or install the optional dev-server integration:

npx sootsim setup-repo
npx sootsim setup-repo --dry-run

sootsim setup-repo detects the app type and updates the right config:

Expo / bare React Native / Metro apps

• adds sootsim as a dev dependency
• wraps metro.config.js with withSootsim()

One apps

• adds sootsim as a dev dependency
• adds sootsimPlugin() to vite.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:

npm i -g sootsim

Then use:

sootsim open 8081

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.