Skip to content
All guides

servers

CLI and editors

One executable: buraaq: is the workflow. No CMake, no separate package manager, no linker-flag archaeology for the common path.

Install the toolchain: Install.

Commands

The self-hosted buraaq you install:

CommandContract
buraaq / repl / shellInteractive shell (clang per line)
buraaq -e SNIPPETCompile and run a one-liner
buraaq script FILE.bqCompile and run a .bq file
buraaq new NAME [--cli]Hello CLI scaffold
buraaq build [FILE.bq [OUT]]Native executable via LLVM + clang
buraaq run [FILE.bq]Build and execute
buraaq test [FILE.bq]Run selftest or a file
buraaq doctorClang, runtime, scripting line
buraaq --versionburaaq 1.0.0 (self-hosted)
buraaq -C DIR <cmd>Run the command in that directory
buraaq fmt FILE.bqFormat a file
buraaq lsp / lsp-serverLanguage server on stdio
buraaq pack / launch / ship / dockHashed .bur; live dock on :7422
buraaq fetch / add / indexIn-tree packages/index.json or BURAAQ_REGISTRY
buraaq debug [FILE.bq]clang -O0 -g + pretty-printer hints

Keel stays in the stack and stdlib. Pack / ship / dock are guest subcommands. land / up / ship --status / dock --bind are thinner than the Ship walkthrough.

Build a file:

buraaq build app.bq
buraaq run app.bq

Windows binaries need .exe. If a C runtime change does not seem to apply, delete target/.buraaq/build.json and rebuild.

Editors

Marketplace extension id: ThoriumDC.buraaq

ext install ThoriumDC.buraaq

Provides syntax highlighting, snippets, and on Windows a command to download the Release toolchain (buraaq + sysroot) into extension storage. Requires clang to link (optional winget LLVM.LLVM from the same extension). Point the editor at buraaq lsp (also buraaq lsp-server).

Listing: Visual Studio Marketplace: Buraaq. VSIX also ships on Releases.

Other editors

The compiler tree ships configs under editors/ for Vim, Neovim, Sublime Text, Helix, Zed, and JetBrains (TextMate grammar). Same buraaq lsp stdio server.

Layout

app/
  buraaq.pkg
  src/main.bq
  tests/smoke.bq
  public/          # Keel static files
  target/debug/
  target/ship/     # .bur bundles

Next: Ship: how that target/ship file is not a Docker image.