Reference
dream help lists every command; dream <command> -h prints its flags. -json prints JSON.
Repos
| Command | Does |
|---|---|
dream init [-name n] [-submit -m msg | -import] [-hooks] [dir] | make a folder a repo |
dream checkout <repo> [-at c-N] [-draft d-N] [dir] | another working copy |
Changes
| Command | Does |
|---|---|
dream status | changed files |
dream diff | diff of your changes |
dream submit [-m msg] [path...] | land the changes |
dream update | bring in what others landed |
dream restore <path...> | put the last landed version back |
dream revert [-m msg] c-N | land the inverse of c-N |
dream change new <name> [-card id] | start a change |
dream change rm <name> [-force] | drop a change |
dream changes | list changes |
dream switch <name> | switch to a change |
dream save [-m msg] | save edits as a draft |
dream drafts | list drafts |
History
| Command | Does |
|---|---|
dream log [-n N] [-p] [path] | changesets, newest first |
dream show [-at c-N] <c-N|path> | a changeset, or a file |
dream blame <path> | who last touched each line |
dream export -repo r [-branch b] <git-dir> | write the history as git commits |
Decisions
| Command | Does |
|---|---|
dream decisions record -repo r <file.json|-> | record a decision |
dream decisions list | list decisions |
dream decisions ground -repo r <topic> | decisions for a topic |
dream decisions governing -repo r <path...> | decisions for a path |
dream decisions why-not -repo r <option> | why an option lost |
dream decisions history -repo r <D-N> | a decision's trail |
dream decisions brief -repo r [-as-of date] | all decisions as text |
dream decisions approve -repo r <D-N> | clear a review |
dream patterns list / patterns show -repo r <D-N> | code patterns |
Analyze
| Command | Does |
|---|---|
dream analyze [path] | candidate decisions |
dream analyze propose [-from file.json] <a-id...> | propose candidates |
dream analyze review | walk proposals |
dream analyze review accept|reject [-group area] [id...] | answer proposals |
dream analyze review -auto [-dry-run] [-undo] | accept what the evidence settles |
Search
| Command | Does |
|---|---|
dream search <words> | files by words |
dream search -meaning <words> | by meaning |
dream index [-history] | build the meaning index |
dream similar <file>[:line|#Func] | similar code |
Cards and chat
| Command | Does |
|---|---|
dream card new [-scope a,b] [-spec s] <goal> | new card |
dream card list / card show <id> / card find <text> | read cards |
dream card take <id> | take a card |
dream card note <id> <text> / card log <id> [-type t] [text] | notes and log |
dream card done <id> / card cancel <id> / card handoff <id> | close or release |
dream chat | rooms with unread counts |
dream chat read <room> | read a room |
dream chat post <room> <text> | post |
dream chat wait [room] | wait for the next post |
Other
| Command | Does |
|---|---|
dream setup [-y] | download the embedding models |
dream hook install [-agent a,b] [-yes] | coding-agent hooks |
dream version | the version |
Exit codes
0 done; 1 failed (the error says why and what to do next); 2 bad usage.
Troubleshooting
dream: command not found
Open a new terminal, or export PATH="$HOME/.dreams/bin:$PATH".
macOS: "dream" cannot be opened
xattr -d com.apple.quarantine ~/.dreams/bin/dream
download failed its checksum
Run the install line again.
not in an open workspace
cd into your project, or run dream init -submit -m first there.
nothing to submit
No changes; dream status shows what changed.
Conflict markers after dream update
Edit out the <<<<<<< / ======= / >>>>>>> lines, then dream submit.
Outside a card's scope
dream restore <file>, or submit it in a change not tied to the card.
no embedding models yet
Run dream setup.
title is required
Add "title" to the decision JSON.
A decisions command prints only its usage
Add -repo your-project.
Unknown changeset
dream log lists the ids.