Install

You need Buraaq and clang. You do not need Node, a JVM, or Docker.

Source: github.com/ThoriumDC/buraaq. Releases: latest

Pick a path (Windows)

Method	When to use
winget	Preferred once the community package is live
Release zip	Works today: exe + sysroot, no clone
Clone + `install.ps1`	Contributors / full tree on disk
VS Code extension	Editor support (compiler still required)

winget

winget install buraaq
buraaq doctor

Package id: ThoriumDC.Buraaq (moniker buraaq). Pulls LLVM.LLVM when needed. If search finds nothing yet, the winget-pkgs listing is still merging: use the Release zip below.

Release zip (no git)

Download `buraaq-*-windows-x64.zip` from the latest Release.
Unzip somewhere stable (for example %LOCALAPPDATA%\buraaq).
Add that folder to PATH so buraaq.exe resolves (keep sysroot\ next to the exe: the compiler looks for <exeDir>\sysroot).
Run buraaq doctor.

Also on the Release: a single buraaq-*-windows-msvc.exe (pair it with a sysroot from the zip or a clone) and the VS Code VSIX.

Clone + installer

git clone https://github.com/ThoriumDC/buraaq.git
cd buraaq
.\install.ps1
buraaq doctor

Copies dist\buraaq.exe and the stdlib into %USERPROFILE%\bin as buraaq.exe + sysroot\. Optional prefix:

.\install.ps1 -Prefix C:\Users\you\bin

Add that folder to PATH if the shell cannot find buraaq.

Linux and macOS

git clone https://github.com/ThoriumDC/buraaq.git
cd buraaq
./install.sh
buraaq doctor

LLVM sidecar: ~/.local/share/buraaq/llvm when clang is not already on PATH.

Editor (VS Code / Cursor)

Official extension is live on the Marketplace: ThoriumDC.buraaq.

ext install ThoriumDC.buraaq

On Windows, if buraaq is not on PATH, open a .bq file (or run Buraaq: Install Compiler Toolchain) and the extension can download the Release zip (buraaq.exe + sysroot) into its storage and put it on the integrated-terminal PATH. It can also offer Buraaq: Install LLVM (clang) via winget. Building still needs clang; the extension does not vendor a full LLVM tree.

Or install only the VSIX from the Release (editor bits without auto-download until you run the command):

code --install-extension https://github.com/ThoriumDC/buraaq/releases/latest/download/buraaq-1.0.1.vsix

Prefer Marketplace 1.0.1+ for toolchain install. The VSIX on the Release is also 1.0.1.

Confirm

buraaq --version
buraaq --sysroot
buraaq doctor

doctor prints host triple, sysroot, clang path, bootstrap status, and a scripting line. If clang is missing, run scripts/ensure-llvm.ps1 (Windows) or scripts/ensure-llvm.sh from a clone, or winget install LLVM.LLVM. Clang is required for native run / build / flash and for the shell / -e / script.

Try the shell: buraaq then :quit. One-liner: buraaq -e "println(42)". Full guide: Scripting.

Mind (local models): buraaq ai doctor then Mind learning path.

What you do not install

Tool	Needed to use Buraaq?
Node / npm	No (only to hack on buraaq.dev)
Docker	No (Ship is a hashed `.bur`)
Postgres	Only for Keel `api(...)` apps
A JVM / GC	No

First program: buraaq new hello --cli then buraaq run. Next: Getting started | What 1.0 ships.