diff --git a/README.md b/README.md index 7ade8441e..ced79e2ef 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@

Docs - applenews + applenews Discord X

@@ -20,7 +20,9 @@
-## Continue the same work across WorkBuddy, Claude Code, Codex, and etc. +## Continue the same work across DeepSeek Harness, Claude Code, Codex, and etc. + +[Overview](#what-is-memmy) · [Quick Start](#how-to-use-memmy) · [Technical Overview](#how-is-memmy-built) · [Roadmap](#roadmap) · [Acknowledgements](#acknowledgements) · [Contributors](#contributors)
@@ -30,112 +32,60 @@ -## 🆓 Sign-up for Free Trial - -Get Memmy from [Official Website](https://memmy.bot/) or [GitHub Release](https://github.com/MemTensor/memmy-agent/releases). - -> [!TIP] -> Sign up to get free tokens. Start exploring the full Memory + Agent Runtime with zero config.
-> **Trial credits:**
-> **Registration grants Agent task trial tokens; the current amount and usage are shown in the app.**
-> Once the trial credits run out, you can switch to BYOK and use your own model API. - -## What Is Memmy? - -Continue the same work across WorkBuddy, Claude Code, Codex, and Cursor.Memmy keeps project goals, decisions, constraints, and failed attempts locally, then brings the relevant context to the next Agent. -**Build it once, use it everywhere.** - - - -###  Cross-Agent Task Continuity - -![Memmy: Cross-Agent Task Continuity](docs/assets/cross-agent-task-continuity.gif) - -Memmy provides a unified personal memory layer for all AI Agents. - -- **Cross-Agent shared memory** Whether working in Codex, Claude Code, Cursor, or OpenClaw, you can keep using the same context and experience, no need to re-introduce anything again. -- **MemOS-powered memory engine** Automatically collects, understands, and structures your knowledge, preferences, and work experience, distilling scattered conversations and behavior into searchable, reusable long-term memory. -- **Historical context onboarding** Supports importing the history of your existing Agents, turning past conversations and project experience into a continuously growing personal knowledge asset. - -### 🕸️ Local Agent Runtime - -Memmy provides a complete local Agent runtime environment. - -- **A unified experience across entry points** Supports the desktop app, CLI/TUI, and an OpenAI-compatible API, all sharing the same Agents, memory, and configuration. -- **Continuous task collaboration** Start a task from any entry point and seamlessly continue it across different scenarios, unconstrained by a single session. -- **Extensible Agent capabilities** Connect more tools through Skills and MCP, taking the Agent from conversation to real task execution. Memmy also provides managed Chromium browser tools for local page inspection and visual verification. + -### 🔬 Tool & Ecosystem Connections +## What Is Memmy? -Memmy can connect to your working environment, letting the Agent truly participate in your daily workflows. - -- **Connect the tools you use** Supports Telegram, Discord, WeChat, Feishu, and DingTalk, plus productivity tools like GitHub, Gmail, Notion, Slack, and Jira. -- **An open tool ecosystem** Supports MCP and custom Skills, extending capabilities such as file handling, shell, web, image generation, and task automation. -- **Flexible model configuration** Configure reasoning, Embedding, memory processing, speech, and image generation models as needed, compatible with mainstream model services. - -### 🔐 Local-First — Your Data Belongs to You - -Memmy is designed to guarantee your control over your personal data and memory. - -- **Local-first architecture** Memory, configuration, and app state are stored on your machine by default; no data needs to be uploaded to the cloud. -- **Secure access control** Local services provide controlled access mechanisms, ensuring only authorized sources can invoke memory capabilities. -- **Real memory, no hallucinations** When the memory service is unavailable, Memmy reports the error explicitly instead of returning nonexistent "fake memories". - -## Build Context in Minutes, Not from Scratch - -After installing Memmy, it can automatically scan the history of your existing AI Agents. Within minutes, the project context, work habits, and preferences you have accumulated over the past months are converted into personal long-term memory, along with a personalized "First Meeting Report". - -Now supported: Cursor, Claude Code, Codex, OpenCode, OpenClaw, Hermes, WorkBuddy, Pi, and qwenwork Agents. +

+ Remember: Memmy remembers what you said and turns your local AI collaboration history into structured memory + Relay: switch tools without losing context—Memmy carries your project background, preferences, and progress forward + Act: Memmy is also an Agent that can organize information, combine approaches, and continue unfinished tasks +

