Getting Started

Overview
Installation
Quick Start
First Test
Plans
FAQ

Guides

Testing
Configuration
Wrap Existing App
Detox Migration
CI
MCP

Agents

Setup
CLI Use
Agent Devtool (Inspect)

CLI

Overview
preview
test
flow
maestro
detox
record
profile
assert
screenshot
get
screenshots
do
screenshot-mode
wait
shell
upload
inspect
network
logs
debug
open
list
use
skills
claim
close
config
compat
electron
daemon
server
runtime
launch
setup-repo
install-desktop
login
logout
whoami

API

Config
Settings
Metro Plugin
One Plugin
Agent Skills
Test Bridge
Detox Driver
Maestro Driver

Architecture

Overview
Workers
Rendering
Layout
Gestures
Animation

Compatibility

Overview
Registry & Overrides
Custom Stubs

sootsim electron

Launch the installed desktop companion directly, optionally opening a local Metro/dev-server port through the same shell URL resolver as sootsim open.

terminal

sootsim electron [--port <number>] [--driver <id>]

Options

flagdescription
--port <number>open a local app server through the sootsim shell, for example Metro on 8081
--driver <id>override the launch driver (electron|chromium|playwright|system)

Examples

terminal

sootsim electron

sootsim electron --port 8081

sootsim electron --driver system

Desktop Companion Role

The desktop companion is the persistent local host option. It is the right fit when you want:

  • a tray or login-item style workflow
  • a window that stays inspectable over the same bridge host
  • an installed local companion that sootsim open can prefer automatically

The CLI command here is intentionally thin. Its job is to find the installed companion and launch it with the right URL.

Related

previous

compat

next

daemon