Cipher 是一个开源的记忆层工具,专为编码助手设计。它通过 Model Context Protocol (MCP) 协议与多种编程工具和人工智能助手无缝整合,例如 Claude Code、Cursor 和 Windsurf。Cipher 的核心功能是存储和管理编码过程中的上下文信息,帮助开发者在复杂项目中保持连续性。它支持多种环境配置,适合个人开发者或团队使用。项目在 GitHub 上开源,允许社区贡献代码和功能改进。用户可以通过简单的命令行操作或 API 模式快速部署和使用。
功能列表
- 提供持久化记忆层,存储编程交互的上下文信息。
- 支持 MCP 协议,兼容 Claude Code、Cursor、Windsurf 等工具。
- 提供命令行界面 (CLI),支持交互模式和单次命令操作。
- 支持 API 和 MCP 服务器模式,满足不同开发需求。
- 使用环境变量和 YAML 文件进行灵活配置。
- 支持多种 AI 模型的 API 密钥,如 OpenAI、Anthropic 和 OpenRouter。
- 提供 Docker 部署选项,简化安装和运行流程。
- 允许社区贡献,支持开源协作开发。
使用帮助
安装流程
Cipher 的安装过程简单,支持全局或本地安装,并提供 Docker 部署选项。以下是详细步骤:
通过 npm 安装
- 全局安装:在终端运行以下命令,安装 Cipher 的命令行工具:
npm install -g @byterover/cipher
这会在全局环境中安装 Cipher,适合需要频繁使用的开发者。
- 本地安装:如果只在特定项目中使用,进入项目目录后运行:
npm install @byterover/cipher
通过 Git 克隆和配置
- 克隆仓库:从 GitHub 克隆 Cipher 项目到本地:
git clone https://github.com/campfirein/cipher.git cd cipher
- 复制配置文件:复制示例环境配置文件并编辑:
cp .env.example .env
使用文本编辑器打开
.env
文件,添加必要的 API 密钥,例如:OPENAI_API_KEY=your_openai_api_key ANTHROPIC_API_KEY=your_anthropic_api_key OPENROUTER_API_KEY=your_openrouter_api_key
如果使用本地 Ollama 模型,可以配置:
OLLAMA_BASE_URL=http://localhost:11434/v1
- 安装依赖:在项目目录中运行:
npm install
通过 Docker 部署
- 确保已安装 Docker 和 Docker Compose。
- 在项目目录中运行:
docker-compose up -d
这会启动 Cipher 的服务。
- 测试服务是否正常运行:
curl http://localhost:3000/health
如果返回状态正常,表示服务已启动。
使用方式
Cipher 提供多种操作模式,包括交互模式、单次命令、API 服务器模式和 MCP 服务器模式。以下是具体操作方法:
交互模式
- 在终端输入:
cipher
这会进入交互式命令行界面,开发者可以输入命令或问题,Cipher 会存储上下文并提供响应。
- 示例:输入“记录 Vite + Express 本地开发中的 CORS 错误常见原因”,Cipher 会将信息存储到记忆层,供后续查询。
单次命令
- 运行单次命令以存储特定信息:
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."
这会将指定内容直接存入记忆层。
API 服务器模式
- 启动 API 服务器:
cipher --mode api
- 使用 HTTP 请求与 Cipher 交互,例如通过
curl
或其他工具调用 API 端点。
MCP 服务器模式
- 启动 MCP 服务器以支持兼容工具:
cipher --mode mcp
- 配置 Claude Code 或 Cursor 等工具,连接到 Cipher 的 MCP 服务器地址(默认
http://localhost:3000
)。
主要功能操作
存储和检索上下文
Cipher 的核心是其双重记忆系统,能够存储编程概念和推理模式。例如,在使用 Claude Code 时,开发者每次交互的内容会自动存储到 Cipher 的记忆层。需要时,运行以下命令检索:
cipher "Retrieve context about CORS error causes"
Cipher 会返回相关上下文,帮助开发者快速恢复工作。
配置环境变量
开发者可以通过修改 .env
文件调整日志级别或其他设置,例如:
CIPHER_LOG_LEVEL=info
NODE_ENV=production
这确保 Cipher 在生产环境中稳定运行。
集成第三方工具
Cipher 通过 MCP 协议与 Claude Code、Cursor 等工具集成。配置完成后,工具会自动将交互数据发送到 Cipher 进行存储。例如,在 Claude Code 中启用 MCP 客户端,设置服务器地址为 Cipher 的 MCP 地址,数据即可实时同步。
注意事项
- 确保至少配置一个 API 密钥(
OPENAI_API_KEY
必须提供,用于嵌入)。 - Docker 部署需要稳定的网络环境,确保镜像下载顺畅。
- 社区贡献者可以参考 GitHub 上的
Contributing Guide
提交代码。
应用场景
- 个人开发者项目管理
开发者在处理复杂项目时,经常需要记录代码片段或调试信息。Cipher 提供持久化记忆层,存储调试过程中的上下文,方便随时检索。 - 团队协作开发
开发团队可以使用 Cipher 的 MCP 服务器模式,共享项目上下文。团队成员通过 Claude Code 或 Cursor 访问统一记忆层,提高协作效率。 - 学习和教学
编程初学者或导师可以使用 Cipher 记录代码学习过程中的问题和解决方案。例如,记录 CORS 错误的原因和解决方法,方便复习。 - AI 助手增强
Cipher 为 AI 编码助手提供记忆支持,增强其处理长上下文的能力。例如,Claude Code 用户可以利用 Cipher 存储多轮对话的上下文,确保 AI 助手提供更准确的建议。
QA
- Cipher 支持哪些编程工具?
Cipher 支持通过 MCP 协议与 Claude Code、Cursor、Windsurf、Gemini CLI、AWS Kiro、VS Code 和 Roo Code 等工具集成。 - 是否需要 API 密钥?
是的,至少需要一个 OpenAI API 密钥用于嵌入功能。其他 API 密钥(如 Anthropic 或 OpenRouter)可选。 - 如何调试 Cipher 服务?
运行curl http://localhost:3000/health
检查服务状态,或在.env
文件中设置CIPHER_LOG_LEVEL=debug
查看详细日志。 - Docker 部署和直接安装有什么区别?
Docker 部署适合快速启动和隔离环境,直接安装适合需要深度定制的开发者。