主题
个人模式
使用 OpenWiki 从已配置的来源构建本地个人大脑 wiki。
个人模式会从已配置的来源(如本地仓库、Custom MCP、Gmail、Notion、网络搜索、Hacker News、Slack 和 X/Twitter)在 ~/.openwiki/wiki 中构建本地个人大脑 wiki。
bash
openwiki personal
openwiki personal --init
openwiki personal --update
openwiki personal --update "Refresh the wiki from configured connectors"要将个人 wiki 状态存储到 ~/.openwiki 之外的位置,请设置 OPENWIKI_CONFIG_DIR。请参阅自定义 OpenWiki。
首次运行的引导
首次设置时,你可以:
- 配置推理服务商、API 密钥和模型
- 设置 LangSmith API 密钥
- 为受支持的来源设置连接器
- 选择 wiki 模板、自定义其范围,并保存各来源的摄取说明和计划
计划是连接器来源的可选 cron,例如按固定间隔刷新 Gmail 或网络搜索。OpenWiki 会将这些 cron 表达式及相关设置详情与其他引导偏好(所选模板、已连接的来源以及各来源的摄取说明)一起存储在 ~/.openwiki/onboarding.json 中。全局个人 wiki 说明则单独保存在 ~/.openwiki/INSTRUCTIONS.md。
在 macOS 上,OpenWiki 可以将受支持的计划安装为用户 LaunchAgent,位于 ~/Library/LaunchAgents/ 下。这些作业会运行 openwiki --update --print,并将日志写入 ~/.openwiki/logs/ 下。
连接你的来源
在个人模式下,OpenWiki 会从你已经在使用的工具中摄取知识,并将其综合到 ~/.openwiki/wiki/ 下的本地 wiki 中。首次运行的引导可以设置 Custom MCP、本地 git 仓库、Notion、Gmail、X/Twitter、网络搜索、Hacker News 和 Slack。
在摄取运行期间,连接器工具会将原始数据和清单写入 ~/.openwiki/connectors/<connector>/raw/ 下,然后特定于来源的智能体运行会根据这些本地文件更新 wiki。
连接器密钥通过环境变量名引用,并存储在 ~/.openwiki/.env 中。
WARNING
连接器配置文件绝不应包含原始密钥值。
内置来源
| 来源 | 凭据 | 行为 |
|---|---|---|
custom-mcp | 默认无需任何凭据 | 连接到任何已配置的 HTTP 或 stdio MCP 服务器,且仅允许明确安全的只读工具 |
git-repo | 本地路径 | 读取已配置的本地仓库路径并写入紧凑的清单 |
x | OAuth 用户上下文凭据 | 通过 X API 获取主页时间线、用户帖子、提及、书签和列表帖子 |
notion | Notion OAuth(托管 MCP) | 通过 Notion OAuth 进行认证,而不是粘贴 Notion token |
google | Gmail OAuth | 在 openwiki auth gmail 之后通过 Gmail API 获取最近的邮件 |
web-search | TAVILY_API_KEY | 通过 LangChain 使用 Tavily |
hackernews | 无 | 公开的 Hacker News feed 和搜索 API |
slack | Slack 应用客户端凭据 + OAuth | OAuth 需要 HTTPS 回调设置;见 Slack OAuth |
你可以多次配置同一个来源。例如,添加一个用于 AI 研究的网络搜索来源,再添加一个用于 NBA 新闻的来源。OpenWiki 会将它们存储为单独的实例,例如 web-search-1 和 web-search-2。
连接来源
对于需要凭据的来源,请先认证,然后摄取。Hacker News 和 Custom MCP 等来源默认无需认证;网络搜索需要在 ~/.openwiki/.env 中设置 TAVILY_API_KEY。
Authenticate the provider
对于需要它的服务商,运行本地浏览器 OAuth 流程。OpenWiki 会将返回的 token 保存到 ~/.openwiki/.env,尽可能创建连接器配置,并为由 MCP 支持的服务商发现 MCP 工具:
bash
openwiki auth notion
openwiki auth gmail
openwiki auth x
openwiki auth slack- Slack 和 Gmail 要求在
~/.openwiki/.env中已经设置好应用客户端凭据 - Notion 对托管 MCP 使用动态客户端注册
- X 使用带 PKCE 的 OAuth 2.0
- 在
openwiki auth gmail之后,Google 连接器可以直接摄取 Gmail,无需 MCP 传输设置
高级重试辅助工具:
bash
openwiki auth configure <provider>
openwiki auth tools <provider>Ingest the source
将原始数据拉取到 ~/.openwiki/connectors/,并将更新综合到个人 wiki:
bash
openwiki ingest all
openwiki ingest web-search
openwiki ingest web-search-2在来源配置完成后,你也可以从聊天中刷新,或使用 openwiki personal --update 刷新。
Slack OAuth
Slack OAuth 可能需要 HTTPS 重定向 URL:
bash
openwiki ngrok start
# or with a fixed domain:
openwiki ngrok start https://your-domain.ngrok.appOpenWiki 会保存 OPENWIKI_HTTPS_OAUTH_REDIRECT_URI,并打印要在 Slack 中注册的回调 URL。X/Twitter 和 Gmail 认证会忽略该 HTTPS 覆盖,默认继续使用本地回调 http://127.0.0.1:53682/callback。
凭据存储
OpenWiki 将密钥存储在:
- 目录:
~/.openwiki(权限0o700) - 文件:
~/.openwiki/.env(权限0o600)
常见的连接器相关键包括 Gmail、Notion、Slack 和 X 的 OAuth token,以及用于网络搜索的 TAVILY_API_KEY。可选的 OAuth 回调设置:
OPENWIKI_OAUTH_CALLBACK_PORT:本地回调端口OPENWIKI_HTTPS_OAUTH_REDIRECT_URI:Slack HTTPS 回调 URL
关于模型服务商凭据,请参阅模型服务商。
管理计划
在 macOS 上,使用以下命令管理连接器计划:
bash
openwiki cron list
openwiki cron pause <source|all>
openwiki cron resume <source|all>
openwiki cron delete <source|all>cron delete 会从 ~/.openwiki/onboarding.json 中移除某个来源保存的计划,并卸载其 LaunchAgent。它不会移除认证、连接器配置、原始数据或 wiki 内容。