Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
130 changes: 130 additions & 0 deletions ACKNOWLEDGMENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Acknowledgments

[Home](README.md) > [Docs](docs/index.md) > Acknowledgments

Thanks to the following projects, communities, and individuals for their
inspiration and support.

---

## Inspiration & references

### [memsearch](https://github.com/zilliztech/memsearch)

Inspired our markdown-as-source-of-truth design and the SHA-256 +
file-watcher incremental sync model. memsearch is the closest project in
spirit to EverOS.

### [mem0](https://github.com/mem0ai/mem0)

Inspired the "one provider per file" flat adapter layout that EverOS uses
for `component/llm/` and `component/embedding/`.

### [Letta (MemGPT)](https://github.com/letta-ai/letta)

Inspired the multi-tier memory mapping (Core / Recall / Archival) that maps
naturally onto our MemCell / Episode / Archival pipeline.

### [MemOS](https://github.com/MemTensor/MemOS)

Provided a reference for memory taxonomy decisions (textual / parametric /
activation) and helped sharpen our scope choice to focus on textual memory.

### [Memos](https://github.com/usememos/memos)

A comprehensive open-source note-taking service whose plain-text-first
design philosophy reinforced our decision to keep markdown files as the
single source of truth.

### [Nemori](https://github.com/nemori-ai/nemori)

A self-organising long-term memory substrate for agentic LLM workflows that
provided valuable inspiration for our extraction pipeline.

---

## Open-source libraries

EverOS is built on top of excellent open-source libraries and frameworks:

### Core

- **[Python](https://www.python.org/)** — Programming language (3.12+)
- **[uv](https://github.com/astral-sh/uv)** — Fast Python package manager
- **[FastAPI](https://fastapi.tiangolo.com/)** — Modern async web framework (HTTP API)
- **[Pydantic](https://docs.pydantic.dev/)** — Data validation and settings

### Storage

- **[LanceDB](https://lancedb.com/)** — Embedded vector + BM25 + scalar database
- **[SQLite](https://sqlite.org/)** — Embedded relational database (state + audit log)

### Tooling

- **[Ruff](https://docs.astral.sh/ruff/)** — Lint + format
- **[import-linter](https://import-linter.readthedocs.io/)** — Layered architecture enforcement
- **[Hatchling](https://hatch.pypa.io/)** — Wheel build backend
- **[pytest](https://pytest.org/)** — Testing framework
- **[pre-commit](https://pre-commit.com/)** — Git hooks framework

### LLM & embedding providers

EverOS is provider-agnostic by design. Tested provider integrations include
OpenAI, Anthropic, Ollama, and SBERT. See [`component/llm/`](src/everos/component/llm/)
and [`component/embedding/`](src/everos/component/embedding/) for the
adapter layouts.

---

## Contributors

Thanks to all the developers who have contributed to this project.

See the full list of contributors on
[GitHub](https://github.com/EverMind-AI/everos/graphs/contributors).

<!-- Future: contributor image grid
<a href="https://github.com/EverMind-AI/everos/graphs/contributors">
<img src="https://contrib.rocks/image?repo=EverMind-AI/everos" />
</a>
-->

---

## Community

Thanks to our community for valuable feedback, bug reports, and feature
suggestions:

- **GitHub Issues & Discussions** — bug reports and feature requests
- **Discord** — [Join our Discord server](https://discord.gg/pfwwskxp)
- **X / Twitter** — [@EverMindAI](https://x.com/EverMindAI)

---

## Supporting organizations

- **Shanda Group** — for supporting the development of EverOS

---

## Special thanks

- To everyone who starred the repository
- To those who shared EverOS with others
- To researchers and developers using EverOS in their work

---

## Want to contribute?

Contributions are welcome! See the [Contributing Guide](CONTRIBUTING.md)
to get started.

---

## See also

- [Citation](CITATION.md)
- [Changelog](CHANGELOG.md)
- [Contributing Guide](CONTRIBUTING.md)
73 changes: 0 additions & 73 deletions AGENTS.md

This file was deleted.

40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Changelog

All notable changes to **EverOS** are documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

_Unreleased changes on `dev` will be listed here._

## [1.0.0] - 2026-06-03

First public release of EverOS — a Markdown-first memory extraction framework
for AI agents.

### Added

- **Markdown as source of truth** — all memory persists as plain `.md` files you
can open, edit, grep, and version with Git.
- **Lightweight three-piece storage** — Markdown (truth) + SQLite (state / queue
/ audit) + LanceDB (vector + BM25 + scalar index). No external services
required.
- **Hybrid retrieval** — BM25, vector, and scalar filtering in a single LanceDB
query.
- **Cascade index sync** — editing a `.md` file triggers a file watcher →
entry-level diff → sub-second LanceDB sync.
- **Dual-track memory** — user-track (Episodes / Profiles) and agent-track
(Cases / Skills).
- **Multi-source extraction** — conversations, workflows, agent traces, and file
knowledge.
- **CLI + HTTP API** — the `everos` command-line tool and a FastAPI server,
async-first throughout.
- **Pluggable providers** — LLM / embedding / rerank via the OpenAI-compatible
protocol (works with OpenAI, OpenRouter, vLLM, Ollama, …).
- **Decoupled algorithms** — memory extraction algorithms live in the standalone
`everalgo-*` libraries published on PyPI.

[Unreleased]: https://github.com/EverMind-AI/everos/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/EverMind-AI/everos/releases/tag/v1.0.0
65 changes: 65 additions & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Citation

[Home](README.md) > [Docs](docs/index.md) > Citation

If you use **EverOS** in research or a published project, the suggested
citation forms are below.

---

## Paper

📄 **Paper coming soon** — a technical paper is in preparation.

```
Coming soon
```

BibTeX citation information will be added here once the paper is published.

---

## BibTeX

```bibtex
% Will be added when the paper is published
```

---

## Software citation

To cite the software itself:

```
EverOS: md-first memory extraction framework for AI agents
Version: 0.1.0
URL: https://github.com/EverMind-AI/everos
License: Apache 2.0
```

---

## Acknowledgments in your work

If you use EverOS, we appreciate:

- Citing the paper (when available)
- Starring the GitHub repository
- Mentioning EverOS in your acknowledgments section

---

## Stay updated

- Watch the [GitHub repository](https://github.com/EverMind-AI/everos) for paper announcements
- Follow [@EverMindAI](https://x.com/EverMindAI) on X / Twitter
- Join [GitHub Discussions](https://github.com/EverMind-AI/everos/discussions)

---

## See also

- [Overview](docs/overview.md)
- [Acknowledgments](ACKNOWLEDGMENTS.md)
- [Changelog](CHANGELOG.md)
Loading
Loading