Developer preview v1.1.2 — installation, packaging, and some platform support are still in progress. Read the status
Skip to content

Quick start ​

Clorraine is a developer preview. The Linux x86_64 path works today; the Docker SDK is the supported way to build for the Amiga. One-click installers for Windows and macOS are in progress and are not shown here as if they existed.

Choose a path ​

OptionWhat it gives youRequirements
Linux x86_64 tarballclc and clorraine binariesglibc 2.34+; a C compiler for the host profile
Docker SDKFull m68k toolchain, vamos, FS-UAE, NDK headersDocker; network; a 30–90 minute first image build
Build from sourceAll three binaries, including the language serverRust stable; no external crates
One-click installersPlanned for Linux, macOS, and WindowsNot available yet

Linux binary ​

Download the current release and verify it:

sh
curl -LO https://github.com/OpenLorraine/clorraine/releases/download/v1.1.2/clorraine-1.1.2-linux-x86_64.tar.gz
curl -LO https://github.com/OpenLorraine/clorraine/releases/download/v1.1.2/SHA256SUMS
sha256sum -c SHA256SUMS --ignore-missing
tar xzf clorraine-1.1.2-linux-x86_64.tar.gz
export PATH="$PWD/clorraine-1.1.2:$PATH"
clorraine --version

The tarball contains clc and clorraine. It does not contain clorraine-lsp; build the language server from source.

Your first program ​

Create hello.clo:

clorraine
module demo.Hello;

import { println } from std.io;

func main(): i32 {
    let who: str = "Amiga";
    println($"Hello, {who}, from Clorraine!");
    return 0;
}

Run it with the host profile:

sh
clorraine run hello.clo

Output:

text
Hello, Amiga, from Clorraine!

clorraine emits one C99 translation unit, compiles it with the host C compiler, and runs the result. Use clorraine emit hello.clo -p host to read the generated C.

Amiga SDK in Docker ​

The SDK image is the reproducible Amiga environment. It builds GCC, binutils, libnix, the NDK headers, vbcc, vamos, and FS-UAE support from pinned upstream sources. The first build compiles the toolchain and takes roughly 30–90 minutes.

sh
git clone https://github.com/OpenLorraine/clorraine.git
cd clorraine
make setup FETCH=1

make setup FETCH=1 detects the host tools, builds the pinned image if it is missing, and re-checks the result. To see the plan without changing anything:

sh
make setup DRY=1

Then run a program through the driver inside the SDK:

sh
make run FILE=examples/hello/hello.clo
make run FILE=examples/hello/hello.clo PROFILE=hosted-amiga

The second command builds for hosted-amiga and runs the program under vamos. No Kickstart ROM is needed for a console program on that path.

For a graphics demo, boot FS-UAE on the host:

sh
make run FILE=examples/amiga/boing.clo PROFILE=hosted-amiga-13 EMULATOR=1

The A500 path needs the licensed Kickstart 1.3 ROM in ~/amiga/roms. If you only want to try the toolchain, the vamos path above needs no media at all.

What you need for the Amiga path ​

RequirementProvided byNotes
m68k-amigaos-gcc and NDK headersDocker SDKBuilt from pinned public sources
vamosDocker SDKRuns CLI binaries on the host without a ROM
FS-UAEDocker SDK and hostGraphics and audio need an X display
Kickstart ROMYouOnly for FS-UAE with original media; AROS is the default
Workbench mediaYouOnly for the advanced Workbench gates

The SDK never downloads or copies licensed media. See the media and NDK policy.

Build from source ​

The Rust workspace has one member and no external crates:

sh
git clone https://github.com/OpenLorraine/clorraine.git
cd clorraine
cargo build --workspace

The binaries are written to target/debug/:

BinaryPurpose
clcCompile .clo sources to one C99 file
clorraineBuild, run, emit, document, and explain diagnostics
clorraine-lspStdio language server for editors

Run the fast verification gate from the repository root:

sh
make check

make check runs the spec check, the Rust test suites, the SDK installer tests, the benchmark harness tests, and the fuzz smoke matrix in the pinned container. The full Amiga acceptance gate is make verify; it needs the SDK, an X display, and the licensed media.

If something fails ​

Include the command, the profile, the compiler version (clorraine --version), and the generated C when you report a code-generation problem. A small, complete source file is the most useful reproduction.

Clorraine is an independent project. Amiga, AmigaOS, Kickstart, and Workbench are trademarks of Amiga Corporation. Not affiliated with or endorsed by Amiga Corporation or Hyperion Entertainment.