@byterover/cipher

中文文档
0.3.0发布于 2025/08/28Elastic-2.0TypeScriptESM + CJS近 30 天下载 2639

具有实时WebSocket通信、MCP集成和可复合模式的内存动力AI代理框架

此软件包已被标记为弃用

This package has been deprecated. The project has evolved into byterover-cli. See https://github.com/campfirein/byterover-cli for the new project.

中文使用文档
文档目录21 节
  1. 概览
  2. 快速启动 QQ
  3. 国家防范机制一揽子计划(推荐给大多数用户)
  4. 夹克
  5. 从源
  6. CLI 使用量
  7. 配置
  8. 基本配置 QQ
  9. 环境变量
  10. MCP 服务器使用
  11. 快速设置
  12. 教学视频: Claude 代码与 Cipher MCP
  13. 文档
  14. 完整文档
  15. 下一个步骤
  16. 捐款
  17. 社区与支持
  18. 贡献者
  19. MseeP.ai 安全评估徽章
  20. 恒星历史
  21. 许可证

密码

Cipher Agent Logo

内存动力的 AI 代理框架与 MCP 集成

License Beta Documentation Discord

概览

Cipher是专门为编码剂设计的开源内存层. 兼容 Cursor, Windsurf, Claude 桌面, Claude 代码,双子座 CLI, AWS 的 Kiro, VS 代码, Roo 代码, Trae, 和 Warp 通过MCP和编码代理,例如 木卫一 K2. (详见 实例(中文(简体) )

由 Byterover团队

关键特性 :

  • QQ MCP 与任何您想要的 IDE 集成 .
  • 自动生成的 AI 编码记忆 与您的代码库相适应 .
  • QQ 在IDEs之间无缝切换,而不失去内存和上下文.
  • 方便地分享你的Dev团队实时的编码记忆.
  • QQ 捕捉系统1(编程概念与业务逻辑与过去交互)和系统2(生成代码时对模型步骤进行推理)的双内存层.
  • 在您的 IDE 上安装零配置 .

快速启动 QQ

# Install globally
npm install -g @byterover/cipher

# Or install locally in your project
npm install @byterover/cipher

夹克

显示嵌入器设置
# Clone and setup
git clone https://github.com/campfirein/cipher.git
cd cipher

# Configure environment
cp .env.example .env
# Edit .env with your API keys

# Start with Docker
docker-compose up --build -d

# Test
curl http://localhost:3000/health

注释: 多克构建自动跳过UI构建步骤来避免ARM64与闪电相容的问题. 默认情况下UI不包含在多克图像中.

要将 UI 包含在 Docker 构建中, 请使用 : docker build --build-arg BUILD_UI=true .

从源

pnpm i && pnpm run build && npm link

CLI 使用量

显示 CLI 命令
# Interactive mode
cipher

# One-shot command
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."

# API server mode
cipher --mode api

# MCP server mode
cipher --mode mcp

# Web UI mode
cipher --mode ui

注释: 在终端/ shell 中运行 MCP 模式时, 导出所有环境变量为 Cipher 不读取 .env 文档.

QQ 提示 : CLI模式会自动延续或创建"默认"会话. 使用 /session new <session-name> 开始新的会话.

Cipher Web UI

Cepher Web UI提供了与内存能动的AI代理交互的直观界面,其特点是会话管理,工具集成,以及实时聊天能力.

配置

Cipher支持不同部署情景的多配置选项. 主配置文件位于 memAgent/cipher.yml。 。 。 .

基本配置 QQ

显示 YAML 示例
# LLM Configuration
llm:
  provider: openai # openai, anthropic, openrouter, ollama, qwen
  model: gpt-4-turbo
  apiKey: $OPENAI_API_KEY

# System Prompt
systemPrompt: 'You are a helpful AI assistant with memory capabilities.'

# MCP Servers (optional)
mcpServers:
  filesystem:
    type: stdio
    command: npx
    args: ['-y', '@modelcontextprotocol/server-filesystem', '.']

📖 见 配置指南 完整的细节.

环境变量

创建一个 .env 在工程根中包含这些必要的变量:

显示.env 模板
# ====================
# API Keys (At least one required)
# ====================
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 (Optional - defaults to in-memory)
# ====================
VECTOR_STORE_TYPE=qdrant  # qdrant, milvus, or in-memory
VECTOR_STORE_URL=https://your-cluster.qdrant.io
VECTOR_STORE_API_KEY=your-qdrant-api-key

# ====================
# Chat History (Optional - defaults to SQLite)
# ====================
CIPHER_PG_URL=postgresql://user:pass@localhost:5432/cipher_db

# ====================
# Workspace Memory (Optional)
# ====================
USE_WORKSPACE_MEMORY=true
WORKSPACE_VECTOR_STORE_COLLECTION=workspace_memory

# ====================
# AWS Bedrock (Optional)
# ====================
AWS_ACCESS_KEY_ID=your-aws-access-key
AWS_SECRET_ACCESS_KEY=your-aws-secret-key
AWS_DEFAULT_REGION=us-east-1

# ====================
# Advanced Options (Optional)
# ====================
# Logging and debugging
CIPHER_LOG_LEVEL=info  # error, warn, info, debug, silly
REDACT_SECRETS=true

# Vector store configuration
VECTOR_STORE_DIMENSION=1536
VECTOR_STORE_DISTANCE=Cosine  # Cosine, Euclidean, Dot, Manhattan
VECTOR_STORE_MAX_VECTORS=10000

# Memory search configuration
SEARCH_MEMORY_TYPE=knowledge  # knowledge, reflection, both (default: knowledge)
DISABLE_REFLECTION_MEMORY=true  # default: true

QQ 提示 : 复制 .env.example 改为 .env 并填写您的值 :

cp .env.example .env

MCP 服务器使用

Cipher可以作为MCP(模式上下文协议)服务器运行,允许与Claude Desktop,Cursor,Windsurf等与MCP兼容的客户端以及其他AI编码助理进行集成.

快速设置

要在您的 MCP 客户端配置中使用 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"
            }
        }
    }
}

