主题
自定义 OpenWiki
OpenWiki 的忽略路径、wiki 指令、智能体指针和遥测
使用忽略规则、wiki 简报、智能体指令指针和遥测来自定义 OpenWiki。
忽略路径
在仓库根目录创建 .openwikiignore，以从文档运行中排除私有的、生成的或不相关的路径。有关语法和行为，参见代码模式。
Wiki 指令
OpenWiki 会在运行期间读取以下文件。请自行编辑它们，或在聊天中让 OpenWiki 修改简报（例如 openwiki "Update openwiki/INSTRUCTIONS.md to focus on the public API"）。
| 模式 | 路径 | 用途 |
|---|---|---|
| Code | openwiki/INSTRUCTIONS.md | 共享的、用户编写的简报，用于界定仓库文档的范围和优先级 |
| Personal | ~/.openwiki/INSTRUCTIONS.md | 全局个人 wiki 指令 |
常规的 --init 和 --update 运行不会重写这些文件。
智能体指令文件
在每次代码运行时，OpenWiki 会在仓库根目录维护 AGENTS.md 和 CLAUDE.md：
- 如果文件不存在则创建它
- 当文件已存在时，仅重写
<!-- OPENWIKI:START -->…<!-- OPENWIKI:END -->块 - 保持其余内容不变
该块会指示编码智能体在需要仓库上下文时查阅被生成的 wiki。
本地配置目录
代码模式和个人模式默认都会将机器本地状态存储在 ~/.openwiki/ 下：
| 路径 | 模式 | 用途 |
|---|---|---|
~/.openwiki/.env | Both | 服务商配置、API 密钥和连接器 OAuth token |
~/.openwiki/openwiki.sqlite | Both | 对话检查点数据库 |
~/.openwiki/install-id | Both | 用于匿名遥测的随机安装 ID |
~/.openwiki/wiki/ | Personal | 个人模式 wiki 输出 |
~/.openwiki/INSTRUCTIONS.md | Personal | 个人 wiki 简报 |
~/.openwiki/onboarding.json | Personal | 个人引导偏好和连接器计划 |
~/.openwiki/connectors/ | Mostly personal | 连接器原始数据和配置。个人来源使用此路径；代码模式下的 LangSmith 摄取也可以在此缓存原始数据 |
代码模式的仓库产物（例如被生成的 wiki、openwiki/.claims/ 下的 Claims、openwiki/INSTRUCTIONS.md 和 openwiki/.last-update.json）位于项目中，而不是 ~/.openwiki/ 下。更多详情参见代码模式和个人模式。
覆盖状态目录
在启动 OpenWiki 之前设置 OPENWIKI_CONFIG_DIR，以使用不同的可写目录，例如挂载的容器卷：
bash
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不会被记录 - 在设置时（仅在 init 时）：大脑模式（
code/personal）、模型服务商和已配置的连接器名称（绝不包括其内容）
**绝不收集：**文件内容、仓库数据或名称、凭据、提示词、模型输出、连接器负载、错误消息、文件路径、URL、模型 ID、运行时长、IP 地址或个人信息。GeoIP 富化已禁用。
计划运行和 CI 运行会在共享的 CI 标识符下单独标记，且不会被计为不同的安装。
选择退出
bash
export OPENWIKI_TELEMETRY_DISABLED=1
# or
export DO_NOT_TRACK=1要永久禁用遥测收集，请将 OPENWIKI_TELEMETRY_DISABLED=1 添加到 ~/.openwiki/.env。在 CI 中，请在工作流环境中设置它。
要查看一次运行究竟会发送什么，请为任意运行添加 --telemetry-file=<path>。