TUI (Terminal User Interface) 资源提供 TUI 交互功能,包括提示框操作、命令执行、对话框管理等。
- append_prompt - 追加文本到 TUI 提示框
- submit_prompt - 提交 TUI 提示框中的内容
- clear_prompt - 清空 TUI 提示框
- execute_command - 执行 TUI 命令
- show_toast - 在 TUI 中显示提示消息
- open_help - 打开 TUI 帮助对话框
- open_sessions - 打开 TUI 会话列表对话框
- open_themes - 打开 TUI 主题选择对话框
- open_models - 打开 TUI 模型选择对话框
- select_session - 选择指定的会话
- publish - 发布 TUI 事件
追加文本到 TUI 提示框。
参数:
text(str) - 要追加的文本
返回值:
bool- 是否成功追加
示例:
success = client.tui.append_prompt("你好,")
success = client.tui.append_prompt("世界!")提交 TUI 提示框中的内容。
返回值:
bool- 是否成功提交
示例:
client.tui.append_prompt("帮我写一个函数")
client.tui.submit_prompt()清空 TUI 提示框。
返回值:
bool- 是否成功清空
示例:
success = client.tui.clear_prompt()执行 TUI 命令。
参数:
command(str) - 要执行的命令(例如 "agent_cycle")
返回值:
bool- 是否成功执行
示例:
success = client.tui.execute_command("agent_cycle")在 TUI 中显示提示消息。
参数:
message(str) - 提示消息内容variant(Literal["info", "success", "warning", "error"]) - 消息类型title(Optional[str]) - 消息标题(可选)duration(int) - 显示时长(毫秒),默认 5000
返回值:
bool- 是否成功显示
示例:
# 显示成功消息
client.tui.show_toast("操作成功", "success")
# 显示错误消息
client.tui.show_toast(
"操作失败",
"error",
title="错误",
duration=10000
)打开 TUI 帮助对话框。
返回值:
bool- 是否成功打开
示例:
success = client.tui.open_help()打开 TUI 会话列表对话框。
返回值:
bool- 是否成功打开
示例:
success = client.tui.open_sessions()打开 TUI 主题选择对话框。
返回值:
bool- 是否成功打开
示例:
success = client.tui.open_themes()打开 TUI 模型选择对话框。
返回值:
bool- 是否成功打开
示例:
success = client.tui.open_models()选择指定的会话。
参数:
session_id(str) - 会话 ID
返回值:
bool- 是否成功选择
示例:
success = client.tui.select_session("ses_123")发布 TUI 事件。
参数:
event(Dict[str, Any]) - 事件数据
返回值:
bool- 是否成功发布
示例:
event = {
"type": "tui.prompt.append",
"text": "Hello"
}
success = client.tui.publish(event)- 提示框操作 - 使用
append_prompt(),submit_prompt(),clear_prompt()操作提示框 - 命令执行 - 使用
execute_command()执行 TUI 命令 - 提示消息 - 使用
show_toast()显示各种类型的提示消息 - 对话框管理 - 使用
open_*()方法打开各种对话框
- Session 资源 - 会话管理
- App 资源 - 应用管理