Installation
Install the CLI and a prebuilt runtime sidecar.
Installation
MicroStudio is published to npm under two names — microstudio and
@microstudio/cli — and the runtime it drives ships with it as a prebuilt
sidecar. Installing it needs no toolchain.
Requirements
MicroStudio needs Node 22.18 or newer. Node strips TypeScript natively, so there is no build step for the CLI itself.
Rust is only needed if you are building this repository. Everything else — roblox-ts, Rojo, Roblox Studio — is not required to install or run MicroStudio.
Installing with no toolchain
npm install -g microstudio # or: npm install -g @microstudio/cli
npx microstudio --version # or: npx @microstudio/cli --version
npm install --save-dev microstudio # as a project's own test commandmicrostudio and @microstudio/cli are the same package published under two
names, and it installs as microstudio under either.
Prebuilt platforms
The runtime is compiled once per platform and published as its own small package, so an install keeps only the one that matches the machine. Nothing is compiled locally — no Rust, no MSVC, no build step.
| Platform | Architectures |
|---|---|
| Linux | x64, arm64 |
| macOS | Intel, Apple silicon |
| Windows | x64, arm64 |
Each package is static against its platform's C++ runtime, so an install never has to fetch a redistributable either.
Unsupported platforms
A platform with no prebuilt sidecar still installs the rest of the tool, and then names the package that is missing — rather than failing in the middle of a run.
If you need a sidecar from somewhere unusual, point MicroStudio at it directly:
| Variable | Effect |
|---|---|
MICROSTUDIO_RUNTIME_BIN | use this sidecar binary instead of the installed one; it must exist, or the driver fails loudly |
MICROSTUDIO_TARGET_DIR | cargo target directory to search for the binary |
CARGO_TARGET_DIR | same, for redirected cargo output |
Resolution order is: the override above, then a source checkout's cargo output, then the installed platform package.
Building this repository
Only needed if you are working on MicroStudio itself, or on a platform with no prebuilt sidecar. This path needs Rust and Node, and nothing else:
git clone <this repo> && cd MicroStudio
corepack enable # once: makes `yarn` the pinned release
cargo build --bin microstudio-runtime # or: yarn build:runtime (release)
yarn installcorepack enable installs the Yarn release named by packageManager in
package.json. If yarn --version reports something else, a Yarn of your own is
earlier on PATH; corepack yarn always uses the pinned one. Node 25 and newer
no longer ship corepack, so those installs need npm i -g corepack first.