dream docs

Install

macOS and Linux

curl -fsSL https://api.amigens.com/install | sh
dream installed in /home/you/.dreams/bin (on your PATH via ~/.zshrc)

Installs dream in ~/.dreams/bin and adds it to your PATH. Open a new terminal.

Windows

irm https://api.amigens.com/install.ps1 | iex

Installs dream.exe and adds it to your PATH. Open a new terminal.

Check it

dream version
dream 0.5.0 (c-314, 2026-10-20)

Prints the version and the build it came from.

Update

Run the install line again.

Models for search by meaning (optional)

dream setup -y
dream: models are in ~/.dreams/models; `dream start` in a project keeps them loaded for meaning search

Downloads the embedding engine and models (about 1 GB, once). Without them dream matches words only.

Where things are

PathWhat
<project>/.dream/the project's history, drafts, decisions, cards, members, chat and records
~/.dreams/bindream
~/.dreams/modelsthe embedding models
~/.dreams/policy.dbyour global guidelines, rules, hooks, tools and skills

Uninstall

dream uninstall

Asks first, then stops dream's background jobs on this machine and removes the dream binary, the PATH line the installer added and ~/.dreams (your global records). The downloaded models stay; -all removes them too. -yes skips the question. No project's .dream/ is touched; delete it yourself to remove that history.

Next: Basics.