# @byterover/cipher 中文文档

规范地址：https://npmcn.com/package/%40byterover/cipher/

版本：0\.3\.0
npm 元数据更新时间：2026-07-05T03:44:45.657Z
中文译文更新时间：2026-11-08T22:05:20.030Z
软件包许可：Elastic-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byterover/cipher
原文对照：https://npmcn.com/package/%40byterover/cipher/?lang=original

弃用说明：This package has been deprecated\. The project has evolved into byterover-cli\. See https://github\.com/campfirein/byterover-cli for the new project\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：72.6 MB，2096 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：36 个
- 首次发布：2025-07-15T10:06:59.391Z
- 最新版本发布：2025-08-28T04:16:48.421Z
- 近 30 天下载量：2639（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

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

## 安装

```sh
npm install @byterover/cipher
```

也可以使用：`pnpm add @byterover/cipher`、`yarn add @byterover/cipher`、`bun add @byterover/cipher`

## README

# 密码

![Cipher Agent Logo](https://npmcn.com/package/%40byterover/cipher/assets/cipher-logo.png)

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

[![License](https://img.shields.io/badge/License-Elastic%202.0-blue.svg)](https://npmcn.com/package/%40byterover/cipher/LICENSE) ![Beta](https://img.shields.io/badge/Status-Beta-orange.svg) [![Documentation](https://img.shields.io/badge/Docs-Documentation-green.svg)](https://docs.byterover.dev/cipher/overview) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da)](https://discord.com/invite/UMRrpNjh5W)

[![Cipher by Byterover - Open-source, shared memory for coding agents | Product Hunt](https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=1000588&theme=light&period=daily&t=1754744170741)](https://www.producthunt.com/products/byterover?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-cipher-by-byterover)

## 概览

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

由 [Byterover团队](https://byterover.dev/)

**关键特性 :**

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

## 快速启动 QQ

### 国家防范机制一揽子计划(推荐给大多数用户)

```bash
# Install globally
npm install -g @byterover/cipher

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

### 夹克

显示嵌入器设置

```bash
# 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 .`

### 从源

```bash
pnpm i && pnpm run build && npm link
```

### CLI 使用量

显示 CLI 命令

```bash
# 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](https://npmcn.com/package/%40byterover/cipher/assets/cipher_webUI.png)

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

## 配置

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

### 基本配置 QQ

显示 YAML 示例

```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', '.']
```

📖 **见 [配置指南](https://npmcn.com/package/%40byterover/cipher/docs/configuration.md)** 完整的细节.

### 环境变量

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

显示.env 模板

```bash
# ====================
# 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` 并填写您的值 :
> 
> ```bash
> cp .env.example .env
> ```

## MCP 服务器使用

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

### 快速设置

要在您的 MCP 客户端配置中使用 Cipher 作为 MCP 服务器 :

```json
{
    "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 整合指南](https://npmcn.com/package/%40byterover/cipher/docs/mcp-integration.md)** 用于完整的MCP设置和高级功能.

👉 **内建工具概览** ——将下方的下放扩展为一目了然地扫描一切. 详情见 [`docs/builtin-tools.md`](https://npmcn.com/package/%40byterover/cipher/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](https://img.youtube.com/vi/AZh9Py6g07Y/maxresdefault.jpg)](https://www.youtube.com/watch?v=AZh9Py6g07Y)

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

关于详细的配置说明,见 [CLI 编码代理指南](https://npmcn.com/package/%40byterover/cipher/examples/02-cli-coding-agents/README.md)。 。 。 .

## 文档

### 完整文档

| 专题 | 说明 |
| --- | --- |
| [配置](https://npmcn.com/package/%40byterover/cipher/docs/configuration.md) | 完整的配置指南,包括代理设置、嵌入和向量存储 |
| [LLM 供应商](https://npmcn.com/package/%40byterover/cipher/docs/llm-providers.md) | OpenAI、Anthropic、AWS、Azure、Quen、Ollama、LM工作室的详细设置 |
| [嵌入配置](https://npmcn.com/package/%40byterover/cipher/docs/embedding-configuration.md) | 嵌入提供者、倒置逻辑和故障排除 |
| [矢量存储器](https://npmcn.com/package/%40byterover/cipher/docs/vector-stores.md) | Qdrant, Milvus, 记忆向量数据库配置 |
| [聊天历史](https://npmcn.com/package/%40byterover/cipher/docs/chat-history.md) | PostgreSQL, SQLite 会话存储和管理 |
| [CLI 参考](https://npmcn.com/package/%40byterover/cipher/docs/cli-reference.md) | 完成命令行界面文档 |
| [MCP 一体化](https://npmcn.com/package/%40byterover/cipher/docs/mcp-integration.md) | 高级 MCP 服务器设置、聚合模式和 IDE 集成 |
| [工作空间内存](https://npmcn.com/package/%40byterover/cipher/docs/workspace-memory.md) | 协作发展团队意识记忆系统 |
| [实例](https://npmcn.com/package/%40byterover/cipher/docs/examples.md) | 实际世界一体化实例和使用案例 |

### 下一个步骤

详细文件请访问:

-   [快速启动指南](https://docs.byterover.dev/cipher/quickstart)
-   [配置指南](https://docs.byterover.dev/cipher/configuration)
-   [完整文档](https://docs.byterover.dev/cipher/overview)

## 捐款

我们欢迎捐款! 参考我们 [贡献指南](https://npmcn.com/package/%40byterover/cipher/CONTRIBUTING.md) 更多细节.

## 社区与支持

**密码** 是开源版本的代理内存 [字节](https://byterover.dev/) 由旁人团队建造和维护.

-   加入我们 [解析器](https://discord.com/invite/UMRrpNjh5W) 分享项目,问问题,或只是说你好!
-   如果你喜欢密码,请给我们一个"GitHub"——它帮助很大!
-   跟随 [@kevinnguyendn (英语)](https://x.com/kevinnguyendn) 十号线

## 贡献者

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

[![Contributors](https://contrib.rocks/image?repo=campfirein/cipher&max=40&columns=10)](https://github.com/campfirein/cipher/graphs/contributors)

## MseeP.ai 安全评估徽章

[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/campfirein-cipher-badge.png)](https://mseep.ai/app/campfirein-cipher)

## 恒星历史

[![Star History Chart](https://api.star-history.com/svg?repos=campfirein/cipher&type=Date&v=2)](https://star-history.com/#campfirein/cipher&Date)

## 许可证

弹性许可证2.0. 见 [自由主义](https://npmcn.com/package/%40byterover/cipher/LICENSE) 满期.

## 常见问题

### @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。作者已将其标记为弃用，新项目建议寻找替代方案。