Installation
Prerequisites
- Go 1.22+ — Cleat compiles to Go, then to native binaries. Install from go.dev.
Build the compiler
bash
git clone https://github.com/cleat-lang/cleat.git cd cleat go build -o cleat ./cmd/cleat
On Windows:
bash
go build -o cleat.exe ./cmd/cleat
Verify
bash
./cleat
You should see:
text
cleat - A compiled orchestration language for auditable, stateful AI backends Usage: cleat build <file.cleat> Compile to native binary cleat run <file.cleat> Compile and execute cleat check <file.cleat> Type check only cleat fmt [-w|-check] <path> Canonicalize source cleat test <path> Run test blocks in a file or directory cleat lex <file.cleat> Tokenize (debug) cleat lsp Start language server cleat new <name> Scaffold a new project
Add to PATH (optional)
Move the binary to a directory on your PATH:
bash
# macOS/Linux sudo mv cleat /usr/local/bin/ # Windows — add the build directory to PATH, or move cleat.exe
Smoke test
bash
cleat run examples/hello_stdlib/hello.cleat
This should print a SHA-256 hex digest and exit cleanly.
Run the test suite
bash
go test ./...
All 826+ tests should pass.
Next steps
- Your First Program — create and run your own Cleat program
- Editor Setup — VS Code extension