Skip to content

Commit ab506dc

Browse files
authored
Merge pull request #174 from thestumonkey/stu/name-change
name change to chronicle Implemented all changes.
2 parents dededcd + bc6911f commit ab506dc

File tree

126 files changed

+750
-640
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+750
-640
lines changed

.env.template

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ========================================
2-
# FRIEND-LITE MASTER CONFIGURATION
2+
# CHRONICLE MASTER CONFIGURATION
33
# ========================================
4-
# This is the master configuration template for the entire Friend-Lite project.
4+
# This is the master configuration template for the entire Chronicle project.
55
# Copy this file to .env and customize values, then run 'make config' to generate
66
# all service-specific configuration files.
77

@@ -11,7 +11,7 @@
1111

1212
# Infrastructure namespaces
1313
INFRASTRUCTURE_NAMESPACE=infrastructure
14-
APPLICATION_NAMESPACE=friend-lite
14+
APPLICATION_NAMESPACE=chronicle
1515

1616
# Deployment mode: docker-compose, kubernetes, or distributed
1717
DEPLOYMENT_MODE=docker-compose
@@ -24,7 +24,7 @@ CONTAINER_REGISTRY=localhost:32000
2424
# ========================================
2525

2626
# Primary domain/IP for all services
27-
# Examples: localhost, 192.168.1.100, friend-lite.example.com, 100.x.x.x (Tailscale)
27+
# Examples: localhost, 192.168.1.100, chronicle.example.com, 100.x.x.x (Tailscale)
2828
DOMAIN=localhost
2929

3030
# Service ports (Docker Compose mode)
@@ -105,7 +105,7 @@ PARAKEET_ASR_URL=http://host.docker.internal:8767
105105

106106
# MongoDB configuration
107107
MONGODB_URI=mongodb://mongo:${MONGODB_PORT}
108-
MONGODB_K8S_URI=mongodb://mongodb.${INFRASTRUCTURE_NAMESPACE}.svc.cluster.local:27017/friend-lite
108+
MONGODB_K8S_URI=mongodb://mongodb.${INFRASTRUCTURE_NAMESPACE}.svc.cluster.local:27017/chronicle
109109

110110
# Qdrant configuration
111111
QDRANT_BASE_URL=qdrant
@@ -120,12 +120,12 @@ NEO4J_PASSWORD=neo4j-password
120120
# MEMORY PROVIDER CONFIGURATION
121121
# ========================================
122122

123-
# Memory Provider: friend_lite or openmemory_mcp
124-
MEMORY_PROVIDER=friend_lite
123+
# Memory Provider: chronicle or openmemory_mcp
124+
MEMORY_PROVIDER=chronicle
125125

126126
# OpenMemory MCP configuration (when MEMORY_PROVIDER=openmemory_mcp)
127127
OPENMEMORY_MCP_URL=http://host.docker.internal:8765
128-
OPENMEMORY_CLIENT_NAME=friend_lite
128+
OPENMEMORY_CLIENT_NAME=chronicle
129129
OPENMEMORY_USER_ID=openmemory
130130
OPENMEMORY_TIMEOUT=30
131131

CLAUDE.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
Friend-Lite is at the core an AI-powered personal system - various devices, including but not limited to wearables from OMI can be used for at the very least audio capture, speaker specific transcription, memory extraction and retrieval.
7+
Chronicle is at the core an AI-powered personal system - various devices, including but not limited to wearables from OMI can be used for at the very least audio capture, speaker specific transcription, memory extraction and retrieval.
88
On top of that - it is being designed to support other services, that can help a user with these inputs such as reminders, action items, personal diagnosis etc.
99

1010
This supports a comprehensive web dashboard for management.
@@ -147,7 +147,7 @@ docker compose up --build
147147
- **Job Tracker**: Tracks pipeline jobs with stage events (audio → transcription → memory) and completion status
148148
- **Task Management**: BackgroundTaskManager tracks all async tasks to prevent orphaned processes
149149
- **Unified Transcription**: Deepgram/Mistral transcription with fallback to offline ASR services
150-
- **Memory System**: Pluggable providers (Friend-Lite native or OpenMemory MCP)
150+
- **Memory System**: Pluggable providers (Chronicle native or OpenMemory MCP)
151151
- **Authentication**: Email-based login with MongoDB ObjectId user system
152152
- **Client Management**: Auto-generated client IDs as `{user_id_suffix}-{device_name}`, centralized ClientManager
153153
- **Data Storage**: MongoDB (`audio_chunks` collection for conversations), vector storage (Qdrant or OpenMemory)
@@ -161,7 +161,7 @@ Required:
161161
- LLM Service: Memory extraction and action items (OpenAI or Ollama)
162162

