OpenWiki CLI 命令速查
官方来源:CLI reference
OpenWiki 提供一个统一的 openwiki 命令,既能启动交互式聊天,也能执行一次性文档生成和更新。
# 当前仓库的交互式 Code modeopenwikiopenwiki "请为这个仓库生成文档"
# Personal modeopenwiki personalopenwiki personal --initopenwiki personal --update
# 显式 Code modeopenwiki code --initopenwiki code --updateopenwiki code --update --print
# 默认使用 Code mode,并指定文档语言openwiki --initopenwiki --updateopenwiki --init --language ko
# 一次性输出openwiki -p "总结你能做什么"
# 浏览或导出 Wikiopenwiki visualizeopenwiki visualize openwiki --port 4400 --no-openopenwiki visualize openwiki --export docs/openwiki-visualizer
# Coding-agent integrationsopenwiki integrations listopenwiki integrations install codexopenwiki integrations install claudeopenwiki integrations install opencodeopenwiki integrations install cursoropenwiki integrations uninstall codex
# 帮助openwiki --help| 参数 | 作用 |
|---|---|
--init |
生成初始文档;默认 Code mode;不能和 --update 一起使用 |
--update |
更新现有文档;默认 Code mode;没有 Wiki 时也可创建初始内容 |
-l, --language <locale> |
使用 BCP-47 语言生成,例如 ko、zh-CN、pt-BR |
--mode <personal|code> |
选择 Personal brain 或仓库文档 |
-p, --print |
执行一次任务,打印最终输出后退出 |
--modelId, --model-id |
指定模型 ID |
--telemetry-file=<path> |
把本次遥测 payload 另存为 JSON |
-h, --help |
打印帮助 |
TTY 中如果没有 --print,--init 和 --update 会流式显示 Agent 输出,并在成功后自动退出。
openwiki visualizeopenwiki visualize openwiki --port 4400 --no-openopenwiki visualize ~/.openwiki/wikiopenwiki visualize openwiki --export docs/openwiki-visualizer详细说明见可视化 Wiki 图谱。
Coding-agent integrations
Section titled “Coding-agent integrations”openwiki integrations list [--project [path]]openwiki integrations install <codex|claude|opencode|cursor> [--force] [--project [path]]openwiki integrations uninstall <codex|claude|opencode|cursor> [--project [path]]详细说明见接入 Coding Agent。
认证和 Connector
Section titled “认证和 Connector”# 查看支持的认证 Provider 和状态openwiki auth
# 浏览器 OAuthopenwiki auth gmailopenwiki auth notionopenwiki auth slackopenwiki auth x
# 根据已保存的环境变量重新生成 Connector 配置openwiki auth configure <provider> [--force]
# 查看 MCP Provider 的实时工具openwiki auth tools <provider>
# 执行 Connector 摄入openwiki ingest <source|source-instance|all>
# 为 Slack OAuth 启动 HTTPS 隧道openwiki ngrok start [url] [--port <port>]Personal mode 的 Cron
Section titled “Personal mode 的 Cron”macOS 上可以管理 Connector 调度:
openwiki cron listopenwiki cron pause <source|all>openwiki cron resume <source|all>openwiki cron delete <source|all>cron delete 只删除保存的调度并卸载 LaunchAgent,不删除认证信息、Connector 配置、原始数据或 Wiki。
交互式 Slash 命令
Section titled “交互式 Slash 命令”/api-key 更新当前 Provider API Key/langsmith-key 更新或清理 LangSmith 追踪凭证/provider 修改当前 Provider/model 修改当前模型/effort 设置推理强度,或用 /effort default 恢复默认值/init 从当前会话启动初始化/update 从当前会话启动更新/exit 退出程序我会怎么记这套 CLI
Section titled “我会怎么记这套 CLI”code / personal 选择知识边界init / update 选择生成还是维护auth / ingest 管理外部来源integrations 接入宿主 Coding Agentvisualize 检查知识关系cron 管理个人来源的定时刷新