dream docs

Install

macOS and Linux

curl -fsSL https://api.amigens.com/install | sh

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

Prints the version.

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

rm -rf ~/.dreams

Removes dream, the models and your global records. Delete a project's .dream/ to remove its history.

Next: Basics.