命令参考

OpenWiki 命令行用法、标志和连接器子命令

OpenWiki 以单个 openwiki 二进制文件的形式提供，用于交互式聊天和一次性文档运行。有关安装和首次使用，参见快速入门。

核心命令

# Interactive chat in code mode (current repository)
openwiki
openwiki "Please generate documentation for this repository"

# Personal mode
openwiki personal
openwiki personal --init
openwiki personal --update

# Explicit code mode
openwiki code --init
openwiki code --update
openwiki code --update --print

# Defaults to code mode and specify a language
openwiki --init
openwiki --update
openwiki --init --language ko

# One-shot print mode
openwiki -p "Summarize what you can do"

# Explore the wiki locally or export a static visualizer
openwiki visualize
openwiki visualize openwiki --port 4400 --no-open
openwiki visualize openwiki --export docs/openwiki-visualizer

# Coding-agent integrations
openwiki integrations list
openwiki integrations install codex
openwiki integrations install claude
openwiki integrations install opencode
openwiki integrations install cursor
openwiki integrations uninstall codex

# Help
openwiki --help

常用标志

标志	描述
--init	生成初始文档。默认为代码模式。重新运行会从零开始重新生成仓库 wiki，同时保留 openwiki/INSTRUCTIONS.md。在没有 --print 的 TTY 中，会流式输出智能体输出并在成功时自动退出。--init 和 --update 不能组合使用。
--update	更新现有文档。默认为代码模式。在没有 --print 的 TTY 中，会流式输出智能体输出并在成功时自动退出。--init 和 --update 不能组合使用。
-l, --language <locale>	以给定的 BCP-47 语言环境生成 wiki 文档，例如 ko、zh-CN 或 pt-BR。无法识别的值会被拒绝。
--mode <personal|code>	选择个人大脑或仓库文档。
-p, --print	运行一次，打印最终的助手输出，然后退出。提供一个消息或命令。没有 --print 的交互式聊天会保持打开以进行后续跟进。
--modelId / --model-id	为本次运行选择一个模型 ID。
--telemetry-file=<path>	还会将本次运行的遥测负载写入本地 JSON 文件。
-h, --help	打印用法。

可视化

你可以将被生成的 wiki 可视化为交互式节点图和实时 Markdown 阅读器，或导出静态站点用于托管：

openwiki visualize
openwiki visualize openwiki --port 4400 --no-open
openwiki visualize openwiki --export docs/openwiki-visualizer
openwiki visualize ~/.openwiki/wiki

有关详细信息，参见可视化你的 wiki。

编码智能体集成

将 OpenWiki 安装到宿主编码智能体中，这样宿主的模型和仓库工具驱动生成，而 OpenWiki 负责持久化的页面任务生命周期：

openwiki integrations list [--project [path]]
openwiki integrations install <codex|claude|opencode|cursor> [--force] [--project [path]]
openwiki integrations uninstall <codex|claude|opencode|cursor> [--project [path]]

有关详细信息，参见编码智能体集成。

身份认证与连接器

# List supported auth providers and status
openwiki auth

# Browser OAuth; save tokens to ~/.openwiki/.env and create connector config when possible
openwiki auth gmail
openwiki auth notion
openwiki auth slack
openwiki auth x

# Regenerate connector config from saved auth env vars
openwiki auth configure <provider> [--force]

# List live MCP tools for MCP-backed providers
openwiki auth tools <provider>

# Run source-specific connector ingestion
openwiki ingest <source|source-instance|all>

# HTTPS tunnel for Slack OAuth; saves OPENWIKI_HTTPS_OAUTH_REDIRECT_URI
openwiki ngrok start [url] [--port <port>]

Cron（macOS）

为个人模式来源管理可选的连接器计划。在 macOS 上，OpenWiki 可以将计划安装为用户 LaunchAgent，定期刷新某个来源（例如 Gmail 或网络搜索）。使用以下命令列出、暂停、恢复或删除它们：

openwiki cron list
openwiki cron pause <source|all>
openwiki cron resume <source|all>
openwiki cron delete <source|all>

cron delete 会移除已保存的计划并卸载其 LaunchAgent。它不会移除身份认证、连接器配置、原始数据或 wiki 内容。

斜杠命令（交互式）

在交互式聊天模式下，你可以使用以下命令：

• /api-key：更新当前服务商 API 密钥（掩码输入）
• /langsmith-key：更新或清除 LangSmith 追踪凭据（掩码输入）
• /provider 和 /model：更改会话的服务商或模型（会持久化到 ~/.openwiki/.env）
• /effort：为受支持的 OpenAI GPT-5.6 和 NVIDIA NIM 模型设置推理强度，或使用 /effort default 恢复服务商默认值
• /init 和 /update：从会话中启动 init 或 update
• /exit：退出应用

另请参阅

• 编码智能体集成
• 个人模式
• 模型服务商
• 自动化更新

---