163163
Recommended:
164-
- Vector Storage: Qdrant (Friend-Lite provider) or OpenMemory MCP server
164+
- Vector Storage: Qdrant (Chronicle provider) or OpenMemory MCP server
165165
- Transcription: Deepgram, Mistral, or offline ASR services
166166

167167
Optional:
@@ -179,8 +179,8 @@ Optional:
179179
4. **Speech-Driven Conversation Creation**: User-facing conversations only created when speech is detected
180180
5. **Dual Storage System**: Audio sessions always stored in `audio_chunks`, conversations created in `conversations` collection only with speech
181181
6. **Versioned Processing**: Transcript and memory versions tracked with active version pointers
182-
7. **Memory Processing**: Pluggable providers (Friend-Lite native with individual facts or OpenMemory MCP delegation)
183-
8. **Memory Storage**: Direct Qdrant (Friend-Lite) or OpenMemory server (MCP provider)
182+
7. **Memory Processing**: Pluggable providers (Chronicle native with individual facts or OpenMemory MCP delegation)
183+
8. **Memory Storage**: Direct Qdrant (Chronicle) or OpenMemory server (MCP provider)
184184
9. **Action Items**: Automatic task detection with "Simon says" trigger phrases
185185
10. **Audio Optimization**: Speech segment extraction removes silence automatically
186186
11. **Task Tracking**: BackgroundTaskManager ensures proper cleanup of all async operations
@@ -230,11 +230,11 @@ DEEPGRAM_API_KEY=your-deepgram-key-here
230230
# Optional: TRANSCRIPTION_PROVIDER=deepgram
231231
232232
# Memory Provider
233-
MEMORY_PROVIDER=friend_lite # or openmemory_mcp
233+
MEMORY_PROVIDER=chronicle # or openmemory_mcp
234234
235235
# Database
236236
MONGODB_URI=mongodb://mongo:27017
237-
# Database name: friend-lite
237+
# Database name: chronicle
238238
QDRANT_BASE_URL=qdrant
239239
240240
# Network Configuration
@@ -246,12 +246,12 @@ CORS_ORIGINS=http://localhost:3000,http://localhost:5173
246246

247247
### Memory Provider Configuration
248248

249-
Friend-Lite supports two pluggable memory backends:
249+
Chronicle supports two pluggable memory backends:
250250

251-
#### Friend-Lite Memory Provider (Default)
251+
#### Chronicle Memory Provider (Default)
252252
```bash
253-
# Use Friend-Lite memory provider (default)
254-
MEMORY_PROVIDER=friend_lite
253+
# Use Chronicle memory provider (default)
254+
MEMORY_PROVIDER=chronicle
255255
256256
# LLM Configuration for memory extraction
257257
LLM_PROVIDER=openai
@@ -269,7 +269,7 @@ MEMORY_PROVIDER=openmemory_mcp
269269
270270
# OpenMemory MCP Server Configuration
271271
OPENMEMORY_MCP_URL=http://host.docker.internal:8765
272-
OPENMEMORY_CLIENT_NAME=friend_lite
272+
OPENMEMORY_CLIENT_NAME=chronicle
273273
OPENMEMORY_USER_ID=openmemory
274274
OPENMEMORY_TIMEOUT=30
275275
@@ -279,7 +279,7 @@ OPENAI_API_KEY=your-openai-key-here
279279

280280
### Transcription Provider Configuration
281281

282-
Friend-Lite supports multiple transcription services:
282+
Chronicle supports multiple transcription services:
283283

284284
```bash
285285
# Option 1: Deepgram (High quality, recommended)

Docs/features.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Friend-Lite Features & Architecture
1+
# Chronicle Features & Architecture
22

33
## Core Features
44

5-
Friend-Lite supports AI-powered personal systems through multiple OMI-compatible audio devices:
5+
Chronicle supports AI-powered personal systems through multiple OMI-compatible audio devices:
66

