Skip to content

Installation

This guide covers installing ELMOS and its prerequisites on macOS.

Prerequisites

ELMOS requires macOS Sequoia (15.0+) or later. Install these dependencies via Homebrew:

brew install llvm lld gnu-sed make libelf git qemu fakeroot e2fsprogs coreutils go-task wget

Install Xcode Command Line Tools for SDK headers:

xcode-select --install

Note

If you encounter "gmake not found", use brew install make and alias gmake to make.

Build ELMOS

Clone the repository and build the binary:

git clone https://github.com/NguyenTrongPhuc552003/elmos.git
cd elmos
task build  # Builds to build/elmos

Initialize Workspace

Create a workspace with sparse image and config:

./build/elmos init

This generates:

  • build/elmos.sparseimage - Workspace disk image
  • build/elmos.yaml - Configuration file

Verify Setup

Run the environment doctor to check dependencies:

./build/elmos doctor

If issues arise, see Troubleshooting.

Optional: Install Toolchains

For full functionality, install crosstool-ng toolchains:

./build/elmos toolchains install  # Install crosstool-ng
./build/elmos toolchains list     # List targets
./build/elmos arch riscv          # Select architecture
./build/elmos toolchains build    # Build toolchain (~30-60 min)

See Toolchains for details.

Next Steps