docs: add EverMind ecosystem overview (#259)

* docs: add EverMind ecosystem overview

* docs: move ecosystem overview lower

* docs: add EverOS 1.0.0 highlights

* docs: streamline README flow

* docs: refine README showcase layout

* docs: update README banner image

* docs: use uploaded README banner

* docs: expand README highlights and navigation

* docs: normalize README title capitalization

* docs: align EverOS description with banner

* docs: use high-density README banner

* docs: clarify EverOS overview

* docs: add README localization and star history

* docs: expand Chinese README localization
This commit is contained in:
Elliot Chen
2026-06-06 18:49:45 +08:00
committed by GitHub
parent 8f175d3f8f
commit 0a99922f24
4 changed files with 1354 additions and 64 deletions

338
README.md
View File

@ -1,6 +1,6 @@
<div align="center" id="readme-top">
![banner-gif](https://github.com/user-attachments/assets/0bf97efd-580f-4a53-a2a2-58d6daea7290)
![EverOS banner](https://github.com/EverMind-AI/EverOS/releases/download/v1.0.0/everos-readme-banner.jpg)
<p align="center">
<a href="https://x.com/evermind"><img src="https://img.shields.io/badge/EverMind-000000?labelColor=gray&style=for-the-badge&logo=x&logoColor=white" alt="X"></a>
@ -9,27 +9,29 @@
<a href="https://github.com/EverMind-AI/EverOS/discussions/67"><img src="https://img.shields.io/badge/WeCom-EverMind_社区-07C160?labelColor=gray&style=for-the-badge&logo=wechat&logoColor=white" alt="WeChat"></a>
</p>
[Website](https://evermind.ai) · [Documentation](https://docs.evermind.ai) · [Blog](https://evermind.ai/blogs)
[Website](https://evermind.ai) · [Documentation](https://docs.evermind.ai) · [Blog](https://evermind.ai/blogs) · [中文](README.zh-CN.md)
</div>
<br>
<details open>
<details>
<summary><kbd>Table of Contents</kbd></summary>
<br>
- [What is EverOS](#what-is-everos)
- [Architecture at a glance](#architecture-at-a-glance)
- [Quick start](#quick-start)
- [Storage layout](#storage-layout)
- [EverOS 1.0.0 Highlights](#everos-100-highlights)
- [What Is EverOS](#what-is-everos)
- [Quick Start](#quick-start)
- [Architecture At A Glance](#architecture-at-a-glance)
- [Storage Layout](#storage-layout)
- [Features](#features)
- [Project structure](#project-structure)
- [Project Structure](#project-structure)
- [Documentation](#documentation)
- [Use Cases](#use-cases)
- [Stay Tuned](#stay-tuned)
- [EverMind Ecosystems](#evermind-ecosystems)
- [Contributing](#contributing)
<br>
@ -37,48 +39,131 @@
</details>
## What is EverOS
## EverOS 1.0.0 Highlights
EverOS is an open-source Python framework that turns conversations, agent trajectories, and files into **structured, retrievable, evolving long-term memory** for AI agents and user chats. Designed for **lightweight local deployments** (small teams, individual developers), with three core principles:
> [!IMPORTANT]
>
> **EverOS 1.0.0 is a major release for self-evolving memory.** It brings a
> local-first runtime, Markdown as the source of truth, hybrid retrieval,
> multimodal ingestion, user and agent memory scopes, and modular algorithms
> through [EverAlgo](https://github.com/EverMind-AI/EverAlgo).
>
> **Watch this repository** for the next wave of memory-system work, including
> Wiki-style knowledge layers and Dreaming for deeper offline evolution.
1. **Markdown as Source of Truth** — All memory persists as plain `.md` files. Open, edit, grep, version with Git, view in Obsidian. No black-box database lock-in.
2. **Lightweight three-piece storage**`Markdown` files (truth) + `SQLite` (state/queue) + `LanceDB` (vector + BM25 + scalar). No MongoDB / Elasticsearch / Milvus / Redis / Kafka required.
3. **[EverAlgo](https://github.com/EverMind-AI/EverAlgo) as pure algorithm library** — Memory extraction algorithms are decoupled into a separate library; this project orchestrates and persists.
<table>
<tr>
<td width="33%" valign="top">
<strong>Markdown-First Memory</strong><br>
Memory is persisted as plain Markdown: visible, auditable, hand-editable,
Git-friendly, and owned by the user.
</td>
<td width="33%" valign="top">
<strong>Lightweight Local Stack</strong><br>
Install with Python. SQLite tracks runtime state; LanceDB powers vector,
BM25, and scalar-filter retrieval locally.
</td>
<td width="33%" valign="top">
<strong>Layered Memory Model</strong><br>
User memory and agent memory are first-class today. Wiki-style knowledge
is the next layer in the roadmap.
</td>
</tr>
<tr>
<td width="33%" valign="top">
<strong>Self-Evolving Agents</strong><br>
Agent memory can extract reusable cases and skills from repeated
experience, so workflows become smarter over time.
</td>
<td width="33%" valign="top">
<strong>Multimodal Ingestion</strong><br>
Text, image, audio, documents, PDF, HTML, and email can be parsed into
memory through the optional multimodal pipeline.
</td>
<td width="33%" valign="top">
<strong>Online And Offline Strategy Control</strong><br>
Online extraction and offline evolution stay separate, with configurable
prompts and models at each step. Dreaming is coming next.
</td>
</tr>
<tr>
<td width="33%" valign="top">
<strong>Orthogonal Memory Scope</strong><br>
Owner, memory type, and scope are independent: search by user, agent,
app, project, session, and structured filters.
</td>
<td width="33%" valign="top">
<strong>Progressive Disclosure</strong><br>
Readable memory surfaces stay simple while deeper facts, cases, and
skills remain available.
</td>
<td width="33%" valign="top">
<strong>Modular By Design</strong><br>
EverAlgo owns algorithms; EverOS owns runtime, persistence, online flows,
and offline evolution.
</td>
</tr>
</table>
<br>
<div align="right">
## Architecture at a glance
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
```
┌───────────────────────────────────────────────┐
│ entrypoints/ (CLI + HTTP API) │ presentation
├───────────────────────────────────────────────┤
│ service/ (use cases: memorize/retrieve) │ application
├───────────────────────────────────────────────┤
│ memory/ (extract + search + cascade) │ domain
├───────────────────────────────────────────────┤
│ infra/ (markdown / sqlite / lancedb) │ infrastructure
└───────────────────────────────────────────────┘
↑ ↑
component/ core/
(LLM/Embedding) (observability/lifespan)
```
</div>
DDD 5 layers, single-direction dependency. See [docs/architecture.md](docs/architecture.md).
## What Is EverOS
EverOS is an open-source Python framework for self-evolving long-term
memory across agents and platforms. It gives makers one portable memory
layer for every agent they use - Claude Code, Codex, OpenClaw, Hermes,
and more - so context, decisions, files, and trajectories can follow the
work instead of staying trapped in one tool.
EverOS stores conversations, agent trajectories, and files as readable
Markdown, then syncs local SQLite and LanceDB indexes for fast retrieval.
Agents can reuse past cases and skills, improve from repeated workflows,
and become more proactive over time.
The system is built around three boundaries:
1. **Memory content stays readable** - Markdown is the durable source of truth.
2. **Runtime state stays local** - SQLite tracks state and LanceDB handles vector, BM25, and scalar-filter search.
3. **Algorithms stay modular** - [EverAlgo](https://github.com/EverMind-AI/EverAlgo) owns memory algorithms; EverOS owns runtime, persistence, online flows, and offline evolution.
<br>
<div align="right">
## Quick start
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
### Install as a package
</div>
## Quick Start
### 1. Install EverOS
```bash
uv pip install everos # or: pip install everos
uv pip install everos
# or: pip install everos
```
# Generate a starter .env (OpenRouter + DeepInfra defaults; bundled inside the wheel)
everos init # writes ./.env (use --xdg for ~/.config/everos/.env)
# Edit .env and fill the API key fields (see comments inside).
### 2. Initialize Configuration
Generate a starter `.env` file, then fill the API key fields shown in
the generated comments.
```bash
everos init
```
`everos init` writes `./.env` by default. Use `everos init --xdg` to
write `${XDG_CONFIG_HOME:-~/.config}/everos/.env` instead.
### 3. Start The Server
```bash
everos --help
everos server start
```
@ -86,10 +171,13 @@ everos server start
`everos server start` searches for `.env` in this order: `--env-file <path>`
`./.env` (cwd) → `${XDG_CONFIG_HOME:-~/.config}/everos/.env``~/.everos/.env`.
The endpoint stack is OpenAI-protocol compatible (OpenAI / OpenRouter / vLLM /
Ollama / DeepInfra) override `*__BASE_URL` in the generated `.env` to point
Ollama / DeepInfra) - override `*__BASE_URL` in the generated `.env` to point
at any of them.
#### Multi-modal (optional)
For a step-by-step walkthrough (add a conversation, flush, search, then
read the markdown), see [QUICKSTART.md](QUICKSTART.md).
### Optional: Ingest Multimodal Files
To ingest non-text content (image / pdf / audio / office documents)
through `/api/v1/memory/add` `content` items, install the optional
@ -118,17 +206,13 @@ brew install --cask libreoffice # macOS
sudo apt-get install -y libreoffice # Debian / Ubuntu
```
For a step-by-step walkthrough (add a conversation → flush → search →
read the markdown), see [QUICKSTART.md](QUICKSTART.md).
### Develop locally
### For Contributors
```bash
git clone https://github.com/EverMind-AI/EverOS.git
cd EverOS
uv sync # creates ./.venv and installs deps
source .venv/bin/activate # or skip activation and prefix every command with `uv run`
source .venv/bin/activate # or prefix commands with `uv run`
everos init # fill the four API key slots in .env (two distinct keys)
everos --help
@ -136,8 +220,39 @@ make test
```
<br>
<div align="right">
## Storage layout
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Architecture At A Glance
```
┌───────────────────────────────────────────────┐
│ entrypoints/ (CLI + HTTP API) │ presentation
├───────────────────────────────────────────────┤
│ service/ (use cases: memorize/retrieve) │ application
├───────────────────────────────────────────────┤
│ memory/ (extract + search + cascade) │ domain
├───────────────────────────────────────────────┤
│ infra/ (markdown / sqlite / lancedb) │ infrastructure
└───────────────────────────────────────────────┘
↑ ↑
component/ core/
(LLM/Embedding) (observability/lifespan)
```
DDD 5 layers, single-direction dependency. See [docs/architecture.md](docs/architecture.md).
<br>
<div align="right">
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Storage Layout
```
~/.everos/
@ -165,6 +280,11 @@ is the user-facing memory surface, while extracted derivatives sit
quietly alongside.
<br>
<div align="right">
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Features
@ -176,8 +296,13 @@ quietly alongside.
- **Multi-modal**: text + small image / audio inline; large media via S3/OSS reference
<br>
<div align="right">
## Project structure
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Project Structure
```
everos/ # repo root
@ -194,22 +319,36 @@ everos/ # repo root
└── .claude/ # team-shared rules + skills (auto-loaded by Claude Code)
```
<br>
<div align="right">
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Documentation
- [docs/overview.md](docs/overview.md) — Project overview & vision
- [docs/architecture.md](docs/architecture.md) — DDD layered architecture & dependency rules
- [docs/engineering.md](docs/engineering.md) — Engineering & dev-efficiency infrastructure (CI / tooling / Claude Code)
- [docs/use-cases.md](docs/use-cases.md) — Full use-case gallery and integration examples
- [docs/migration-to-1.0.0.md](docs/migration-to-1.0.0.md) — Legacy API and infrastructure migration notes
- [CHANGELOG.md](CHANGELOG.md) — Release notes
- [CONTRIBUTING.md](CONTRIBUTING.md) — How to contribute
- [.claude/rules/](.claude/rules/) — Detailed coding conventions (auto-loaded by Claude Code)
<br>
<div align="right">
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
## Use Cases
Use cases show what persistent memory makes possible in real products and workflows. Some examples are packaged in this repository; others point to external demos or integrations you can study and adapt.
Use cases show what persistent memory makes possible in real products and
workflows. Some examples are packaged in this repository; others point to
external demos or integrations you can study and adapt.
<table>
<tr>
@ -217,7 +356,7 @@ Use cases show what persistent memory makes possible in real products and workfl
[![banner-gif](https://github.com/user-attachments/assets/840470d7-a838-4c05-8685-dd797d4e9cdf)](https://evermind.ai/usecase_reunite)
#### Reunite - Find with EverOS
#### Reunite - Find With EverOS
Parents describe what they remember. Children describe what they recall. Reunite uses semantic memory to surface the connections.
@ -230,7 +369,7 @@ Parents describe what they remember. Children describe what they recall. Reunite
#### Hive Orchestrator
Browser-native hive-mind for CLI coding agents Claude Code, Codex, Gemini, and OpenCode collaborate as real PTY processes via a team protocol.
Browser-native hive-mind for CLI coding agents - Claude Code, Codex, Gemini, and OpenCode collaborate as real PTY processes via a team protocol.
[Code](https://github.com/tt-a1i/hive)
@ -242,7 +381,7 @@ Browser-native hive-mind for CLI coding agents — Claude Code, Codex, Gemini, a
[![banner-gif](https://github.com/user-attachments/assets/867d9329-ce9a-496f-ab1e-15c77974e5fa)](https://github.com/tt-a1i/evermemos-mcp)
#### AI Coding Assistants with EverOS
#### AI Coding Assistants With EverOS
Universal long-term memory layer for AI coding assistants, powered by EverOS.
@ -253,9 +392,9 @@ Universal long-term memory layer for AI coding assistants, powered by EverOS.
[![banner-gif](https://github.com/user-attachments/assets/a4f0fd86-1c81-4445-bebc-e51eb5e33b30)](https://github.com/yuansui123/AI-Data-Technician-EverMemOS)
#### AI Data Techician
#### AI Data Technician
An agentic AI system that learns from scientist interaction to inspect, analyze, and classify high-dimensional time series data with persistent memory that improves across sessions.
An agentic AI system that learns from scientist interaction to inspect, analyze, and classify high-dimensional time series data - with persistent memory that improves across sessions.
[Code](https://github.com/yuansui123/AI-Data-Technician-EverMemOS)
@ -267,7 +406,7 @@ An agentic AI system that learns from scientist interaction to inspect, analyze,
![banner-gif](https://github.com/user-attachments/assets/650b901b-c9ba-4001-bac7-626b009df830)
#### Rokid AI Assistant with EverOS
#### Rokid AI Assistant With EverOS
Connect to EverOS within Rokid Glasses enabling long-term memory for all of your smart activities.
@ -278,15 +417,21 @@ Coming soon
![banner-gif](https://github.com/user-attachments/assets/85b338b2-e48e-4a65-9f30-0bc6998df872)
#### Creative Assistant with Memory
#### Creative Assistant With Memory
Creative assistant with long-term memory, never forget your crativites anymore.
Creative assistant with long-term memory, so your creative context stays available across sessions.
Coming soon
</td>
</tr>
<tr>
<td colspan="2" align="right">
<a href="#readme-top"><img src="https://img.shields.io/badge/-Back_to_top-gray?style=flat-square" alt="Back to top"></a>
</td>
</tr>
<tr>
<td width="50%" valign="top">
@ -329,7 +474,7 @@ Record, visualize, and explore your tasting journey through an immersive 3D star
#### EverOS Open Her
Build AI that feels. Open-source persona engine personality emerges from neural drives, not prompts. Inspired by Her.
Build AI that feels. Open-source persona engine - personality emerges from neural drives, not prompts. Inspired by Her.
[Code](https://github.com/kellyvv/OpenHer)
@ -341,7 +486,7 @@ Build AI that feels. Open-source persona engine — personality emerges from neu
[![banner-gif](https://github.com/user-attachments/assets/550071c1-dc39-4964-9f67-ffdfad792345)](https://chromewebstore.google.com/detail/ruminer-browser-agent/lbccjohfpdpimbhpckljimgolndfmfif)
#### Browser Agent for Personal Memory
#### Browser Agent For Personal Memory
Ruminer brings persistent memory to a browser agent so it can carry personal context across web tasks.
@ -352,7 +497,7 @@ Ruminer brings persistent memory to a browser agent so it can carry personal con
[![banner-gif](https://github.com/user-attachments/assets/c258a6c4-fe70-497a-98d1-3dade4a932f6)](https://github.com/nanxingw/EverMem)
#### EverMem Sync with EverOS
#### EverMem Sync With EverOS
One command to connect any AI coding CLI to EverMemOS long-term memory.
@ -361,6 +506,12 @@ One command to connect any AI coding CLI to EverMemOS long-term memory.
</td>
</tr>
<tr>
<td colspan="2" align="right">
<a href="#readme-top"><img src="https://img.shields.io/badge/-Back_to_top-gray?style=flat-square" alt="Back to top"></a>
</td>
</tr>
<tr>
<td width="50%" valign="top">
@ -377,7 +528,7 @@ MCO equips your primary agent with an agent team that can work together to solve
[![banner-gif](https://github.com/user-attachments/assets/314c9126-8e08-4688-bbbb-8555ad58cf67)](https://github.com/onenewborn/StudyBuddy-public)
#### Study Buddy with Self-Evolving Memory
#### Study Buddy With Self-Evolving Memory
Study proactively with an agent that has self-evolving memory.
@ -391,7 +542,7 @@ Study proactively with an agent that has self-evolving memory.
[![banner-gif](https://github.com/user-attachments/assets/21da76aa-9a8b-48e0-9134-42429d7390e7)](https://github.com/TonyLiangDesign/MemoCare)
#### Alzheimers Memory Assistant
#### Alzheimer's Memory Assistant
Empowering individuals with advanced memory support and daily assistance.
@ -427,12 +578,18 @@ An iOS app where users create, nurture, and live with a personalized AI companio
[![banner-gif](https://github.com/user-attachments/assets/9aabcaa9-f97a-49d2-9109-0b5bb696ed41)](https://github.com/JaMesLiMers/EvermemCompetition-Spiro)
#### AI Wearable with Memory
#### AI Wearable With Memory
A context-native AI wearable that listens to everyday life and converts conversations into memory.
[Code](https://github.com/JaMesLiMers/EvermemCompetition-Spiro)
</td>
</tr>
<tr>
<td colspan="2" align="right">
<a href="#readme-top"><img src="https://img.shields.io/badge/-Back_to_top-gray?style=flat-square" alt="Back to top"></a>
</td>
</tr>
<tr>
@ -451,7 +608,7 @@ Archived pre-1.0.0 plugin reference. New integrations should use the EverOS 1.0.
[![banner-gif](https://github.com/user-attachments/assets/3a2357a1-c0c3-464a-8979-0d1cdfc9b0d4)](https://github.com/TEN-framework/ten-framework/tree/04cb80601374fa9e35b4e544b2dbd23286ca7763/ai_agents/agents/examples/voice-assistant-with-EverMemOS)
#### Live2D Character with Memory
#### Live2D Character With Memory
Add long-term memory to a real-time Live2D character, powered by [TEN Framework](https://github.com/TEN-framework/ten-framework).
@ -464,7 +621,7 @@ Add long-term memory to a real-time Live2D character, powered by [TEN Framework]
[![banner-gif](https://github.com/user-attachments/assets/c36bdc04-97d3-4fe9-97d9-4b93b475595a)](https://screenshot-analysis-vercel.vercel.app/)
#### Computer-Use with Memory
#### Computer-Use With Memory
Run screenshot-based analysis with computer-use and store the results in memory.
@ -475,7 +632,7 @@ Run screenshot-based analysis with computer-use and store the results in memory.
[![banner-gif](https://github.com/user-attachments/assets/54a7cf8f-62c4-4fbc-9d50-b214d034e051)](use-cases/game-of-throne-demo)
#### Game of Thrones Memories
#### Game Of Thrones Memories
A demonstration of AI memory infrastructure through an interactive Q&A experience with *A Game of Thrones*.
@ -518,10 +675,14 @@ Explore stored entities and relationships in a graph interface. Frontend demo; b
## Stay Tuned
Star the repo or join the community links above to follow new architecture methods, benchmark releases, and memory-enabled use cases.
Star the repo or join the community links above to follow new architecture methods, benchmark releases, memory-enabled use cases, Wiki-style memory, and Dreaming updates.
![star us gif](https://github.com/user-attachments/assets/0c512570-945a-483a-9f47-8e067bd34484)
### Star History
[![Star History Chart](https://api.star-history.com/svg?repos=EverMind-AI/EverOS&type=Date)](https://www.star-history.com/#EverMind-AI/EverOS&Date)
<br>
<div align="right">
@ -529,6 +690,55 @@ Star the repo or join the community links above to follow new architecture metho
</div>
## EverMind Ecosystems
EverMind is an open-source ecosystem for long-term memory, self-evolving agents, and memory evaluation. EverOS is the core runtime architecture; EverMemOS is the paper and research line carrying our strongest memory-system benchmark runs; EverAlgo supplies the next-generation algorithms that make the system modular and reusable.
<table>
<tr>
<th colspan="2">EverMind Open-Source Ecosystem</th>
</tr>
<tr>
<td><strong>Core Memory Architecture</strong></td>
<td><a href="https://github.com/EverMind-AI/EverOS">EverOS</a> / EverMemOS - the local memory operating system and research-backed runtime for agent and user memory.</td>
</tr>
<tr>
<td><strong>Algorithm Engine</strong></td>
<td><a href="https://github.com/EverMind-AI/EverAlgo">EverAlgo</a> - stateless extraction, ranking, parsing, and memory operators that power EverOS.</td>
</tr>
<tr>
<td><strong>Alternative Architecture</strong></td>
<td><a href="https://github.com/EverMind-AI/HyperMem">HyperMem</a> - hypergraph memory for long-term conversations, with its own benchmark-backed topic -> episode -> fact retrieval method.</td>
</tr>
<tr>
<td><strong>Benchmarks</strong></td>
<td><a href="https://github.com/EverMind-AI/EverMemBench">EverMemBench</a> · <a href="https://github.com/EverMind-AI/EvoAgentBench">EvoAgentBench</a> - evaluation suites for conversational memory and agent self-evolution.</td>
</tr>
<tr>
<td><strong>Long-Context Research</strong></td>
<td><a href="https://github.com/EverMind-AI/MSA">MSA</a> - Memory Sparse Attention for scalable latent memory and 100M-token contexts.</td>
</tr>
<tr>
<td><strong>Personal Memory Layer</strong></td>
<td><a href="https://github.com/EverMind-AI/EverMe">EverMe</a> - CLI and agent plugin suite for cross-device, cross-agent personal memory.</td>
</tr>
<tr>
<td><strong>Developer Integrations</strong></td>
<td><a href="https://github.com/EverMind-AI/evermem-claude-code">evermem-claude-code</a> · <a href="https://github.com/EverMind-AI/everos-plugins">everos-plugins</a> - plugins, skills, and migration tooling for AI coding agents.</td>
</tr>
</table>
Together, these repositories form EverMind's research-to-runtime stack: new memory methods, reusable algorithms, benchmark evidence, and practical agent integrations.
<br>
<div align="right">
[![](https://img.shields.io/badge/-Back_to_top-gray?style=flat-square)](#readme-top)
</div>
<br>
## Contributing
Contributions are welcome across the whole repository: architecture methods, benchmark coverage, use-case examples, documentation, and bug fixes. Browse [Issues](https://github.com/EverMind-AI/EverOS/issues) to find a good entry point, then open a PR when you are ready.