77
**Memory System:**
8-
- **Advanced memory system** with pluggable providers (Friend-Lite native or OpenMemory MCP)
8+
- **Advanced memory system** with pluggable providers (Chronicle native or OpenMemory MCP)
99
- **Memory extraction** from conversations with individual fact storage
1010
- **Semantic memory search** with relevance threshold filtering and live results
1111
- **Memory count display** with total count tracking from native providers
@@ -38,7 +38,7 @@ DevKit2 streams audio via Bluetooth using OPUS codec. The processing pipeline in
3838

3939
**AI Processing:**
4040
- LLM-based conversation analysis (OpenAI or local Ollama)
41-
- **Dual memory system**: Friend-Lite native or OpenMemory MCP integration
41+
- **Dual memory system**: Chronicle native or OpenMemory MCP integration
4242
- Enhanced memory extraction with individual fact storage
4343
- **Semantic search** with relevance scoring and threshold filtering
4444
- Smart deduplication and memory updates (ADD/UPDATE/DELETE)
@@ -87,7 +87,7 @@ Choose one based on your needs:
8787

8888
**Features:**
8989
- Audio processing pipeline with real-time WebSocket support
90-
- **Pluggable memory system**: Choose between Friend-Lite native or OpenMemory MCP
90+
- **Pluggable memory system**: Choose between Chronicle native or OpenMemory MCP
9191
- Enhanced memory extraction with individual fact storage (no generic fallbacks)
9292
- **Semantic memory search** with relevance threshold filtering and total count display
9393
- **Speaker-based memory filtering**: Optional control over processing based on participant presence

Docs/getting-started.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Getting Started
22

3-
# Friend-Lite Backend Quickstart Guide
3+
# Chronicle Backend Quickstart Guide
44

5-
> 📖 **New to friend-lite?** This is your starting point! After reading this, continue with [architecture.md](./architecture.md) for technical details.
5+
> 📖 **New to chronicle?** This is your starting point! After reading this, continue with [architecture.md](./architecture.md) for technical details.
66
77
## Overview
88

9-
Friend-Lite is an eco-system of services to support "AI wearable" agents/functionality.
9+
Chronicle is an eco-system of services to support "AI wearable" agents/functionality.
1010
At the moment, the basic functionalities are:
1111
- Audio capture (via WebSocket, from OMI device, files, or a laptop)
1212
- Audio transcription
13-
- **Advanced memory system** with pluggable providers (Friend-Lite native or OpenMemory MCP)
13+
- **Advanced memory system** with pluggable providers (Chronicle native or OpenMemory MCP)
1414
- **Enhanced memory extraction** with individual fact storage and smart updates
1515
- **Semantic memory search** with relevance threshold filtering and live results
1616
- Action item extraction
@@ -38,13 +38,13 @@ cd backends/advanced
3838
- **Authentication**: Admin email/password setup
3939
- **Transcription Provider**: Choose Deepgram, Mistral, or Offline (Parakeet)
4040
- **LLM Provider**: Choose OpenAI or Ollama for memory extraction
41-
- **Memory Provider**: Choose Friend-Lite Native or OpenMemory MCP
41+
- **Memory Provider**: Choose Chronicle Native or OpenMemory MCP
4242
- **Optional Services**: Speaker Recognition and other extras
4343
- **Network Configuration**: Ports and host settings
4444

4545
**Example flow:**
4646
```
47-
🚀 Friend-Lite Interactive Setup
47+
🚀 Chronicle Interactive Setup
4848
===============================================
4949
5050
► Authentication Setup
@@ -126,13 +126,13 @@ [email protected]
126126
**Memory Provider Configuration:**
127127
```bash
128128
# Memory Provider (Choose One)
129-
# Option 1: Friend-Lite Native (Default - Recommended)
130-
MEMORY_PROVIDER=friend_lite
129+
# Option 1: Chronicle Native (Default - Recommended)
130+
MEMORY_PROVIDER=chronicle
131131

