Install
Eelgrass is pre-alpha. There is no packaged release yet. You build the CLI from this repository.
Prerequisites
| Tool | Notes |
|---|---|
| Stable Rust | Install via rustup. The engine workspace is stdlib-only. |
| Node.js | Needed for Studio, the playground UI, and TypeScript codegen. Current LTS or newer; Studio is exercised on Node 22+. |
Optional (playground / editor intel only):
bash
rustup target add wasm32-unknown-unknownClone
bash
git clone https://github.com/DragonMastery/eelgrass.git
cd eelgrassBuild the CLI
From the repo root:
bash
cargo build -p eelgrass-cliRun commands with the built binary, or via Cargo:
bash
cargo run -p eelgrass-cli --
# usage summary when invoked with no subcommand
cargo run -p eelgrass-cli -- run ./mydb examples/demo_schema.eel examples/demo_queries.eelSubcommands today: lex, typecheck, typecheck-queries, run, serve, studio, compact. Full reference: CLI.
Wasm (optional: playground)
The in-browser playground and Studio editor intel need wasm artifacts. From clients/studio:
bash
cd clients/studio
npm install
npm run build:wasmThat builds eelgrass-lang and eelgrass-wasm for wasm32-unknown-unknown and copies them into the Studio app. Skip this if you only use eelgrass run / eelgrass serve on the native CLI.
Next
→ Quickstart: playground, eelgrass run, Studio, named queries.