@solidrt/cli

Developer tooling for SolidRT: sol, one command-line tool covering the whole cycle of a @solidrt/core application: scaffold, develop, inspect, ship. A GUI inspector, itself a SolidRT app, is in progress alongside it.

LLM agents: AGENTS.md in this package is a dense, self-contained quickstart.

Bun is a dev prerequisite only; apps run on the bundled flux runtime. Invoke via bun run sol <command>. A scaffolded project wires the common commands into scripts, so day-to-day work is bun run dev, bun run android (and server, client, pack for the rest).

Commands

| Command | | | --- | --- | | sol init <dir> | scaffold a new project into a new (empty) folder | | sol run [file] | dev server + local client window | | sol server [file] | dev server only | | sol client | client only, attached to the project's dev server | | sol android | install and launch the client on a connected Android device | | sol demo [n] | list the demos the CLI ships, or run one | | sol console | start the dev console: the dev servers on this machine and their clients | | sol check [file] | build and typecheck, writing nothing | | sol test [file] | run the tests (tests/*.test.ts) on the flux runtime | | sol bundle [file] | transpile to JS or bytecode (dist/bundle/) | | sol render [file] | render frames offscreen, optionally replaying a script | | sol pack [file] | bundle + compile to a standalone executable (experimental) | | sol mcp | MCP server (stdio) exposing the running dev server to agents |

sol --help lists every command and option; sol --version prints the version. Run from the project root to work on the project (its entry is solidrt.entry in package.json, default src/index.tsx); pass a file to work on that file on its own.

Develop

sol run

Starts the dev server and a local client window against it. The server pushes the bundle to every connected client, so one server can drive a desktop window and a phone at the same time; edits reach them on an explicit reload (the MCP reload tool) or on save.

Split them when you need to:

sol server                        # server only
sol client                        # client only, the project's server (from its root)
sol client --server 192.168.1.5:34884  # client only, pointed at that address
sol android                       # install and launch on a connected device

Inspect

sol mcp

Exposes the running app to a coding agent: logs, stats, the live render tree, screenshots, GPU resources, input injection, a virtual-time transport, reload, and the app's own debug commands. A scaffolded project ships an .mcp.json, so Claude Code attaches with no setup.

Record and replay

sol run --capture session.json
sol render --script session.json --fps 60 --duration 5

--capture records key events from connected clients to a script; render replays it headlessly and writes frames, which makes bug reports reproducible and turns an interaction into a video.

Ship

sol check .                # build and typecheck every entry, no build output
sol test                   # run every tests/*.test.ts on the flux runtime
sol bundle                 # transpile to JS or bytecode
sol pack                   # standalone executable (experimental)

sol bundle --flux and sol pack --flux target the bare Flux runtime instead of a SolidRT app, for scripts and servers with no UI.

Layout

One folder per command under src/, named for what it does; the first line of each says its runtime. src/server/ is the dev server, a flux script (bun-free at runtime, its own tsconfig); every other command runs on bun. src/lib/ is what the bun commands share, src/types/ the type-only contracts between the two runtimes. Each command folder carries its docs.md (this site); the depth agents need lives in agents/ at the package root, as in the other packages.