Installation
Install the native build tools, clone Inrux and run your first application.
On this page
Requirements
Use a stable Rust toolchain with Cargo and your operating system's native build tools. This alpha uses Rust edition 2024; an exact minimum supported Rust version has not been established. Install Git to clone the source.
Choose your operating system. The Cargo commands after these tabs work in macOS/Linux shells and Windows PowerShell.
Install Xcode Command Line Tools, which supply a C/C++ compiler and Git:
xcode-select --install
Install Rust with the official rustup installer. Open a new terminal after installation, then run:
rustup update stable
rustup component add rustfmt clippy
rustc --version
cargo --version
GPUI's normal shader build also needs full Xcode and its Metal compiler. If the Metal compiler is unavailable, use the runtime-shaders option shown below. egui and Masonry do not use that GPUI option.
Python 3 runs repository consistency checks. Node.js 22.19 or newer and npm build the VS Code extension. The documentation website uses pnpm 10.7.1 as well. These tools are not required to build an application from a checkout with Rust and the native dependencies installed.
The CI matrix includes Linux, macOS and Windows. Backend requirements and graphics drivers can still affect native builds; this does not certify every desktop configuration. Start with egui and check the support matrix before choosing experimental backend features.
Get the source
git clone https://github.com/igris-labs/inrux.git
cd inrux
Keep Cargo.lock and the checked-in vendor/ patches. They are part of the reproducible checkout. There is no crates.io release yet.
Run an example
From the repository root, run one application at a time:
cargo run -p inrux-playground-egui --locked
cargo run -p inrux-playground-masonry --locked
cargo run -p inrux-playground-gpui --locked
On macOS without the Metal compiler:
cargo run -p inrux-playground-gpui --features runtime-shaders --locked
The runtime shader option changes startup work; account for it in comparisons. The first build downloads and compiles native dependencies and can take substantial time. Playground usage explains the controls and examples.
Create your own app
From the framework root:
cargo run -p inrux-cli -- new ../hello-inrux --framework-path . --backend egui
cd ../hello-inrux
cargo run
The destination must not already exist. --framework-path points to your Inrux checkout. Choose egui, masonry or gpui; the generated manifest selects only that backend. For a generated GPUI app on macOS without the Metal compiler, enable the facade's gpui-runtime-shaders feature in its Cargo.toml.
The generated project contains:
hello-inrux/
├── Cargo.toml
├── build.rs
└── src/
├── main.rs
├── App.iru
├── components/Counter.iru
├── composables/
└── styles/global.css
build.rs compiles App.iru and its imported component graph. main.rs includes the generated bootstrap and mounts the root. Edit App.iru for layout and logic; import reusable .iru components explicitly from its <rust> block. Ordinary .rs helpers and Cargo dependencies remain available.
The scaffold currently parses its global stylesheet once at startup. The playground build scripts show how to precompile standalone CSS into Rust as well as compiling .iru style blocks. See authoring and styling.
Development commands
You may install the local CLI once:
cargo install --path packages/inrux-cli --locked
Then, from an application directory, use cargo inrux check, cargo inrux run or cargo inrux dev. The development command watches sources and rebuilds/restarts the process; it does not preserve application state. Plain Cargo commands continue to work. See the CLI README.
For .iru formatting and Rust editing features, follow VS Code setup. For reproducible bug reports, include rustc --version, your OS and selected backend.