132132
# Option 2: OpenMemory MCP (Cross-client compatibility)
133133
# MEMORY_PROVIDER=openmemory_mcp
134134
# OPENMEMORY_MCP_URL=http://host.docker.internal:8765
135-
# OPENMEMORY_CLIENT_NAME=friend_lite
135+
# OPENMEMORY_CLIENT_NAME=chronicle
136136
# OPENMEMORY_USER_ID=openmemory
137137
```
138138

@@ -325,8 +325,8 @@ curl -X POST "http://localhost:8000/api/process-audio-files" \
325325
### Memory & Intelligence
326326

327327
#### Pluggable Memory System
328-
- **Two memory providers**: Choose between Friend-Lite native or OpenMemory MCP
329-
- **Friend-Lite Provider**: Full control with custom extraction, individual fact storage, smart deduplication
328+
- **Two memory providers**: Choose between Chronicle native or OpenMemory MCP
329+
- **Chronicle Provider**: Full control with custom extraction, individual fact storage, smart deduplication
330330
- **OpenMemory MCP Provider**: Cross-client compatibility (Claude Desktop, Cursor, Windsurf), professional processing
331331

332332
#### Enhanced Memory Processing
@@ -482,7 +482,7 @@ tailscale ip -4
482482

483483
## Data Architecture
484484

485-
The friend-lite backend uses a **user-centric data architecture**:
485+
The chronicle backend uses a **user-centric data architecture**:
486486

487487
- **All memories are keyed by database user_id** (not client_id)
488488
- **Client information is stored in metadata** for reference and debugging
@@ -495,12 +495,12 @@ For detailed information, see [User Data Architecture](user-data-architecture.md
495495

496496
### Choosing a Memory Provider
497497

498-
Friend-Lite offers two memory backends:
498+
Chronicle offers two memory backends:
499499

500-
#### 1. Friend-Lite Native
500+
#### 1. Chronicle Native
501501
```bash
502502
# In your .env file
503-
MEMORY_PROVIDER=friend_lite
503+
MEMORY_PROVIDER=chronicle
504504
LLM_PROVIDER=openai
505505
OPENAI_API_KEY=your-openai-key-here
506506
```
@@ -519,7 +519,7 @@ OPENAI_API_KEY=your-openai-key-here
519519
cd extras/openmemory-mcp
520520
docker compose up -d
521521

522-
# Then configure Friend-Lite
522+
# Then configure Chronicle
523523
MEMORY_PROVIDER=openmemory_mcp
524524
OPENMEMORY_MCP_URL=http://host.docker.internal:8765
525525
```

Docs/init-system.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Friend-Lite Initialization System
1+
# Chronicle Initialization System
22

33
## Quick Links
44

@@ -10,14 +10,14 @@
1010

1111
## Overview
1212

13-
Friend-Lite uses a unified initialization system with clean separation of concerns:
13+
Chronicle uses a unified initialization system with clean separation of concerns:
1414

1515
- **Configuration** (`wizard.py`) - Set up service configurations, API keys, and .env files
1616
- **Service Management** (`services.py`) - Start, stop, and manage running services
1717

1818
The root orchestrator handles service selection and delegates configuration to individual service scripts. In general, setup scripts only configure and do not start services automatically. Exceptions: `extras/asr-services` and `extras/openmemory-mcp` are startup scripts. This prevents unnecessary resource usage and gives you control over when services actually run.
1919

20-
> **New to Friend-Lite?** Most users should start with the [Quick Start Guide](../quickstart.md) instead of this detailed reference.
20+
> **New to Chronicle?** Most users should start with the [Quick Start Guide](../quickstart.md) instead of this detailed reference.
2121
2222
## Architecture
2323

@@ -133,7 +133,7 @@ Services use `host.docker.internal` for inter-container communication:
133133

134134
## Service Management
135135

136-
Friend-Lite now separates **configuration** from **service lifecycle management**:
136+
Chronicle now separates **configuration** from **service lifecycle management**:
137137

138138
### Unified Service Management
139139
Use the `services.py` script for all service operations:

Docs/ports-and-access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Friend-Lite Port Configuration & User Journey
1+
# Chronicle Port Configuration & User Journey
22

33
## User Journey: Git Clone to Running Services
44

55
### 1. Clone & Setup
66
```bash
77
git clone <repo>
8-
cd friend-lite
8+
cd chronicle
99

1010
# Configure all services
1111
uv run --with-requirements setup-requirements.txt python init.py

0 commit comments

Comments
 (0)