Install the CLIThe `idealyst` CLI is the entry point for scaffolding projects, running the dev server, building per-platform releases, and diagnosing your toolchain. It's installed from source via cargo.
PrerequisitesYou need a Rust toolchain (stable 1.78+) and git. The CLI itself has no platform dependencies — per-platform tooling (Xcode, Android NDK, wasm-pack) is only required when you actually build for that target.If you don't have Rust yet, install it via rustup:# rustup is the standard Rust installer
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
InstallFetch the latest commit on master, compile in release mode, and drop the `idealyst` binary into `~/.cargo/bin/` (which is on your PATH if you set up Rust through rustup):cargo install --git https://github.com/IdealystIO/idealyst-native idealyst-cli
To pin to a specific revision instead of master:# Pin to a specific commit / tag / branch:
cargo install --git https://github.com/IdealystIO/idealyst-native --rev <sha> idealyst-cli
cargo install --git https://github.com/IdealystIO/idealyst-native --tag <tag> idealyst-cli
cargo install --git https://github.com/IdealystIO/idealyst-native --branch <br> idealyst-cli
Pass `--force` if you're upgrading over an existing copy of the CLI. VerifyConfirm the binary is on your PATH and prints the subcommand list:You should see `new`, `init`, `dev`, `build`, `run`, `doctor`, and a few others. Per-platform toolingYou only need a platform's tooling when you actually build for that platform. The CLI is platform-agnostic; `idealyst doctor` tells you what each enabled target is missing.iOSXcode (App Store) + Xcode Command Line Tools. Both ship together. `xcrun simctl` and `xcodebuild` need to be available on your PATH — they are by default once Xcode is installed.AndroidAndroid Studio (or the SDK + NDK installed separately). The CLI looks for `ANDROID_HOME` and `ANDROID_NDK_ROOT`; if neither is set, `idealyst doctor` will tell you. You also need `adb` on your PATH.WebNothing extra. The CLI pulls in wasm-pack as part of its own build, and the wasm32 target compiles via your existing Rust toolchain.
Diagnose with `doctor`When something goes wrong, `idealyst doctor` walks each enabled target's toolchain and reports what's missing, with pointers to the install steps for each. Next stepsWith the CLI installed, scaffold your first project and run it on all three platforms in a few commands.Go to the Quickstart →