Getting started

Installing

On macOS or Linux:

curl -fsSL https://brimlang.com/install.sh | sh

On Windows, in PowerShell:

irm https://brimlang.com/install.ps1 | iex

The script picks the build for your platform, checks its checksum and puts brim in /usr/local/bin (or ~/.local/bin). You can also download an archive from the releases yourself and put brim on your PATH. The -native archives can also compile native executables with brim build; they need a C compiler to link: cc on Linux and macOS, and on Windows clang (from LLVM) with the Visual Studio C++ build tools.

Or build it from source with Rust 1.88 or newer:

git clone https://github.com/ordnary-com/brim.git
cd brim
cargo install --path crates/brim-cli

For native builds from source, see the development guide.

A first program

Save this as hello.brim:

fn main() {
    print("Hello, world!")
}

and run it:

brim run hello.brim

brim check hello.brim only reports errors, and brim build hello.brim writes a native executable hello next to it.

A first project

brim new greeter
cd greeter
brim run
brim test

brim new creates a brim.toml, a src/main.brim with a test, and a .gitignore. Inside a project, commands find the brim.toml themselves. Continue with the tour.