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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 34 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center" id="readme-top">

# EverMe
# EverMe CLI

<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>
Expand All @@ -9,7 +9,10 @@
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge" alt="License"></a>
</p>

**Open-source CLI and Agent plugin suite for [EverMe](https://evermind.ai/everme) — cross-device, cross-Agent personal memory for AI Agents.**
**Open-source CLI, MCP server, SDK, and Agent plugins for connecting AI Agents to [EverMe](https://evermind.ai/everme).**

> [!IMPORTANT]
> This repository contains only the open-source EverMe client toolchain and Agent integrations. The EverMe product, web application, and managed backend are separate and are not included in this repository.

[Product](https://evermind.ai/everme) · [Website](https://evermind.ai) · [EverOS engine](https://github.com/EverMind-AI/EverOS) · [Documentation](https://docs.evermind.ai/introduction) · [中文](README.zh.md)

Expand All @@ -22,7 +25,7 @@

<br>

- [Project Overview](#project-overview)
- [Repository Overview](#repository-overview)
- [Quick Start](#quick-start)
- [What's Inside](#whats-inside)
- [Use It With Your Agent](#use-it-with-your-agent)
Expand All @@ -37,33 +40,31 @@

</details>

## Project Overview

**EverMe** is your digital twin powered by a memory that's truly yours. Every conversation becomes experience; every experience becomes mastery — the Agent evolution loop.
## Repository Overview

This repository ships the **client-side toolchain** that connects any AI Agent — Claude Code, Cursor, Codex, Hermes, OpenClaw, and others — to the EverMe memory layer. The managed service and the EverOS memory engine live separately:
This repository ships the **client-side toolchain** that connects AI Agents — Claude Code, Cursor, Codex, Kimi Code, Hermes, Raven, OpenClaw, and others — to the [EverMe](https://evermind.ai/everme) memory layer. The managed product and the EverOS memory engine live separately:

| Layer | What it gives you | Where it lives |
| :--- | :--- | :--- |
| **EverMe CLI + plugins** (this repo) | Auth, plugin install, MCP server, Agent hooks | `EverMind-AI/EverMe` (Apache-2.0) |
| **EverOS** memory engine | The long-term memory operating system | [EverMind-AI/EverOS](https://github.com/EverMind-AI/EverOS) (open source) |
| **EverMe managed service** | Hosted backend, account, billing | [evermind.ai/everme](https://evermind.ai/everme) |

You can run EverMe fully against the managed service today, or self-host the EverOS engine and point the CLI at your own endpoint via `EVERME_API_BASE`.
Use this toolchain with the managed EverMe service, or self-host EverOS and point the CLI at a compatible endpoint via `EVERME_API_BASE`. The hosted EverMe app, account system, and billing service are not part of this repository.

<br>

## Quick Start

### Easiest — let your Agent install it for you
### Easiest — connect your Agent in one line

Paste this single line into any AI Agent you already use locally (Claude Code, Cursor, Codex, …):

```text
Read https://everme.evermind.ai/SKILL.md and follow the instruction to install and configure EverMe.
```

The Agent fetches the skill, installs the CLI, walks you through login, and registers the plugin for itself — no manual steps.
The Agent fetches the skill, installs the CLI, walks you through login, and registers the plugin for itself — without requiring you to edit configuration files manually.

### Manual install

Expand All @@ -79,15 +80,21 @@ evercli plugin install claude-code
evercli plugin install claude-desktop
evercli plugin install codex
evercli plugin install cursor
evercli plugin install gemini
evercli plugin install devin
evercli plugin install dsh
evercli plugin install hermes
evercli plugin install kimicode
evercli plugin install opencode
evercli plugin install openclaw
evercli plugin install raven
evercli plugin install workbuddy

# 4. Verify
evercli doctor
```

Kimi Code needs one final host-owned step after staging: run `/plugins install ~/.kimi-code/everme` inside its TUI. WorkBuddy asks you to trust the new MCP server in its MCP management dialog.

Once installed, open your Agent and ask "what do you remember about me?" — it will use the MCP `mem://profile` resource to recall.

> Self-hosting EverOS? Set `EVERME_API_BASE=https://your-host` before `auth login` and the CLI will talk to your endpoint instead.
Expand All @@ -104,22 +111,33 @@ Once installed, open your Agent and ask "what do you remember about me?" — it
| [`plugins/claude-code/`](plugins/claude-code/) | `@everme/claude-code` | Native Claude Code plugin (hooks · commands · skills · MCP) |
| [`plugins/openclaw/`](plugins/openclaw/) | `@everme/openclaw` | OpenClaw ContextEngine plugin |
| [`plugins/cli/`](plugins/cli/) | `@everme/cli` | npm wrapper that downloads the platform-native `evercli` binary |
| [`plugins/codex/`](plugins/codex/) | `@everme/codex` | Codex lifecycle hooks and marketplace build tooling |
| [`plugins/cursor/`](plugins/cursor/) | `@everme/cursor` | Native Cursor lifecycle hooks |
| [`plugins/devin/`](plugins/devin/) | `@everme/devin` | Native Devin lifecycle hooks |
| [`plugins/dsh/`](plugins/dsh/) | `@everme/dsh` | Native DeepSeek Harness lifecycle plugin |
| [`plugins/kimicode/`](plugins/kimicode/) | `@everme/kimicode` | Native Kimi Code plugin bundle |
| [`plugins/everme/`](plugins/everme/) | Codex marketplace plugin | Codex App / Codex CLI recall via MCP resources |

<br>

## Use It With Your Agent

Each Agent has its own configuration surface. `evercli plugin install <agent>` writes the right file at the right path, with `0600` permissions for any credential-bearing config.
Each Agent has its own configuration surface. `evercli plugin install <agent>` applies the host-specific setup and protects credential-bearing files with `0600` permissions.

| Agent | Install command | What gets configured |
| :--- | :--- | :--- |
| **Claude Code** | `evercli plugin install claude-code` | `~/.claude/everme.env` + plugin registration |
| **Codex (App + CLI)** | `evercli plugin install codex` | `~/.codex/config.toml` MCP entry + marketplace plugin |
| **Cursor** | `evercli plugin install cursor` | Cursor MCP config |
| **Hermes** | `evercli plugin install hermes` | `<hermes_home>/everme.env` + `~/.hermes/config.yaml` MCP entry |
| **Cursor** | `evercli plugin install cursor` | `~/.cursor/mcp.json` + native lifecycle hooks |
| **Claude Desktop** | `evercli plugin install claude-desktop` | Claude Desktop MCP config |
| **Devin** | `evercli plugin install devin` | `~/.config/devin/mcp_config.json` + native lifecycle hooks |
| **DeepSeek Harness** | `evercli plugin install dsh` | Native lifecycle plugin + managed profile patches |
| **Hermes** | `evercli plugin install hermes` | `$HERMES_HOME/config.yaml` + embedded MemoryProvider |
| **Kimi Code** | `evercli plugin install kimicode` | Plugin bundle staging + TUI registration step |
| **OpenCode** | `evercli plugin install opencode` | `~/.config/opencode/opencode.json` MCP entry |
| **OpenClaw** | `evercli plugin install openclaw` | OpenClaw plugin registration |
| **Raven** | `evercli plugin install raven` | `~/.raven/config.json` + embedded MemoryBackend |
| **WorkBuddy** | `evercli plugin install workbuddy` | `~/.workbuddy/mcp.json` + first-connection trust step |

The memory each Agent reads and writes lives in **one shared memory pool** keyed to your account — so context follows *you*, not the app.

Expand Down Expand Up @@ -171,7 +189,7 @@ Release flow and packaging are documented in [`cli/README.md`](cli/README.md) an

## Public Contracts

EverMe is read by AI Agents as much as by humans. The stable contract for CLI stdout/stderr, structured errors, MCP tools/resources, and token redaction is documented in [`docs/contracts.md`](docs/contracts.md). Changes that break those contracts are versioned.
Humans and AI Agents both invoke this toolchain. The stable contract for CLI stdout/stderr, structured errors, MCP tools/resources, and token redaction is documented in [`docs/contracts.md`](docs/contracts.md). Changes that break those contracts are versioned.

<br>

Expand All @@ -189,7 +207,7 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md). Bug reports, plugin support for new Ag

## License

[Apache-2.0](LICENSE). © 2026 EverMind AI.
[Apache-2.0](LICENSE). This license applies only to the source code in this repository, not to the hosted EverMe product or service. © 2026 EverMind AI.

<div align="right">

Expand Down
53 changes: 37 additions & 16 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center" id="readme-top">

# EverMe
# EverMe CLI

<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>
Expand All @@ -9,7 +9,10 @@
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge" alt="License"></a>
</p>

**[EverMe](https://evermind.ai/everme) 的开源 CLI 与 Agent 插件套件 —— 跨设备、跨 Agent 的个人记忆层。**
**用于将 AI Agent 接入 [EverMe](https://evermind.ai/everme) 的开源 CLI、MCP Server、SDK 与 Agent 插件。**

> [!IMPORTANT]
> 本仓库仅包含开源的 EverMe 客户端工具链与 Agent 接入代码。EverMe 产品、Web 应用和托管后端是独立服务,不包含在本仓库中。

[产品主页](https://evermind.ai/everme) · [官网](https://evermind.ai) · [EverOS 记忆引擎](https://github.com/EverMind-AI/EverOS) · [文档](https://docs.evermind.ai/introduction) · [English](README.md)

Expand All @@ -22,7 +25,7 @@

<br>

- [项目概览](#项目概览)
- [仓库概览](#仓库概览)
- [快速开始](#快速开始)
- [仓库结构](#仓库结构)
- [接入你的 Agent](#接入你的-agent)
Expand All @@ -37,33 +40,31 @@

</details>

## 项目概览

**EverMe** 是真正懂你的数字分身,从一份真正属于你的记忆开始。每一次对话沉淀为经验、每一段经验固化为能力 —— Agent 的进化闭环。
## 仓库概览

本仓库提供把任意 AI Agent —— Claude Code、Cursor、Codex、Hermes、OpenClaw 等 —— 接入 EverMe 记忆层所需的**客户端工具链**。托管服务与 EverOS 记忆引擎分别独立:
本仓库提供把 Claude Code、Cursor、Codex、Kimi Code、Hermes、Raven、OpenClaw 等 AI Agent 接入 [EverMe](https://evermind.ai/everme) 记忆层所需的**客户端工具链**。EverMe 托管产品与 EverOS 记忆引擎分别独立:

| 层级 | 提供什么 | 在哪里 |
| :--- | :--- | :--- |
| **EverMe CLI + 插件**(本仓库)| 登录认证、插件安装、MCP server、Agent hooks | `EverMind-AI/EverMe`(Apache-2.0)|
| **EverOS** 记忆引擎 | 长期记忆操作系统 | [EverMind-AI/EverOS](https://github.com/EverMind-AI/EverOS)(已开源)|
| **EverMe 托管服务** | 后端、账号、计费 | [evermind.ai/everme](https://evermind.ai/everme) |

可以选择直接对接托管服务,也可以自托管 EverOS 引擎 —— 通过 `EVERME_API_BASE` 把 CLI 指向你自己的部署即可
这套工具链既可以连接 EverMe 托管服务,也可以通过 `EVERME_API_BASE` 连接兼容的自托管 EverOS 端点。本仓库不包含 EverMe Web 应用、账号系统或计费服务

<br>

## 快速开始

### 最快 —— 让你的 Agent 自己装
### 最快 —— 用一句话接入你的 Agent

把下面这句话粘贴给任意一个你本地已经在用的 AI Agent(Claude Code、Cursor、Codex、……):

```text
Read https://everme.evermind.ai/SKILL.md and follow the instruction to install and configure EverMe.
```

Agent 会自动拉取 skill、安装 CLI、引导你登录并为自己注册插件 —— 无需任何手工步骤
Agent 会自动拉取 skill、安装 CLI、引导你登录并为自己注册插件,无需手动编辑配置文件

### 手动安装

Expand All @@ -76,15 +77,24 @@ evercli auth login

# 3. 接入 Agent —— 装一个或多个:
evercli plugin install claude-code
evercli plugin install claude-desktop
evercli plugin install codex
evercli plugin install cursor
evercli plugin install devin
evercli plugin install dsh
evercli plugin install hermes
evercli plugin install kimicode
evercli plugin install opencode
evercli plugin install openclaw
evercli plugin install raven
evercli plugin install workbuddy

# 4. 自检
evercli doctor
```

Kimi Code 完成预配置后,还需要在 TUI 内运行 `/plugins install ~/.kimi-code/everme`;WorkBuddy 则需要在 MCP 管理界面信任新增的服务。

装好后打开你的 Agent,问它 "what do you remember about me?" —— 它会通过 MCP `mem://profile` 资源去召回你的记忆。

> 自托管 EverOS?在 `auth login` 之前设置 `EVERME_API_BASE=https://your-host`,CLI 就会去访问你自己的端点。
Expand All @@ -101,22 +111,33 @@ evercli doctor
| [`plugins/claude-code/`](plugins/claude-code/) | `@everme/claude-code` | Claude Code 原生插件(hooks · commands · skills · MCP)|
| [`plugins/openclaw/`](plugins/openclaw/) | `@everme/openclaw` | OpenClaw ContextEngine 插件 |
| [`plugins/cli/`](plugins/cli/) | `@everme/cli` | 自动下载 `evercli` 平台二进制的 npm 封装 |
| [`plugins/codex/`](plugins/codex/) | `@everme/codex` | Codex 生命周期 hooks 与 marketplace 构建工具 |
| [`plugins/cursor/`](plugins/cursor/) | `@everme/cursor` | Cursor 原生生命周期 hooks |
| [`plugins/devin/`](plugins/devin/) | `@everme/devin` | Devin 原生生命周期 hooks |
| [`plugins/dsh/`](plugins/dsh/) | `@everme/dsh` | DeepSeek Harness 原生生命周期插件 |
| [`plugins/kimicode/`](plugins/kimicode/) | `@everme/kimicode` | Kimi Code 原生插件包 |
| [`plugins/everme/`](plugins/everme/) | Codex marketplace 插件 | 通过 MCP resources 给 Codex App / Codex CLI 提供召回 |

<br>

## 接入你的 Agent

每个 Agent 的配置入口不同。`evercli plugin install <agent>` 会把对应文件写入对应路径,所有承载凭据的配置都强制 `0600` 权限
每个 Agent 的配置入口不同。`evercli plugin install <agent>` 会执行对应平台的安装流程,并将承载凭据的文件权限设为 `0600`。

| Agent | 安装命令 | 写入的配置 |
| :--- | :--- | :--- |
| **Claude Code** | `evercli plugin install claude-code` | `~/.claude/everme.env` + 插件注册 |
| **Codex(App + CLI)**| `evercli plugin install codex` | `~/.codex/config.toml` MCP 条目 + marketplace 插件 |
| **Cursor** | `evercli plugin install cursor` | Cursor MCP 配置 |
| **Hermes** | `evercli plugin install hermes` | `<hermes_home>/everme.env` + `~/.hermes/config.yaml` MCP 条目 |
| **Codex(App + CLI)** | `evercli plugin install codex` | `~/.codex/config.toml` MCP 条目 + marketplace 插件 |
| **Cursor** | `evercli plugin install cursor` | `~/.cursor/mcp.json` + 原生生命周期 hooks |
| **Claude Desktop** | `evercli plugin install claude-desktop` | Claude Desktop MCP 配置 |
| **Devin** | `evercli plugin install devin` | `~/.config/devin/mcp_config.json` + 原生生命周期 hooks |
| **DeepSeek Harness** | `evercli plugin install dsh` | 原生生命周期插件 + 托管 profile 补丁 |
| **Hermes** | `evercli plugin install hermes` | `$HERMES_HOME/config.yaml` + 内置 MemoryProvider |
| **Kimi Code** | `evercli plugin install kimicode` | 插件包预配置 + TUI 注册步骤 |
| **OpenCode** | `evercli plugin install opencode` | `~/.config/opencode/opencode.json` MCP 条目 |
| **OpenClaw** | `evercli plugin install openclaw` | OpenClaw 插件注册 |
| **Raven** | `evercli plugin install raven` | `~/.raven/config.json` + 内置 MemoryBackend |
| **WorkBuddy** | `evercli plugin install workbuddy` | `~/.workbuddy/mcp.json` + 首次连接信任步骤 |

所有 Agent 读写的记忆都落在**同一份记忆池**里,按你的账号隔离 —— 所以上下文跟着**你**走,而不是被锁在某个 App 里。

Expand Down Expand Up @@ -168,7 +189,7 @@ npm test --workspaces --if-present

## 公开契约

EverMe 同时被人和 AI Agent 读取。CLI 的 stdout/stderr、结构化错误、MCP tools/resources、token 脱敏规则的稳定契约见 [`docs/contracts.md`](docs/contracts.md)。任何 break 这些契约的改动都按版本管理
人和 AI Agent 都会调用这套工具链。CLI 的 stdout/stderr、结构化错误、MCP tools/resources、token 脱敏规则的稳定契约见 [`docs/contracts.md`](docs/contracts.md)。任何破坏这些契约的改动都按版本管理

<br>

Expand All @@ -186,7 +207,7 @@ EverMe 同时被人和 AI Agent 读取。CLI 的 stdout/stderr、结构化错误

## License

[Apache-2.0](LICENSE). © 2026 EverMind AI.
[Apache-2.0](LICENSE)。该许可证仅适用于本仓库中的源代码,不适用于 EverMe 托管产品或服务。© 2026 EverMind AI

<div align="right">

Expand Down
Loading