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
| Option | What it gives you | Requirements |
|---|---|---|
| Linux x86_64 tarball | clc and clorraine binaries | glibc 2.34+; a C compiler for the host profile |
| Docker SDK | Full m68k toolchain, vamos, FS-UAE, NDK headers | Docker; network; a 30–90 minute first image build |
| Build from source | All three binaries, including the language server | Rust stable; no external crates |
| One-click installers | Planned for Linux, macOS, and Windows | Not available yet |
Linux binary
Download the current release and verify it:
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 --versionThe tarball contains clc and clorraine. It does not contain clorraine-lsp; build the language server from source.
Your first program
Create hello.clo:
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:
clorraine run hello.cloOutput:
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.
git clone https://github.com/OpenLorraine/clorraine.git
cd clorraine
make setup FETCH=1make 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:
make setup DRY=1Then run a program through the driver inside the SDK:
make run FILE=examples/hello/hello.clo
make run FILE=examples/hello/hello.clo PROFILE=hosted-amigaThe 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:
make run FILE=examples/amiga/boing.clo PROFILE=hosted-amiga-13 EMULATOR=1The 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
| Requirement | Provided by | Notes |
|---|---|---|
m68k-amigaos-gcc and NDK headers | Docker SDK | Built from pinned public sources |
vamos | Docker SDK | Runs CLI binaries on the host without a ROM |
| FS-UAE | Docker SDK and host | Graphics and audio need an X display |
| Kickstart ROM | You | Only for FS-UAE with original media; AROS is the default |
| Workbench media | You | Only 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:
git clone https://github.com/OpenLorraine/clorraine.git
cd clorraine
cargo build --workspaceThe binaries are written to target/debug/:
| Binary | Purpose |
|---|---|
clc | Compile .clo sources to one C99 file |
clorraine | Build, run, emit, document, and explain diagnostics |
clorraine-lsp | Stdio language server for editors |
Run the fast verification gate from the repository root:
make checkmake 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
- Read the known limitations.
- Search or open an issue in GitHub Issues.
- Run
clorraine --helpfor the exact command-line surface. - For Docker, X11, ROM, and emulator problems, see docker/README.md.
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.