Authoritative documentation · English

Install and build Harnesser

mise is the supported portable default for pinned host tools on macOS, Windows, and Linux. From the repository root, run:

mise trust
mise install
just bootstrap
just doctor

OrbStack first

On macOS, install OrbStack before any other container tooling. Start it with orb start and confirm that its Docker context is active. brew bundle installs OrbStack alongside the other repository dependencies. On Linux and Windows, use a Docker-compatible engine with Compose v2. Harnesser desktop packages do not require a container engine after installation.

Platform SDK exceptions

mise pins language runtimes and portable CLIs; it does not replace vendor platform SDKs. Install Xcode and its command-line tools for macOS and iOS, Visual Studio Build Tools with the Windows SDK for Windows, and Android Studio with the Android SDK plus NDK 28 or newer for Android. Accept vendor licenses in the vendor tools.

Fallback only

rustup is documented only as a fallback when mise cannot be installed. In that case, install the exact Rust version from rust-toolchain.toml and separately provide every other version pinned in .mise.toml. Do not mix an unpinned rustup default with the repository toolchain.

Verify the installation

After bootstrap, run the doctor command to confirm that every pinned tool, SDK, and engine is reachable:

just doctor

The doctor reports missing or mismatched versions. Platform-specific variants (just doctor-desktop, just doctor-mobile, just doctor-web, just doctor-runtime) scope the check to one target.

Contributor quick-start

Once the toolchain is healthy, the standard development loop is:

just build
just test
just lint

just build compiles the Rust workspace and the web frontend. just test runs the full Rust and pnpm test suites. just lint enforces formatting, Clippy, ESLint, and PHP static analysis. All three must pass before a pull request.

For the self-hosted Runtime stack, see Runtime API and the docs/install/ directory in the repository for OrbStack-first container setup, secrets, and compose instructions.