-[See the full support list](https://memmy.bot/docs/memory/sources) +### Cross-Agent Task Continuity -## One Agent Runtime, Multiple Entry Points + + + + +
+ +
-Memmy is not just a chat interface — it is an AI Agent Runtime that runs locally. It unifies long-term memory, Agent execution, and tool connections in a single runtime environment, serving different scenarios through different entry points: +### Most of the Agents You're Using Can Connect to Memmy -| | Role | Core Capabilities | -| -------------------- | ---------------------------------- | --------------------------------------------------------------------------------- | -| 🧠 Memory Layer | Store and manage long-term context | Cross-Agent memory, history import, knowledge distillation, intelligent retrieval | -| 🤖 Agent Runtime | Drive Agents to execute tasks | Reasoning, task orchestration, tool calls, MCP, Skills | -| 🔌 Integration Layer | Connect external ecosystems | Messaging channels, third-party tools, OpenAI-compatible API | -| 🖥️ User Interface | Provide entry points | Desktop App, CLI/TUI, Web API | +**DeepSeek Harness, OpenClaw, Hermes, Claude Code, Codex, Cursor, WorkBuddy, OpenCode, Pi...they all work!** -### System Architecture +![cross-agent-en.png](docs/assets/cross-agent-en.png) -![Memmy System Architecture](docs/assets/memmy-architecture-en.png) +### Data Security -## Memmy vs. Personal AI Agents +![Memmy data security](docs/assets/data-security-en.png) -Compared with "personal AI Agents" like Hermes and OpenClaw, what sets Memmy apart is not "yet another assistant that chats and runs errands for you" — it is a **memory foundation shared across Agents**: it remembers you first, then builds a general-purpose Agent on top of that. + -| Capability | Memmy | Hermes | OpenClaw | -| ------------------------------------------------------------ | --------------------------------- | ----------------- | --------------------- | -| Product positioning | Memory foundation + general Agent | Personal AI Agent | Personal AI assistant | -| Local-first, data stays on your machine | ✅ | ⚠️ | ✅ | -| One memory shared across Agents | ✅ | 🚫 | 🚫 | -| Takes over external Agent history (Cursor/Codex/Claude Code) | ✅ | 🚫 | 🚫 | -| Installs memory Skills for external Agents | ✅ | 🚫 | 🚫 | -| Structured memory engine (MemOS hybrid retrieval) | ✅ | ⚠️ | ⚠️ | -| Multi-channel reach (Telegram / Discord / iMessage…) | ✅ | ✅ | ✅ | -| Voice messaging | ✅ | ⚠️ | ✅ | -| Multi-model / BYOK | ✅ | ✅ | ✅ | +## How to Use Memmy -> ✅ Native support ｜ ⚠️ Partial / requires setup ｜ 🚫 Not supported +For complete installation and configuration instructions, see the [Getting Started guide](docs/en/start/getting-started.mdx). -> The comparison is based on each product's public positioning (as of this writing), not an item-by-item benchmark; corrections are welcome. +#### 1. Desktop App (Recommended) -## Quick Start +

+ First scan + First Meeting Report +

-### Option 1: Desktop App +Download Memmy from the [official website](https://memmy.bot/) or [GitHub Releases](https://github.com/MemTensor/memmy-agent/releases). -1. Launch the Memmy desktop app and choose **Account mode** or **API Key mode**. -2. In API Key mode, configure the primary model and pass a connection test; optionally configure Embedding, ASR, image generation, memory summary, and skill evolution models. -3. Enter the main workbench and send your first task. -4. Open "Tools" to connect messaging channels or third-party tools; open "Memory" to scan Agent history sources. +> [!TIP] +> Sign up for Memmy to receive free tokens and try the complete Memory + Agent Runtime.
+> **Trial credits:**
+> Registration grants Agent task trial tokens; the current balance and usage are shown in the app.
+> When the trial credits run out, switch to BYOK mode and use your own model API. -> **Account mode free credits**: signing in grants Agent task trial tokens, so you can get running without your own API Key. The current amount and usage are shown in the app. Once used up or expired, switch to API Key (BYOK) mode and continue with your own quota. +#### 2. Use the `memmy` CLI / TUI -### Option 2: `memmy` CLI (Agent Runtime) +![Memmy TUI](docs/assets/tui.png) On Linux x64 or arm64 with Node.js 22 or newer and an available systemd user session: @@ -156,14 +106,14 @@ systemctl --user status memmy-gateway.service The installer initializes Memory without changing Codex, Claude Code, Cursor, or other agents. Run `memmy-memory init` (all detected agents) or `memmy-memory init --agent ` when you explicitly want to install the Memory Skill and the supported Hook/plugin for an agent. ```bash -memmy onboard # Initialize ~/.memmy/config.yaml and the workspace -memmy status # Check config, workspace, model, and provider status -memmy agent --message "Hi, introduce the current workspace" # Single-turn message -memmy # Run without a subcommand to enter interactive chat (TUI) +memmy onboard # Initialize the configuration and workspace +memmy status # Check the configuration, model, and provider +memmy agent --message "Introduce the current workspace" # Run a single-turn task +memmy # Enter the interactive TUI memmy serve # Start the OpenAI-compatible API (:18990) ``` -Minimal BYOK configuration (`~/.memmy/config.yaml`): +The minimal BYOK configuration is located at `~/.memmy/config.yaml`: ```yaml agents: @@ -173,96 +123,46 @@ agents: timezone: "+08:00" providers: openai: - apiKey: ${OPENAI_API_KEY} # Supports ${ENV_NAME}-style environment variable references -tools: - browser: - enabled: true - maxSessions: 4 - idleTimeoutS: 900 + apiKey: ${OPENAI_API_KEY} ``` -The desktop app and `scripts/dev-start.sh` prepare the matching managed Chromium build before the Agent Gateway starts. Agent requests never download a browser; when the managed executable is unavailable, browser tools are omitted while other Agent features continue to work. +#### 3. Use the `memmy-memory` CLI -### Option 3: `memmy-memory` CLI (memory access for external Agents / scripts) +Use it to access the local memory service from agents, scripts, and debugging workflows: ```bash -memmy-memory init # Write the Memory config and install Skills for each Agent as needed +memmy-memory init memmy-memory health memmy-memory search "memory policies in this project" memmy-memory add "a piece of knowledge worth saving" memmy-memory get ``` -Connects to `http://127.0.0.1:18960` by default; use `--url`, `--token`, `--config`, `--source`, and `--user-id` to specify the target service, authentication, source, and user namespace. - -## Core Concepts +It connects to `http://127.0.0.1:18960` by default. Use `--url`, `--token`, `--config`, `--source`, and `--user-id` to specify the service and namespace. -- **Workspace** — the Agent's working directory, default `~/.memmy/workspace`; syncs templates, built-in skills, and memory files. -- **Config** — the main configuration, default `~/.memmy/config.yaml` (overridable via `MEMMY_CONFIG` / `--config`), covering models, providers, tools, MCP, gateway, Memory, and workspace settings. -- **Agent Runtime** — the core of task execution: model calls, message loop, tool registration, MCP, sessions, long tasks, skill loading, auto-compaction, and memory hooks. -- **Memory Service** — the local-first memory foundation, default `http://127.0.0.1:18960`, providing session, turn, search, write, panel, and analytics APIs; every entry point reads and writes the same memory, so tasks and context carry over across Agents. -- **Local Backend** — the backend for the desktop local API (Fastify + SQLite app state), handling accounts, configuration, integrations, source scanning, and Skill writing. -- **Agent Source** — an adapter that collects historical context from external Agents; each source has history-reading logic and an optional Skill install target. - -## Build from Source - -### One-Command Start - -Get running in three steps: - -```bash -git clone https://github.com/MemTensor/memmy-agent.git && cd memmy-agent -cp .env.example .env # Cloud address is pre-filled — works out of the box -bash scripts/dev-start.sh # Install deps → build → start the full stack -``` - -`scripts/dev-start.sh` does it all in one command: installs dependencies, builds Memory and memmy-agent, installs the `memmy` / `memmy-memory` CLIs, and starts the full stack (Memory, Agent API, Gateway, frontend, desktop backend). Once the desktop app opens, finish account sign-in or BYOK setup and you're ready. - -> `MEMMY_CLOUD_SERVICE` in `.env` defaults to `https://memmy-api.memtensor.cn`, so copying it connects you to the official cloud — no self-hosted backend or API key required. On Windows, run it in Git Bash. - -### Requirements - -- Node.js `>=22` -- npm - -### Common Commands - -At the repository root: +#### 4. Start from the Source Code ```bash +git clone https://github.com/MemTensor/memmy-agent.git +cd memmy-agent +cp .env.example .env npm install - -npm run dev:desktop # Start the desktop frontend Vite server and the Electron desktop shell together -npm run build # Build Memory and all workspaces -npm run lint # lint -npm run typecheck # Type checking -npm run test # Run Memory and workspace tests +npm run build +bash scripts/dev-start.sh ``` -Developing Memory standalone: +The script installs dependencies, builds the services, and starts the development environment. Node.js `>=22` and npm are required; use `Git Bash` on Windows. -```bash -npm run memory:serve:dev -- \ - --host 127.0.0.1 --port 18960 \ - --db ~/.memmy/memory-service/memory.sqlite \ - --config ~/.memmy/config.yaml -``` + -Running `memmy-agent` from source: +## How Is Memmy Built? -```bash -cd App/memmy-agent -npm install -npm run build -node dist/main.js --help -``` +For details about the architecture, memory service, and integration methods, see the [Memmy documentation](https://memmy.bot/docs/). -Packaging: - -```bash -npm run package:mac # macOS DMG -npm run package:win:x64 # Windows x64 -``` +

+ Memmy system architecture: multiple Agents and entry points share the local Memory and Agent Runtime +

+
## Roadmap diff --git a/README.zh-CN.md b/README.zh-CN.md index ddf63cc30..627cb8bb4 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,4 +1,3 @@ -
@@ -10,134 +9,82 @@

- Docs - applenews - WeChat + Docs + Memmy 官网 + Memmy 最新版 + WeChat X

- Memmy Agent - Let every AI remember the same you. | Product Hunt + Memmy Agent - Let every AI remember the same you. | Product Hunt

- -## 让你的工作在 WorkBuddy、Claude Code 和 Codex 等 Agent 之间接着做。 + +## 让你的工作在 DeepSeek Harness、Claude Code 和 Codex 等 Agent 之间接着做。 + + [项目简介](#memmy-是什么) · [快速开始](#如何使用-memmy) · [技术实现](#memmy-如何实现的) · [路线图](#路线图) · [致谢](#致谢) · [贡献者](#贡献者)
- + [English](README.md) • **简体中文**
+ -## 🚀 直接体验 Memmy - -点击[官网](https://memmy.cn/)或者 [GitHub Release](https://github.com/MemTensor/memmy-agent/releases) 下载。 - -> [!TIP] -> 注册 Memmy 后，即可获得免费 Token，体验完整的 Memory + Agent Runtime。
-> **体验额度：**
-> 注册赠送 Agent 任务体验 Token，当前额度和使用情况以应用内显示为准。
-> 当体验额度用尽后，可切换至 BYOK 模式，使用自己的模型 API。 - -## 什么是 Memmy？ - -让你的工作在 WorkBuddy、Claude Code、Codex 和 Cursor 之间接着做。Memmy 在本地保存项目目标、决定、约束和失败尝试，并把相关内容交给下一个 Agent。 - - - - -### 跨 Agent 任务延续 - -![跨 Agent 任务延续](docs/assets/cross-agent-task-continuity-cn.gif) - -Memmy 为所有 AI Agent 提供统一的个人记忆层。 - -- **跨 Agent 共享记忆**：无论是在 Codex、Claude Code、Cursor 还是 OpenClaw 中工作，都可以继续使用相同的上下文和经验，无需重复介绍背景。 -- **MemOS 驱动的记忆引擎**：自动采集、理解并结构化你的知识、偏好和工作经验，将分散的对话和行为沉淀为可检索、可复用的长期记忆。 -- **历史上下文接入**：支持导入已有 Agent 的历史记录，将过去的对话和项目经验转化为持续生长的个人知识资产。 +## Memmy 是什么？ -### 🕸️ 本地 Agent Runtime - -Memmy 提供一套完整的本地 Agent 运行环境。 - -- **多入口统一体验**：支持桌面端、CLI/TUI 和 OpenAI 兼容 API，共享同一套 Agent、记忆和配置。 -- **持续任务协作**：从任意入口开始任务，并可在不同场景中无缝继续，不受单次会话限制。 -- **可扩展 Agent 能力**：通过 Skills 和 MCP 连接更多工具，让 Agent 从对话走向实际任务执行。 - -### 🔬 工具与生态连接 - -Memmy 可以连接你的工作环境，让 Agent 真正参与日常工作流。 - -- **连接常用工具**：支持 Telegram、Discord、微信、飞书、钉钉，以及 GitHub、Gmail、Notion、Slack、Jira 等生产力工具。 -- **开放工具生态**：支持 MCP 和自定义 Skills，扩展文件处理、Shell、Web、图像生成、自动化任务等能力。 -- **灵活模型配置**：支持按需配置推理、Embedding、记忆处理、语音和图像生成模型，兼容主流模型服务。 - -### 🔐 本地优先，数据属于你 - -Memmy 从设计上保证用户对个人数据和记忆的控制权。 - -- **Local-first 架构**：记忆、配置和应用状态默认保存在本机，数据无需上传云端。 -- **安全访问控制**：本地服务提供受控访问机制，确保只有授权来源能够调用记忆能力。 -- **真实记忆，不制造幻觉**：当记忆服务不可用时，Memmy 会明确反馈错误，而不会返回不存在的“假记忆”。 - -## 几分钟建立上下文，而不是从零开始 - -安装 Memmy 后，它可以自动扫描已有 AI Agent 的历史记录。几分钟内，你过去几个月积累的项目上下文、工作习惯和偏好会被转换为个人长期记忆，并生成个性化的「初见报告」。 - -现已支持：Cursor、Claude Code、Codex、OpenCode、OpenClaw、Hermes、WorkBuddy、Pi、qwenwork Agent。 - -查看详细支持列表 → 链接到 docs/import-agent-memory.md - -## 一套 Agent Runtime，多种使用入口 - -Memmy 不只是一个聊天界面，而是一套运行在本地的 AI Agent Runtime。 它将长期记忆、Agent 执行能力和工具连接统一在同一个运行环境中，并通过不同入口服务不同使用场景： - -| | 作用 | 核心能力 | -| -------------------- | -------------------- | ------------------------------------------- | -| 🧠 Memory Layer | 保存和管理长期上下文 | 跨 Agent 记忆、历史导入、知识沉淀、智能检索 | -| 🤖 Agent Runtime | 驱动 Agent 执行任务 | 推理、任务编排、工具调用、MCP、Skill | -| 🔌 Integration Layer | 连接外部生态 | 消息渠道、第三方工具、OpenAI 兼容 API | -| 🖥️ User Interface | 提供使用入口 | Desktop App、CLI/TUI、Web 接口 | - -### 系统架构 +

+ Remember：它记得你说过什么，自动把本机 AI 协作历史整理成结构化记忆 + Relay：工具随便换，记忆不掉线，Memmy 会带上项目背景、偏好和进度 + Act：Memmy 本身也是一个 Agent，可以整理资料、合并方案并继续未完成的任务 +

-![Memmy 系统架构](docs/assets/memmy-architecture-zh.png) +### 跨 Agent 任务延续 + + + + +
+ +
+ +### 你正在用的 Agent，大多都能接入 +**deepseek harness, openclaw, hermes, claude code, codex, cursor, workbuddy, openCode, pi...都能用!** +
+
+![cross-agent-cn.png](docs/assets/cross-agent-cn.png) -## Memmy vs Personal AI Agents -和 Hermes、OpenClaw 这类「个人 AI Agent」相比，Memmy 的差异不在于「又一个能陪你聊天/办事的助理」，而在于它是一层**跨 Agent 共享的记忆底座**——先记住你，再在此之上做通用 Agent。 +### 数据安全 +![data-security-cn.png](docs/assets/data-security-cn.png) -| 能力 | Memmy | Hermes | OpenClaw | -| ----------------------------------------------- | --------------------- | ------------- | ------------ | -| 产品定位 | 记忆底座 + 通用 Agent | 个人 AI Agent | 个人 AI 助理 | -| 本地优先、数据在本机 | ✅ | ⚠️ | ✅ | -| 跨 Agent 共享同一份记忆 | ✅ | 🚫 | 🚫 | -| 接管外部 Agent 历史（Cursor/Codex/Claude Code） | ✅ | 🚫 | 🚫 | -| 为外部 Agent 安装记忆 Skill | ✅ | 🚫 | 🚫 | -| 结构化记忆引擎（MemOS 混合检索） | ✅ | ⚠️ | ⚠️ | -| 多渠道触达（Telegram / Discord / iMessage…） | ✅ | ✅ | ✅ | -| 语音发消息 | ✅ | ⚠️ | ✅ | -| 多模型 / BYOK | ✅ | ✅ | ✅ | + -> ✅ 原生支持 ｜ ⚠️ 部分/需配置 ｜ 🚫 不支持 +## 如何使用 Memmy？ -> 对比基于各产品公开定位（截至本文档撰写时），非逐条评测；如有出入欢迎指正。 +完整安装和配置说明见 [入门指南](docs/cn/start/getting-started.mdx)。 -## 快速开始 +#### 1. 桌面端（推荐） -### 方式一：桌面端 +

+ 首次扫描 + 初见报告 +

-1. 启动 Memmy 桌面应用，选择**账号模式**或 **API Key 模式**。 -2. API Key 模式配置主模型并完成一次连接测试；可选配置 Embedding、ASR、图像生成、记忆摘要与技能进化模型。 -3. 进入主工作台发送第一条任务。 -4. 打开「工具」连接消息渠道或第三方工具；打开「记忆管理」扫描 Agent 历史来源。 +点击[官网](https://memmy.cn/)或者 [GitHub Release](https://github.com/MemTensor/memmy-agent/releases) 下载。 -> **账号模式免费额度**：登录即赠送 Agent 任务体验 Token，无需自备 API Key 即可开跑。当前额度和使用情况以应用内显示为准。用尽或到期后可切换到 API Key（BYOK）模式，用自己的额度继续。 +> [!TIP] +> 注册 Memmy 后，即可获得免费 Token，体验完整的 Memory + Agent Runtime。
+> **体验额度：**
+> 注册赠送 Agent 任务体验 Token，当前额度和使用情况以应用内显示为准。
+> 当体验额度用尽后，可切换至 BYOK 模式，使用自己的模型 API。 -### 方式二：`memmy` CLI（Agent Runtime） +#### 2. 使用 memmy CLI /TUI +![tui.png](docs/assets/tui.png) Linux x64 或 arm64（需 Node.js 22 或更高版本，并且 systemd 用户会话可用）可一行安装： @@ -158,15 +105,14 @@ systemctl --user status memmy-gateway.service 安装阶段只初始化 Memory 基础配置，不会修改 Codex、Claude Code、Cursor 等外部 Agent。需要接入时，由用户明确执行 `memmy-memory init`（接入检测到的 Agent）或 `memmy-memory init --agent ` 安装对应的 Memory Skill 及受支持的 Hook/插件。 ```bash -memmy onboard # 初始化 ~/.memmy/config.yaml 和 workspace -memmy status # 查看配置、workspace、模型、provider 状态 -memmy agent --message "你好，介绍一下当前工作区" # 单轮消息 -memmy # 不带子命令进入交互式聊天(TUI) -memmy serve # 启动 OpenAI 兼容 API (:18990) - +memmy onboard # 初始化配置和 workspace +memmy status # 检查配置、模型和 Provider +memmy agent --message "介绍一下当前工作区" # 单轮任务 +memmy # 进入交互式 TUI +memmy serve # 启动 OpenAI 兼容 API（:18990） ``` -最小 BYOK 配置（`~/.memmy/config.yaml`）： +最小 BYOK 配置位于 `~/.memmy/config.yaml`： ```yaml agents: @@ -176,95 +122,52 @@ agents: timezone: "+08:00" providers: openai: - apiKey: ${OPENAI_API_KEY} # 支持 ${ENV_NAME} 形式的环境变量引用 - + apiKey: ${OPENAI_API_KEY} ``` -### 方式三：`memmy-memory` CLI（供外部 Agent / 脚本调用记忆） + +#### 3. 使用 memmy-memory CLI + + +供 Agent、脚本和调试流程访问本地记忆服务： ```bash -memmy-memory init # 写入 Memory 配置，并按需为各 Agent 安装 Skill +memmy-memory init memmy-memory health memmy-memory search "项目里的记忆策略" memmy-memory add "这是一条需要保存的知识" memmy-memory get - -``` - -默认连接 `http://127.0.0.1:18960\`，可用 `--url`、`--token`、`--config`、`--source`、`--user-id` 指定目标服务、认证、来源与用户命名空间。 - -## 核心概念 - -- **Workspace** — Agent 工作目录，默认 `~/.memmy/workspace`，同步模板、内置技能与记忆文件。 -- **Config** — 主配置默认 `~/.memmy/config.yaml`（可用 `MEMMY_CONFIG` / `--config` 覆盖），含模型、Provider、工具、MCP、gateway、Memory、workspace 设置。 -- **Agent Runtime** — 任务执行核心：模型调用、消息循环、工具注册、MCP、会话、长任务、技能加载、自动压缩与记忆钩子。 -- **Memory Service** — 本地优先记忆底座，默认 `http://127.0.0.1:18960\`，提供会话、回合、搜索、写入、面板与分析接口；所有入口读写同一份记忆，因此任务与上下文可跨 Agent 接续。 -- **Local Backend** — 桌面本地 API 后端（Fastify + SQLite app state），负责账号、配置、集成、来源扫描、Skill 写入。 -- **Agent Source** — 从外部 Agent 收集历史上下文的适配器，每个来源有历史读取逻辑和可选的 Skill 安装目标。 - -## 从源码构建 - -### 一键启动 - -三步即可跑起来： - -```bash -git clone https://github.com/MemTensor/memmy-agent.git && cd memmy-agent -cp .env.example .env # 已预填云服务地址，开箱即用 -bash scripts/dev-start.sh # 装依赖 → 构建 → 起全套服务 ``` -`scripts/dev-start.sh` 一条命令完成：自动安装依赖、构建 Memory 与 memmy-agent、安装 `memmy` / `memmy-memory` CLI，并同时拉起 Memory、Agent API、Gateway、前端和桌面后端。启动后在桌面应用里完成账号登录或 BYOK 配置即可。 - -> `.env` 中 `MEMMY_CLOUD_SERVICE` 默认指向 `https://memmy-api.memtensor.cn`，复制即连官方云服务——无需自建后端、无需自备 API Key。Windows 请在 Git Bash 中运行。 - -### 环境要求 +默认连接 `http://127.0.0.1:18960`；可用 `--url`、`--token`、`--config`、`--source` 和 `--user-id` 指定服务与命名空间。 -- Node.js `>=22` -- npm -### 常用命令 - -在仓库根目录： +#### 4. 源码启动 ```bash +git clone https://github.com/MemTensor/memmy-agent.git +cd memmy-agent +cp .env.example .env npm install - -npm run dev:desktop # 同时启动桌面前端 Vite 和 Electron 桌面壳 -npm run build # 构建 Memory 和所有 workspace -npm run lint # lint -npm run typecheck # 类型检查 -npm run test # 跑 Memory 和 workspace 测试 - +npm run build +bash scripts/dev-start.sh ``` -Memory 单独开发： +脚本会安装依赖、构建服务并启动开发环境。需要 Node.js `>=22` 和 npm；Windows 请使用 Git Bash。 -```bash -npm run memory:serve:dev -- \ - --host 127.0.0.1 --port 18960 \ - --db ~/.memmy/memory-service/memory.sqlite \ - --config ~/.memmy/config.yaml -``` -`memmy-agent` 源码态运行： -```bash -cd App/memmy-agent -npm install -npm run build -node dist/main.js --help + -``` +## Memmy 如何实现的？ -打包： +架构、记忆服务和接入方式的详细说明见 [Memmy 文档](https://memmy.bot/docs/)。 -```bash -npm run package:mac # macOS DMG -npm run package:win:x64 # Windows x64 - -``` +

+ Memmy 系统架构：多个 Agent 和入口共享本地 Memory 与 Agent Runtime +

+
## 路线图 @@ -272,6 +175,7 @@ Memmy 做的是**个人记忆基础设施**，边界不止于 Coding Agent： - **更多记忆来源**——从 AI 对话扩展到浏览器行为、本地文档，乃至更多终端与硬件设备。 - **团队协作**——规划中的 Agent 间协作能力，让团队成员的 AI 助手在隐私保护下共享知识。 +
## 致谢 @@ -282,6 +186,7 @@ Memmy 站在一群优秀的开源项目肩上，我们对此心怀感激。 - **[nanobot](https://github.com/HKUDS/nanobot)** ——从极简原型生长为功能完备的开源 Agent 平台，它对 Agent 循环与 MCP 集成的工程实践为 Memmy 的核心设计提供了重要参考。 开源的意义在于让好的想法流动起来，我们希望 Memmy 也能成为这条河流的一部分。 +
## 贡献者 @@ -289,5 +194,5 @@ Memmy 站在一群优秀的开源项目肩上，我们对此心怀感激。

- + memmy-agent contributors diff --git a/docs/assets/agent.png b/docs/assets/agent.png new file mode 100644 index 000000000..12d16a8f1 Binary files /dev/null and b/docs/assets/agent.png differ diff --git a/docs/assets/agents/claude-code.png b/docs/assets/agents/claude-code.png new file mode 100644 index 000000000..4a2f4065d Binary files /dev/null and b/docs/assets/agents/claude-code.png differ diff --git a/docs/assets/agents/codebuddy.png b/docs/assets/agents/codebuddy.png new file mode 100644 index 000000000..ebe1773fb Binary files /dev/null and b/docs/assets/agents/codebuddy.png differ diff --git a/docs/assets/agents/codex.png b/docs/assets/agents/codex.png new file mode 100644 index 000000000..bb3b54d4d Binary files /dev/null and b/docs/assets/agents/codex.png differ diff --git a/docs/assets/agents/dsh.png b/docs/assets/agents/dsh.png new file mode 100644 index 000000000..83c355c11 Binary files /dev/null and b/docs/assets/agents/dsh.png differ diff --git a/docs/assets/agents/hermes.png b/docs/assets/agents/hermes.png new file mode 100644 index 000000000..b4110e4ea Binary files /dev/null and b/docs/assets/agents/hermes.png differ diff --git a/docs/assets/agents/openclaw.png b/docs/assets/agents/openclaw.png new file mode 100644 index 000000000..f3fafd7e9 Binary files /dev/null and b/docs/assets/agents/openclaw.png differ diff --git a/docs/assets/agents/workbuddy.png b/docs/assets/agents/workbuddy.png new file mode 100644 index 000000000..894db4219 Binary files /dev/null and b/docs/assets/agents/workbuddy.png differ diff --git a/docs/assets/cross-agent-cn.png b/docs/assets/cross-agent-cn.png new file mode 100644 index 000000000..7bf0c7a3f Binary files /dev/null and b/docs/assets/cross-agent-cn.png differ diff --git a/docs/assets/cross-agent-en.png b/docs/assets/cross-agent-en.png new file mode 100644 index 000000000..6f2447461 Binary files /dev/null and b/docs/assets/cross-agent-en.png differ diff --git a/docs/assets/cross-agent.png b/docs/assets/cross-agent.png new file mode 100644 index 000000000..5fd5c8ef4 Binary files /dev/null and b/docs/assets/cross-agent.png differ diff --git a/docs/assets/data-security-cn.png b/docs/assets/data-security-cn.png new file mode 100644 index 000000000..293ca4f72 Binary files /dev/null and b/docs/assets/data-security-cn.png differ diff --git a/docs/assets/data-security-en.png b/docs/assets/data-security-en.png new file mode 100644 index 000000000..b17d8fcd4 Binary files /dev/null and b/docs/assets/data-security-en.png differ diff --git a/docs/assets/first-report-cn.png b/docs/assets/first-report-cn.png new file mode 100644 index 000000000..7094a0169 Binary files /dev/null and b/docs/assets/first-report-cn.png differ diff --git a/docs/assets/first-report-en.png b/docs/assets/first-report-en.png new file mode 100644 index 000000000..c6336b7a5 Binary files /dev/null and b/docs/assets/first-report-en.png differ diff --git a/docs/assets/first-scan-cn.png b/docs/assets/first-scan-cn.png new file mode 100644 index 000000000..5db9e10a2 Binary files /dev/null and b/docs/assets/first-scan-cn.png differ diff --git a/docs/assets/first-scan-en.png b/docs/assets/first-scan-en.png new file mode 100644 index 000000000..21d6a6ddc Binary files /dev/null and b/docs/assets/first-scan-en.png differ diff --git a/docs/assets/react-card-cn.png b/docs/assets/react-card-cn.png new file mode 100644 index 000000000..6b9542ebd Binary files /dev/null and b/docs/assets/react-card-cn.png differ diff --git a/docs/assets/react-card-en.png b/docs/assets/react-card-en.png new file mode 100644 index 000000000..c37e95c90 Binary files /dev/null and b/docs/assets/react-card-en.png differ diff --git a/docs/assets/relay-card-cn.png b/docs/assets/relay-card-cn.png new file mode 100644 index 000000000..734655c30 Binary files /dev/null and b/docs/assets/relay-card-cn.png differ diff --git a/docs/assets/relay-card-en.png b/docs/assets/relay-card-en.png new file mode 100644 index 000000000..0721dcd1f Binary files /dev/null and b/docs/assets/relay-card-en.png differ diff --git a/docs/assets/remember-card-cn.png b/docs/assets/remember-card-cn.png new file mode 100644 index 000000000..d46bb9095 Binary files /dev/null and b/docs/assets/remember-card-cn.png differ diff --git a/docs/assets/remember-card-en.png b/docs/assets/remember-card-en.png new file mode 100644 index 000000000..e7b365bac Binary files /dev/null and b/docs/assets/remember-card-en.png differ diff --git a/docs/assets/skill-codex-en.png b/docs/assets/skill-codex-en.png new file mode 100644 index 000000000..b412f403b Binary files /dev/null and b/docs/assets/skill-codex-en.png differ diff --git a/docs/assets/skill-codx-cn.png b/docs/assets/skill-codx-cn.png new file mode 100644 index 000000000..6db578ea7 Binary files /dev/null and b/docs/assets/skill-codx-cn.png differ diff --git a/docs/assets/skill-memmy-cn.png b/docs/assets/skill-memmy-cn.png new file mode 100644 index 000000000..5d49cb93f Binary files /dev/null and b/docs/assets/skill-memmy-cn.png differ diff --git a/docs/assets/skill-memmy-en.png b/docs/assets/skill-memmy-en.png new file mode 100644 index 000000000..2180cf67f Binary files /dev/null and b/docs/assets/skill-memmy-en.png differ diff --git a/docs/assets/tui.png b/docs/assets/tui.png new file mode 100644 index 000000000..af5f8fc08 Binary files /dev/null and b/docs/assets/tui.png differ