> ## Documentation Index
> Fetch the complete documentation index at: https://langchain-docs-zh.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 自定义 OpenWiki

> 忽略 OpenWiki 的路径、维基指令、智能体指针和遥测数据

使用忽略规则、维基摘要、智能体指令指针和遥测数据来自定义 OpenWiki。

## 忽略路径

在仓库根目录创建 `.openwikiignore` 来排除文档运行中的私有、生成或无关路径。参见 [代码模式](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/code-mode.md#忽略路径) 了解语法和行为。

## 维基指令

OpenWiki 在运行期间会读取以下文件。您可以自行编辑它们，或要求 OpenWiki 在聊天中修改摘要（例如，`openwiki "Update openwiki/INSTRUCTIONS.md to focus on the public API"`）。

| 模式 | 路径 | 目的 |
| - | - | - |
| 代码 | `openwiki/INSTRUCTIONS.md` | 共享、用户编写的维基摘要，用于仓库文档范围和优先级 |
| 个人 | `~/.openwiki/INSTRUCTIONS.md` | 全局个人维基指令 |

正常 `--init` 和 `--update` 运行不会重写这些文件。

## 智能体指令文件

在每次代码运行期间，OpenWiki 在仓库根目录维护智能体指令指针：

* **`AGENTS.md`**：当缺失时创建。OpenWiki 仅重写 `<!-- OPENWIKI:START -->` … `<!-- OPENWIKI:END -->` 块，并保留您的内容其余部分不变
* **`CLAUDE.md`**：仅当文件已存在时更新。管理块导入 `@AGENTS.md`，以便 Claude Code 读取相同的指令。当 `CLAUDE.md` 缺失时，OpenWiki 不会创建 `CLAUDE.md`，并保留仅 `@AGENTS.md` 不变的文件

这些管理内容会告诉编码智能体何时咨询生成的维基以获取仓库上下文。

## 本地配置目录

代码模式和个性模式默认在 `~/.openwiki/` 下存储机器本地状态：

| 路径 | 模式 | 目的 |
| - | - | - |
| `~/.openwiki/.env` | 两者 | 提供者配置、API 密钥和连接器 OAuth 令牌 |
| `~/.openwiki/openwiki.sqlite` | 两者 | 对话检查点数据库 |
| `~/.openwiki/install-id` | 两者 | 随机安装 ID 用于匿名遥测 |
| `~/.openwiki/wiki/` | 个人 | 个人模式维基输出 |
| `~/.openwiki/INSTRUCTIONS.md` | 个人 | 个人维基摘要 |
| `~/.openwiki/onboarding.json` | 个人 | 个人入职偏好和连接器计划 |
| `~/.openwiki/connectors/` | 主要为个人 | 连接器原始数据和配置。个人源使用此路径；代码模式 LangSmith 摄入也可以在此缓存原始数据 |

代码模式的仓库工件（如生成的维基、`openwiki/.claims/`、`openwiki/INSTRUCTIONS.md` 和 `openwiki/.last-update.json` 下的声明）位于项目中，而不是 `~/.openwiki/` 下。更多详情，请参见 [代码模式](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/code-mode.md) 和 [个人模式](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/personal-mode.md)。

### 覆盖状态目录

在启动 OpenWiki 之前设置 `OPENWIKI_CONFIG_DIR` 以使用不同的可写目录，例如挂载的容器卷：

```bash theme={null}
OPENWIKI_CONFIG_DIR=/data/openwiki openwiki personal --init
```

覆盖会选择一个单独的状态目录。OpenWiki 不会移动或删除现有的 `~/.openwiki` 目录。要保留您希望保留的任何状态，请自行复制它并将变量指向专用目录，因为 OpenWiki 会限制当前用户的权限。

## 遥测

OpenWiki 默认收集匿名、聚合的使用数据，以便项目了解工具的使用情况并进行改进。

**在单个 `openwiki_run` 事件上收集**，按存储在 `~/.openwiki/install-id` 中的随机安装 ID 键控：

* 每次记录的运行：命令（`init` / `update`）和结果（`success` / `failure` / `no-op`），以及在失败时记录粗略的错误类别（不记录错误消息）。交互式聊天、`auth` 和 `ingest` 不记录
* 在设置时（仅在初始化时）：大脑模式（`code` / `personal`）、模型提供者和配置的连接器名称（不记录其内容）

**从不收集**：文件内容、仓库数据或名称、凭证、提示词、模型输出、连接器有效负载、错误消息、文件路径、URL、模型 ID、运行时长、IP 地址或个人信息。GeoIP 增强已禁用。

计划运行和 CI 运行在共享 CI 标识符下标记，不计为不同的安装。

### 选择退出

```bash theme={null}
export OPENWIKI_TELEMETRY_DISABLED=1
# or
export DO_NOT_TRACK=1
```

要永久禁用遥测收集，请将 `OPENWIKI_TELEMETRY_DISABLED=1` 添加到 `~/.openwiki/.env`。在 CI 中，在工作流环境中设置它。

要检查运行将发送的确切内容，请将 `--telemetry-file=<path>` 添加到任何运行。

## 参见

* [代码模式](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/code-mode.md)
* [个人模式](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/personal-mode.md)
* [自动更新](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/automate-updates.md)
* [模型提供者](https://langchain-docs-zh.mintlify.site/langchain/oss/openwiki/providers.md)

***

> 官方原文：[src/oss/openwiki/customize.mdx](https://github.com/langchain-ai/docs/blob/main/src/oss/openwiki/customize.mdx) · 非官方翻译，译文由 AI 生成，以英文原文为准。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.