Cipher

Cipher 是一个基于 Model Context Protocol (MCP) 的开源记忆层框架，专为 AI 编程助手设计。它通过与主流 IDE（如 Claude Desktop、Cursor、Windsurf）集成，为 AI 提供持久的记忆能力，使其能够自动捕获和检索编程概念、业务逻辑和交互历史，从而提升编码效率和协作性。

核心功能

Cipher 提供了多种核心功能，以增强 AI 编程助手的上下文感知和记忆能力：

• MCP 协议集成：通过标准的 Model Context Protocol 与主流 IDE 无缝集成，支持 Claude Desktop、Cursor、Windsurf 等。
• 双重记忆层：System 1 记忆编程概念和业务逻辑，System 2 记忆模型推理步骤，提供完整的上下文理解。
• 工作区记忆共享：支持团队实时共享编程记忆，促进知识传承和协作开发。
• 知识图谱：构建代码实体关系图谱，实现语义搜索和智能推理。
• 多模型支持：支持 OpenAI、Anthropic、Gemini、Qwen 等多种 LLM 提供商。

安装方法

Cipher 提供了多种安装方式，包括通过 npm 全局安装、本地安装、Docker 安装以及从源代码构建。

# 全局安装
npm install -g @byterover/cipher

# 本地安装
npm install @byterover/cipher

# Docker 安装
# 克隆并设置
git clone https://github.com/campfirein/cipher.git
cd cipher

cp .env.example .env
# 使用你的 API 密钥编辑 .env

docker-compose up --build -d

curl http://localhost:3000/health

如果需要在 Docker 构建中包含 UI，请使用以下命令：

docker build --build-arg BUILD_UI=true .

从源代码安装：

pnpm i && pnpm run build && npm link

使用方法

Cipher 提供了多种运行模式，包括 CLI 模式、API 模式和 MCP 模式。

# 交互模式
cipher

# 一次性命令
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."

# API 服务器模式
cipher --mode api

# MCP 服务器模式
cipher --mode mcp

# Web UI 模式
cipher --mode ui

在使用 MCP 模式时，请确保导出所有环境变量，因为 Cipher 不会从 `.env` 文件中读取。

配置说明

Cipher 的配置主要通过 `.env` 文件进行，包含 API 密钥、向量存储配置、聊天历史记录设置等。

# API 密钥
OPENAI_API_KEY=sk-your-openai-api-key
ANTHROPIC_API_KEY=sk-ant-your-anthropic-key
GEMINI_API_KEY=your-gemini-api-key
QWEN_API_KEY=your-qwen-api-key

# 向量存储
VECTOR_STORE_TYPE=qdrant
VECTOR_STORE_URL=https://your-cluster.qdrant.io
VECTOR_STORE_API_KEY=your-qdrant-api-key

# 聊天历史记录
CIPHER_PG_URL=postgresql://user:pass@localhost:5432/cipher_db

# 工作区记忆
USE_WORKSPACE_MEMORY=true
WORKSPACE_VECTOR_STORE_COLLECTION=workspace_memory

完整的配置指南请参考项目中的 configuration.md 文件。

使用场景

Cipher 适用于多种开发场景，包括：

• 新成员加入项目时，快速获取项目架构决策和技术选型历史。
• 记录常见错误及其解决方案，当类似问题再次出现时快速提供解答。
• 记录代码审查中的最佳实践和常见问题，帮助保持代码质量一致性。
• 团队协作开发中，通过共享记忆提升协作效率。

使用示例

以下是几个 Cipher 的使用示例：

# 添加内容到记忆库
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."

# 启动 API 服务器
cipher --mode api

# 启动 MCP 服务器
cipher --mode mcp

在 IDE 中配置 Cipher 作为 MCP 服务器的示例：

{
    "mcpServers": {
        "cipher": {
            "type": "stdio",
            "command": "cipher",
            "args": ["--mode", "mcp"],
            "env": {
                "MCP_SERVER_MODE": "aggregator",
                "OPENAI_API_KEY": "your_openai_api_key",
                "ANTHROPIC_API_KEY": "your_anthropic_api_key"
            }
        }
    }
}

内置工具

Cipher 提供了丰富的内置工具，包括：

• 记忆管理：提取知识、执行添加/更新/删除操作、语义搜索。
• 推理管理：提取推理步骤、评估推理质量、搜索推理模式。
• 工作区记忆：搜索团队/项目记忆、后台捕获信号。
• 知识图谱：添加/更新/删除节点和边、搜索图谱、查询关系。
• 系统工具：执行 bash 命令。

完整的工具列表和使用方法请参考项目中的 builtin-tools.md 文件。

Cipher 通过提供持久的记忆能力，帮助 AI 编程助手更好地理解代码上下文和项目历史，从而提升编码效率和协作性。