Skip to main content

A local-first AI dream journal for people who want to notice patterns in their dreams.

Project description

DreamLoop

English | 中文

CI PyPI version Python versions

DreamLoop AI analysis showing the selected language, evidence, and real-life links

"The repeating platform may reflect revisiting the same choice from different angles. Which real choice keeps bringing you back to the same concern?"

DreamLoop dashboard with local dream counts, AI insight, calendar, and recent dreams

Your dreams have patterns. DreamLoop finds them locally.

  • Runs fully local. Your data never leaves your machine.
  • Free with Ollama. Optional DeepSeek/OpenAI or custom OpenAI-compatible endpoints.
  • CLI-first, forkable, and built for Obsidian-minded knowledge workers.
  • English and Chinese analysis is language-checked before saving; switching the UI preserves unsaved analyzed drafts without relabeling results.
  • Full CJK fonts and responsive layouts are bundled locally with no remote font requests.
  • PyPI and source checkout keep data in .dreamloop/; Docker uses a named volume by default.
pipx install dreamloop
dreamloop init
dreamloop demo
dreamloop web
git clone https://github.com/saime428/DreamLoop.git
cd DreamLoop
uv sync --extra dev
uv run dreamloop init
uv run dreamloop demo
uv run dreamloop web

What You Get

Private local journal

Dream entries, settings, secrets, generated images, and exports live under .dreamloop/. Nothing uploads by default.

DreamLoop Settings with local AI and image-provider controls and hidden API keys

AI interpretation

DreamLoop can use Ollama locally or an explicit cloud/custom OpenAI-compatible provider to produce structured analysis: emotions, symbols, themes, multiple interpretations, and reality-check questions. Output language is validated before analysis is stored.

Visual memory

Every saved dream can create a local visual-memory card without any image API. Real image generation is opt-in.

DreamLoop Gallery showing local visual-memory cards created without an image API

DreamLoop CLI demo

Quick Start

Five-minute PyPI demo

pipx install dreamloop
dreamloop init
dreamloop demo
dreamloop web

Open http://127.0.0.1:8765. The demo seeds local sample dreams, mock analyses, and visual memory cards. No cloud AI is required.

Docker demo

docker compose up

Open http://localhost:8765. Demo data is only added when the local store is empty. Docker Compose stores .dreamloop/ in the dreamloop-data named volume; switch the volume to ./.dreamloop:/app/.dreamloop if you want host-visible files.

Markdown / Obsidian export

dreamloop export --format markdown

DreamLoop writes one Markdown file per dream plus an _index.md wikilink index under .dreamloop/exports/.

Advanced Setup

Run from source

git clone https://github.com/saime428/DreamLoop.git
cd DreamLoop
uv sync --extra dev
uv run dreamloop init
uv run dreamloop add "I found a blue door under the sea."
uv run dreamloop web

Enable local Ollama analysis

ollama pull qwen3:8b
uv run dreamloop ai use ollama --model qwen3:8b
uv run dreamloop ai test
uv run dreamloop analyze --pending

Configure providers

uv run dreamloop ai status
uv run dreamloop ai use ollama --model qwen3:8b
uv run dreamloop ai use deepseek --model deepseek-v4-flash
uv run dreamloop ai use custom --model local-model --base-url http://localhost:1234/v1
uv run dreamloop image use local_card
uv run dreamloop image use cloud_openai_compatible --model image-model --base-url https://images.example/v1

If port 8765 is blocked on Windows:

dreamloop web --port 18080

Why This Project

Commercial dream apps often make you pay for analysis and push intimate text into a cloud workflow. DreamLoop takes the opposite path: the journal is local, the CLI is primary, and AI is a swappable layer.

The default path is zero-cost Ollama. DeepSeek, OpenAI, and custom OpenAI-compatible endpoints are optional for people who want stronger hosted models or their own local gateway.

Web App Loop

Dashboard -> Log -> Detail -> Patterns -> Gallery -> Settings.

  • Dashboard: AI Insight, heatmap, stats, and recent dreams.
  • Log: draft-first capture with optional reflection prompts; language switching preserves unsaved content and analyzed results.
  • Detail: original dream text, truthful analysis-language labels, explicit regeneration, feedback, local cards, and opt-in images.
  • Patterns: calendar, recurring symbols, themes, resonant feedback, and a symbol network.
  • Gallery: real generated images when configured, otherwise local visual cards.
  • Settings: AI provider, image provider, launch notes, data directory, and privacy status.

The same FastAPI app exposes JSON endpoints for dreams, feedback, images, heatmap, trends, and symbol graph data.

Privacy Promise

  • Dream entries are stored in .dreamloop/dreamloop.sqlite3.
  • .dreamloop/ is ignored by Git.
  • Your dreams are never uploaded by default.
  • Ollama keeps analysis local on your machine.
  • DeepSeek/OpenAI/custom providers only run after explicit configuration.
  • API keys live in .dreamloop/secrets.env; secrets do not belong in commits.

Local Data Model

.dreamloop/
  dreamloop.sqlite3
  config.json
  secrets.env
  assets/images/
  exports/
  imports/

Status

Available now

DreamLoop v0.2 adds:

  • Docker demo with docker compose up.
  • Markdown / Obsidian export via dreamloop export --format markdown.
  • Symbol co-occurrence graph on Patterns for shareable screenshots.
  • Chinese demo data via dreamloop demo --language zh.
  • GHCR image publishing on GitHub releases.
  • Stateless English/Chinese interface switching that preserves unsaved analyzed drafts.
  • Analysis-language validation and explicit mismatch handling before persistence.
  • Full offline Noto Sans SC and Noto Serif SC coverage with a fixed responsive type scale.

The source-based Docker demo builds locally today. Release images publish as ghcr.io/saime428/dreamloop when a GitHub release is published.

Current source verification: 157 automated tests pass. Browser QA covers all six pages in both languages across six desktop, tablet, and mobile viewports.

Next

  • Obsidian vault sync.
  • Obsidian community plugin.
  • Lightweight local clustering without a required vector database.
  • Backup and restore flows.

Contributing

DreamLoop is deliberately small and forkable. See CONTRIBUTING.md.

Run tests with:

uv run --extra dev pytest

Build the package with:

uv build

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dreamloop-0.2.0.tar.gz (39.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dreamloop-0.2.0-py3-none-any.whl (30.7 MB view details)

Uploaded Python 3

File details

Details for the file dreamloop-0.2.0.tar.gz.

File metadata

  • Download URL: dreamloop-0.2.0.tar.gz
  • Upload date:
  • Size: 39.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for dreamloop-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6410beca60eedc795b5963dca9a87d5dac4d0a5b671a838e039330163b6e5973
MD5 63303a07935231eac9bffeb1f0a20395
BLAKE2b-256 cf74a874f6bb55b937a44990a2fc575f1f385905e4f2462a1cd4421483fb59cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for dreamloop-0.2.0.tar.gz:

Publisher: publish.yml on saime428/DreamLoop

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dreamloop-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dreamloop-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 30.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for dreamloop-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f250f24b8b8075a4c1e8d2d913c738de78c3dfd8ae0f45502cc497cd0d2e66af
MD5 d4cd221aa834d6ef8662c0c3b7970215
BLAKE2b-256 7e1209bc88d93649f0fa0e0613f4d91116dfa943b6b3246cb0bbee17437cb094

See more details on using hashes here.

Provenance

The following attestation bundles were made for dreamloop-0.2.0-py3-none-any.whl:

Publisher: publish.yml on saime428/DreamLoop

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page