Skip to main content

​
TUI（终端界面）

​
快速开始

  1. 启动 Gateway。
openclaw gateway
  1. 打开 TUI。
openclaw tui
  1. 输入消息并按回车。
远程 Gateway： 
openclaw tui --url ws://<host>:<port> --token <gateway-token>
如果您的 Gateway 使用密码认证，请加上 --password。

​
您看到的内容

  • 头部：连接 URL、当前代理、当前会话。
  • 聊天记录：用户消息、助理回复、系统通知、工具卡片。
  • 状态行：连接/运行状态（连接中、运行中、流式传输、空闲、错误）。
  • 页脚：连接状态 + 代理 + 会话 + 模型 + 思考/详细/推理 + 令牌计数 + 发送。
  • 输入框：带自动补全的文本编辑器。

​
概念模型：代理 + 会话

  • 代理是唯一的标识符（如 main、research）。Gateway 会展示代理列表。
  • 会话属于当前代理。
  • 会话键储存形式为 agent:<agentId>:<sessionKey>。
    • 如果输入 /session main，TUI 会扩展为 agent:<currentAgent>:main。
    • 如果输入 /session agent:other:main，则显式切换到指定代理会话。
  • 会话范围：
    • per-sender（默认）：每个代理拥有多个会话。
    • global：TUI 总是使用 global 会话（选择器可能为空）。
  • 当前代理和会话始终显示在页脚。

​
发送与发送状态

  • 消息发送到 Gateway；默认不向提供者发出交付。
  • 开启交付：
    • 输入 /deliver on
    • 或在设置面板切换
    • 或启动时加参数 openclaw tui --deliver

​
选择器与覆盖层

  • 模型选择器：列出可用模型并设置会话覆盖。
  • 代理选择器：选择不同代理。
  • 会话选择器：仅显示当前代理的会话。
  • 设置：切换交付、工具输出展开、思考可见性。

​
键盘快捷键

  • 回车：发送消息
  • Esc：中止当前运行
  • Ctrl+C：清空输入（连按两次退出）
  • Ctrl+D：退出
  • Ctrl+L：模型选择器
  • Ctrl+G：代理选择器
  • Ctrl+P：会话选择器
  • Ctrl+O：切换工具输出展开
  • Ctrl+T：切换思考可见性（重新加载历史）

​
斜杠命令

核心命令：
  • /help
  • /status
  • /agent <id>（或 /agents）
  • /session <key>（或 /sessions）
  • /model <provider/model>（或 /models）
会话控制：
  • /think <off|minimal|low|medium|high>
  • /verbose <on|full|off>
  • /reasoning <on|off|stream>
  • /usage <off|tokens|full>
  • /elevated <on|off|ask|full>（别名：/elev）
  • /activation <mention|always>
  • /deliver <on|off>
会话生命周期：
  • /new 或 /reset（重置会话）
  • /abort（中止当前运行）
  • /settings
  • /exit
其他 Gateway 斜杠命令（例如 /context）会转发给 Gateway 并以系统输出显示。详见斜杠命令。

​
本地 shell 命令

  • 行首加 ! 可运行本地 shell 命令（在 TUI 主机上）。
  • TUI 每个会话提示一次是否允许本地执行，拒绝则本会话内禁用 !。
  • 命令在 TUI 工作目录的全新非交互 shell 中运行（无持久的 cd 或环境）。
  • 本地 shell 命令环境变量包含 OPENCLAW_SHELL=tui-local。
  • 仅 ! 会被当作普通消息发送；前导空格不触发本地执行。

​
工具输出

  • 工具调用以卡片形式展示参数和结果。
  • Ctrl+O 切换收起/展开视图。
  • 工具运行时，内容会流式更新在同一卡片中。

​
历史与流式

  • 连接时加载最新历史（默认 200 条消息）。
  • 流式响应实时更新，直到完成。
  • TUI 会监听代理工具事件，呈现更丰富的工具卡片。

​
连接细节

  • TUI 以 mode: "tui" 向 Gateway 注册。
  • 重连时显示系统消息；事件间断会在日志中体现。

​
选项

  • --url <url>：Gateway WebSocket URL（默认配置或 ws://127.0.0.1:<port>）
  • --token <token>：Gateway 令牌（如果需要）
  • --password <password>：Gateway 密码（如果需要）
  • --session <key>：会话键（默认 main，范围为 global 时为 global）
  • --deliver：将助理回复交付给提供者（默认关闭）
  • --thinking <level>：发送时覆盖思考等级
  • --timeout-ms <ms>：代理超时（毫秒），默认 agents.defaults.timeoutSeconds
注意：设置了 --url 时，TUI 不会回落使用配置或环境凭据。请显式传入 --token 或 --password。缺少凭据会导致错误。

​
故障排查

发送消息后无输出：
  • 在 TUI 中运行 /status，确认 Gateway 已连接且处于空闲或忙碌状态。
  • 检查 Gateway 日志：openclaw logs --follow。
  • 确认代理可运行：openclaw status 和 openclaw models status。
  • 如期望聊天频道收到消息，需启用交付（/deliver on 或 --deliver）。
  • --history-limit <n>：加载的历史条目数（默认 200）

​
连接故障排查

  • disconnected：确保 Gateway 正在运行且 --url/--token/--password 设置正确。
  • 选择器无代理：检查 openclaw agents list 与路由配置。
  • 会话选择器为空：可能处于全局范围或尚无会话。