Developers
Command line
Check and compile .dream files from the terminal or CI.
The CLI runs the exact compiler the editor uses, with no browser — for scripts, CI and AI agents.
| Command | Does | Exit code |
|---|---|---|
check <file> | Prints errors as file:line: message, or a ✓ summary | 1 if there are errors, else 0 |
plan <file> | Prints the compiled plan JSON | 1 if there are errors |
help | Prints the language reference and an example | 0 |
Terminal
node editor/src/dreamcode/cli.js check house.dream✓ house.dream: 2 floor(s), 14 walls, 9 doors/windows, 18 electricalnode editor/src/dreamcode/cli.js plan house.dream > plan.json
Use it in CI#
.github/workflows — a step
for f in designs/*.dream; do node editor/src/dreamcode/cli.js check "$f" || exit 1; done
Use it with an AI agent#
Tell the agent to run cli.js help first, edit the file, then cli.js check until it passes. With the file linked in DreamCode, you watch the house change live.