环境变量

OpenTUI 在运行时读取环境变量。Bun 会自动加载 .env 文件,因此你可以在 shell 中或在 .env 文件中设置这些变量。

变量

变量名类型默认值说明
OTUI_TS_STYLE_WARNstringfalse启用缺失语法样式的警告
OTUI_TREE_SITTER_WORKER_PATHstring""Tree-sitter worker 的路径
XDG_CONFIG_HOMEstring""用户配置文件的基础目录
XDG_DATA_HOMEstring""用户数据文件的基础目录
OTUI_PALETTE_IDLE_TIMEOUT_MSnumber300调色板查询后无响应的毫秒数,超过后将回退
OTUI_DEBUG_FFIbooleanfalse启用 FFI 绑定的调试日志
OTUI_SHOW_STATSbooleanfalse在启动时显示调试浮层
OTUI_TRACE_FFIbooleanfalse启用 FFI 绑定的跟踪
OPENTUI_FORCE_WCWIDTHbooleanfalse使用 wcwidth 进行字符宽度计算
OPENTUI_FORCE_UNICODEbooleanfalse在终端能力中强制启用 Mode 2026 Unicode 支持
OPENTUI_GRAPHICSbooleantrue启用 Kitty 图形协议检测
OPENTUI_FORCE_NOZWJbooleanfalse使用 no_zwj 宽度计算方法(不使用 ZWJ 连接的 Unicode)
OPENTUI_LIBCstring未设置选择 Linux 原生 libc 包(glibcmusl
OPENTUI_FORCE_EXPLICIT_WIDTHstring-强制显式宽度检测(true/1false/0
OPENTUI_NOTIFICATION_PROTOCOLstringauto强制通知协议(osc9osc777osc99none
OPENTUI_NOTIFICATIONSbooleantrue设为 false 时禁用终端通知检测
OTUI_USE_CONSOLEbooleantrue为内置浮层启用全局 console.* 捕获
SHOW_CONSOLEbooleanfalse在启动时打开内置控制台浮层
OTUI_DUMP_CAPTURESbooleanfalse从退出处理程序中转储捕获的 stdout 和控制台缓存
OTUI_NO_NATIVE_RENDERbooleanfalse跳过 Zig/原生帧渲染器
OTUI_USE_ALTERNATE_SCREENboolean未设置设置后强制使用备用屏幕或主屏幕模式
OTUI_OVERRIDE_STDOUTboolean未设置设置后强制 stdout 捕获/透传路由
OTUI_DEBUGbooleanfalse捕获所有原始 stdin 输入用于调试

注意事项

  • OPENTUI_FORCE_EXPLICIT_WIDTH=false 会跳过旧终端上的 OSC 66 查询。
  • Linux 默认使用 glibc 原生包。在导入 OpenTUI 之前设置 OPENTUI_LIBC=musl,或在独立构建时将 process.env.OPENTUI_LIBC 定义为 "musl",即可使用 musl 原生包。参见独立可执行文件
  • OPENTUI_NOTIFICATION_PROTOCOL=none 禁用通知。协议覆盖仅应在终端检测无法识别受支持的通知协议时使用。
  • OPENTUI_NOTIFICATIONS=0falseoff 可禁用通知,且不会影响其他终端能力检测。
  • OTUI_PALETTE_IDLE_TIMEOUT_MS 用于限制调色板检测的等待时间,当终端报告支持 OSC 但不响应后续颜色查询时生效。
  • 使用 OTUI_USE_CONSOLE=false 可禁用全局 console.* 捕获。consoleMode 仅更改浮层面板。
  • OTUI_USE_ALTERNATE_SCREEN=false 强制使用 "main-screen"true 强制使用 "alternate-screen"。设置后会覆盖 screenMode
  • OTUI_OVERRIDE_STDOUT=true 仅在 "split-footer" 模式下捕获;false 强制透传。设置后会覆盖 externalOutputMode
  • OTUI_NO_NATIVE_RENDER 仍然会运行渲染循环。在 "split-footer" 模式下,当前输出刷新路径仍然可能发出 ANSI 光标移动和清除序列。
  • OTUI_DUMP_CAPTURES 从渲染器退出处理程序中运行。直接调用 renderer.destroy() 本身不会触发此操作。