Skip to content

README.md

Latest commit

 

History

History
152 lines (110 loc) · 5.61 KB

README.md

File metadata and controls

152 lines (110 loc) · 5.61 KB
Raw

DevMemory AI v1.1.0

Discord Community

Engineering Memory for Modern Software Development.

DevMemory AI is a local-first, zero-cloud engineering memory system designed to preserve software understanding, architectural decisions, component dependencies, and code evolution across development lifecycles.

Why DevMemory AI Exists

Traditional chat histories and commit logs record what changed, but fail to capture why decisions were made, how component boundaries evolved, or what technical debt was introduced.

DevMemory AI compiles filesystem changes into Canonical Engineering Memory—a single source of truth that powers automated build documentation, interactive knowledge graphs, repository context, and local AI reasoning.

Features

  • Local-First & Offline: 100% private. All SQLite databases (.devmemory/index.db), AST indexes, and AI queries run locally on your machine. Zero cloud telemetry.
  • Single Runtime Orchestration: Every interaction (CLI, Watcher daemon, Dashboard) routes through a single Runtime instance (src/runtime/index.ts) ensuring deterministic state handling.
  • Intent-Driven Engineering Compiler: Synthesizes high-level engineering intent, architectural impact, decisions, tradeoffs, and testing guidance without raw filename listing or generic AI filler.
  • Unified Canonical Engineering Model: Both human documentation (Full Context) and AI working prompts (Project Regeneration Prompt) derive 100% equivalent engineering facts from the same canonical model.
  • Interactive Knowledge Graph & Dashboard: Local HTTP dashboard (http://localhost:31415) featuring Cytoscape.js Knowledge Graph visualization, Mermaid build diagrams, timeline sliders, and settings management.
  • Adaptive Cooldown Watcher: Background daemon with adaptive windowing (20s–60s) to batch rapid file edits cleanly while ignoring .devmemory and internal infrastructure.
  • SQLite WAL Concurrency: High-throughput SQLite FTS5 index running in WAL mode with busy timeout handling.

Architecture Overview

Repository Filesystem (Chokidar Watcher)
         │
         ▼
Transaction Engine (Adaptive Cooldown)
         │
         ▼
Engineering Compiler (Intent & AST Parsing)
         │
         ▼
Canonical Engineering Memory (SQLite WAL Index)
    ┌────┴──────────────────────────┐
    ▼                               ▼
Web Dashboard (Port 31415)      CLI & AI Query Engine

Quick Start

1. Automated One-Click Installation

macOS & Linux:

curl -fsSL https://raw.githubusercontent.com/DevMemory-AI/devmemoryai/main/install.sh | bash

Windows (PowerShell):

iwr -useb https://raw.githubusercontent.com/DevMemory-AI/devmemoryai/main/install.ps1 | iex

The installer automatically detects and sets up Git, Bun runtime, Ollama LLM engine, and links the global dmai CLI.

Manual Installation

Alternatively, clone the repository and install dependencies using Bun:

git clone https://github.com/DevMemory-AI/devmemoryai.git
cd devmemoryai
bun install
bun link

### 2. Link CLI Binary

```bash
bun link

3. Initialize in a Repository

cd /path/to/your/project
dmai init

4. Start Watching & Open Dashboard

dmai watch
dmai dashboard

CLI Reference

Command Description
dmai init Initialize DevMemory AI in the current repository
dmai watch Start the background repository watcher daemon
dmai stop Stop the background repository watcher daemon
dmai disable Safely stop processes, unregister OS launch services, & purge .devmemory/ for clean deletion
dmai continue Resume a stopped repository watcher daemon
dmai restart Restart the repository watcher daemon
dmai status Display project health, watcher status, and build count
dmai ask "question" Query engineering memory locally using AI
dmai search "query" Search FTS5 engineering index and fingerprints
dmai dashboard Open local HTTP engineering dashboard
dmai config View or update configuration settings
dmai logs View runtime logs
dmai doctor Run comprehensive system health diagnostics
dmai version Display DevMemory AI version information

Documentation

License & Source Policy

DevMemory AI source code is publicly viewable for inspection, educational evaluation, and local execution under the DevMemory AI Source-Available License. Source code modification, derivative works, and commercial redistribution are strictly prohibited.

Author & Community