📖 见 MCP 整合指南 用于完整的MCP设置和高级功能.

👉 内建工具概览 ——将下方的下放扩展为一目了然地扫描一切. 详情见 docs/builtin-tools.md 📘.

内建工具( 概览)
  • 内存
    • cipher_extract_and_operate_memory: 提取知识并在一步内应用 ADD/UPDATE/DELETE
    • cipher_memory_search: 语义搜索存储的知识
    • cipher_store_reasoning_memory: 存储高质量的推理痕迹
  • 理由(参考)
    • cipher_extract_reasoning_steps (内部):提取结构化推理步骤
    • cipher_evaluate_reasoning (内部):评估推理质量并提出改进建议
    • cipher_search_reasoning_patterns: 搜索图案的反射内存
  • 工作空间内存( 团队)
    • cipher_workspace_search: 搜索团队/项目工作空间内存
    • cipher_workspace_store: 团队/项目信号的背景捕捉
  • 知识图
    • cipher_add_node, (中文(简体) ), cipher_update_node, (中文(简体) ), cipher_delete_node, (中文(简体) ), cipher_add_edge
    • cipher_search_graph, (中文(简体) ), cipher_enhanced_search, (中文(简体) ), cipher_get_neighbors
    • cipher_extract_entities, (中文(简体) ), cipher_query_graph, (中文(简体) ), cipher_relationship_manager
  • 系统
    • cipher_bash: 执行击打命令(一次性或持续)

教学视频: Claude 代码与 Cipher MCP

关注我们如何通过MCP将 Cipher 与 Claude Code 整合的综合辅导

Cipher + Claude Code Tutorial

点击上面的图像在YouTube上观看教程.

关于详细的配置说明,见 CLI 编码代理指南。 。 。 .

文档

完整文档

专题说明
配置完整的配置指南,包括代理设置、嵌入和向量存储
LLM 供应商OpenAI、Anthropic、AWS、Azure、Quen、Ollama、LM工作室的详细设置
嵌入配置嵌入提供者、倒置逻辑和故障排除
矢量存储器Qdrant, Milvus, 记忆向量数据库配置
聊天历史PostgreSQL, SQLite 会话存储和管理
CLI 参考完成命令行界面文档
MCP 一体化高级 MCP 服务器设置、聚合模式和 IDE 集成
工作空间内存协作发展团队意识记忆系统
实例实际世界一体化实例和使用案例

下一个步骤

详细文件请访问:

捐款

我们欢迎捐款! 参考我们 贡献指南 更多细节.

社区与支持

密码 是开源版本的代理内存 字节 由旁人团队建造和维护.

  • 加入我们 解析器 分享项目,问问题,或只是说你好!
  • 如果你喜欢密码,请给我们一个"GitHub"——它帮助很大!
  • 跟随 @kevinnguyendn (英语) 十号线

贡献者

多亏了这些神奇的人 为密码作出贡献!

Contributors

MseeP.ai 安全评估徽章

MseeP.ai Security Assessment Badge

恒星历史

Star History Chart

许可证

弹性许可证2.0. 见 自由主义 满期.

版本与发布记录

@byterover/cipher 共发布 6 个版本,首次发布于 2025/07/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.0latest2025/08/281.2 年前
0.2.22025/08/081.3 年前
0.2.12025/08/061.3 年前
0.2.02025/07/301.3 年前
0.1.12025/07/151.3 年前
0.1.02025/07/151.3 年前

关于 @byterover/cipher 的常见问题

@byterover/cipher 是什么?

具有实时WebSocket通信、MCP集成和可复合模式的内存动力AI代理框架注意:该包已被作者标记为弃用——This package has been deprecated. The project has evolved into byterover-cli. See https://github.com/campfirein/byterover-cli for the new project.

如何安装 @byterover/cipher?

在项目目录运行 npm install @byterover/cipher,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cipher,可以用 npx cipher 直接运行。

@byterover/cipher 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@byterover/cipher 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@byterover/cipher 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@byterover/cipher 可以商用吗?

@byterover/cipher 使用 Elastic-2.0 许可。声明的许可为 Elastic-2.0,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@byterover/cipher 的下载量有多少?

根据 npm 官方下载统计,@byterover/cipher 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,639 次,日均约 88 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@byterover/cipher 还在维护吗?

最新版本 0.3.0 发布于 2025/08/28(1.2 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2025/07/15。作者已将其标记为弃用,新项目建议寻找替代方案。