Augur docs

Getting Started

Installation & Running

Augur is built on Bun (>= 1.3.0). For development you need Bun; to run a compiled binary you need nothing at all.

bun install
bun run src/index.ts <file.aug> [options]
CommandWhat it does
bun run src/index.ts file.augRun a program.
bun run src/index.ts --seanceStart the interactive REPL.
bun run buildCompile a standalone binary ./aug.
bun run typechecktsc --noEmit (Bun does not type-check on its own).
bun run testRun the vitest suite (offline, on the fake oracle).

The REPL (séance)

Type one line at a time; exit or quit leaves the séance.

$ bun run src/index.ts --seance
augur séance - type a line, or 'exit' to leave
aug> certain { proclaim 2 + 2 }
4
aug> exit

Standalone binary

bun build --compile bundles the runtime and the interpreter into a single executable. No Bun or Node is needed to run the result.

bun run build        # -> ./aug
./aug examples/semantic_etl.aug

Cross-compilation

bun build src/index.ts --compile --target=bun-linux-x64    --outfile aug-linux
bun build src/index.ts --compile --target=bun-darwin-arm64 --outfile aug-mac
bun build src/index.ts --compile --target=bun-windows-x64  --outfile aug.exe
The default oracle is fake — a deterministic, offline stub used by the test suite. Programs run with no API key and no network. Point at a real provider with oracle "anthropic" in the file or --oracle anthropic on the CLI.