pi-open-tui 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.zh-CN.md CHANGED
@@ -1,197 +1,237 @@
1
- # pi-open-tui
2
-
3
- [![omp 状态](https://omppackages.com/badge/pi-open-tui.svg)](https://omppackages.com/packages/pi-open-tui)
4
-
5
- [English](./README.md) | **简体中文**
6
-
7
- 一个为 [Pi](https://pi.dev) 编程代理打造的终端界面扩展,将 pi-haiku、pi-claude-code-tui 与 pi-zentui 的优秀设计整合为统一、可配置的使用体验。
8
-
9
- ![pi-open-tui 预览](https://raw.githubusercontent.com/OldSuns/pi-open-tui/main/assets/preview_dashboard_1.png)
10
-
11
- ## 功能亮点
12
-
13
- - **Pi 顶栏**:显示模型、思考等级、当前目录和常用斜杠命令提示
14
- - **自适应底栏**:集中展示 Git 状态、运行环境、上下文用量、Token、费用和扩展状态
15
- - **带边框的编辑器**:支持块状、竖线和下划线三种光标样式
16
- - **项目环境感知**:识别 50 多种运行环境,并展示 ahead/behind、已暂存、已修改、未跟踪、stash 和 detached HEAD 等 Git 状态
17
- - **单轮遥测**:展示 TPS、首 Token 延迟(TTFT)、耗时、停顿、Token 数量和模型标价速率
18
- - **思考预览**:模型工作时,在 Pi 隐藏思考块的 `Thinking...` 位置显示实时字幕,展示推理内容的末尾片段
19
- - **交互式设置**:通过 `/open-tui` 配置,并支持英文和简体中文界面
20
-
21
- ## 环境要求
22
-
23
- - Pi 1.2 或更高版本
24
- - 支持 UTF-8 和彩色输出的终端
25
- - 使用完整图标集时需要 [Nerd Font](https://www.nerdfonts.com/font-downloads)(可选;内置可移植 Unicode 图标)
26
-
27
- ## 安装
28
-
29
- 安装扩展:
30
-
31
- ```bash
32
- pi install npm:pi-open-tui
33
- ```
34
-
35
- 也可以只在当前会话中试用:
36
-
37
- ```bash
38
- pi -e npm:pi-open-tui
39
- ```
40
-
41
- ## 字体与图标
42
-
43
- 可从 [Nerd Fonts 官方下载页](https://www.nerdfonts.com/font-downloads)或 [GitHub 最新版本](https://github.com/ryanoasis/nerd-fonts/releases/latest)下载任意已修补字体。安装后,请在终端配置中选择该字体,并重启终端。
44
-
45
- 默认的 `auto` 模式检查终端环境,而不是已安装的字体文件。在支持 UTF-8 的交互式 TTY 中,它会使用 Nerd Font 图标,即使 Pi 运行在 runner 或子 shell 中。如果图标显示为方框、乱码或错误符号,请打开 `/open-tui`,在**外观**页选择合适的模式:
46
-
47
- - `nerd`:终端已配置 Nerd Font 时,强制使用 Nerd Font 图标
48
- - `unicode`:可移植 Unicode 图标(文件夹、分支、笔记本电脑、灯泡、插头、沙漏等),无需修补字体;emoji 字形通过终端的 emoji 回退渲染
49
- - `ascii`:使用纯文本图标,无需安装修补字体
50
- - `auto`:在支持 UTF-8 的交互式 TTY 中使用 Nerd Font 图标;SSH 会话使用可移植 Unicode 图标(字体由客户端终端决定,通常没有 Nerd Font);非交互式输出、`TERM=dumb` 或明确配置为非 UTF-8 的 locale 使用 ASCII
51
-
52
- 如果已经安装字体,但 `auto` 仍选择 ASCII,请手动切换为 `nerd`。使用 VS Code、Windows Terminal 等应用时,只在操作系统中安装字体还不够,还需要在对应的终端配置中选中该字体。如果 SSH 客户端终端确实安装了 Nerd Font 并希望在 SSH 下使用完整图标,请将模式显式设为 `nerd`。
53
-
54
- 如果较宽的 Nerd Font 图标占用了图标与文字之间的间隔(例如在 Kitty 中),可开启 `footerSegments.nerdIconSpacing`(`/open-tui` 中的 **底栏 → Nerd 图标后额外留空**)。开启后底栏会在 Nerd Font 图标后额外预留一格空白,包括运行环境图标,常规底栏和内嵌底栏的宽度计算都包含这格留白;Unicode/ASCII 图标与紧凑的 Git 状态标记不受影响。Kitty 用户也可以在 `kitty.conf` 中设置 `narrow_symbols U+E000-U+F8FF 1`。
55
-
56
- ## 配置
57
-
58
- 运行 `/open-tui` 打开设置窗口,其中包含**常规**、**外观**、**底栏**和**遥测**四个页面。设置保存在 `~/.pi/agent/open-tui.json`:
59
-
60
- ```json
61
- {
62
- "enabled": true,
63
- "header": true,
64
- "inlineFooter": false,
65
- "settingsLanguage": "zh",
66
- "cursorStyle": "block",
67
- "icons": {
68
- "mode": "auto"
69
- },
70
- "footerSegments": {
71
- "cwd": true,
72
- "hostname": false,
73
- "sessionName": false,
74
- "gitBranch": true,
75
- "gitStatus": true,
76
- "gitCommit": false,
77
- "runtime": true,
78
- "context": true,
79
- "tokens": true,
80
- "cost": true,
81
- "liveTps": true,
82
- "extensionStatuses": true,
83
- "capitalizeProviderName": true,
84
- "nerdIconSpacing": false
85
- },
86
- "telemetry": {
87
- "enabled": true,
88
- "tps": true,
89
- "ttft": true,
90
- "duration": true,
91
- "tokens": true,
92
- "stalls": true,
93
- "cost": true
94
- },
95
- "thinkingPeek": {
96
- "lines": 1
97
- },
98
- "toolView": {
99
- "mode": "native"
100
- }
101
- }
102
- ```
103
-
104
- 主要选项:
105
-
106
- | 选项 | 可选值 | 说明 |
107
- | --- | --- | --- |
108
- | `settingsLanguage` | `en`、`zh` | 切换 `/open-tui` 设置界面的语言 |
109
- | `header` | `true`、`false` | 决定是否用 open-tui 顶部信息栏覆盖 Pi 的 Header;设为 `false` 时把顶部栏位置留给 Pi 或其他扩展 |
110
- | `inlineFooter` | `true`、`false` | 将两条主要 Footer 信息行移入编辑器上下边框以节省垂直空间,默认关闭;扩展状态行仍显示在编辑器外 |
111
- | `cursorStyle` | `block`、`bar`、`underline` | `bar` 和 `underline` 需要终端支持光标形状转义序列 |
112
- | `icons.mode` | `auto`、`nerd`、`unicode`、`ascii` | 控制底栏和遥测通知使用的图标 |
113
- | `footerSegments` | 布尔开关 | 分别控制底栏中的各项数据 |
114
- | `footerSegments.capitalizeProviderName` | 布尔开关 | 将底栏中提供商名称的首字母大写;设为 `false` 时保留原始大小写 |
115
- | `footerSegments.nerdIconSpacing` | 布尔开关 | 在底栏 Nerd Font 图标后额外留一格空白;默认 `false` |
116
- | `telemetry` | 布尔开关 | 控制遥测总开关和各项指标 |
117
- | `thinkingPeek.lines` | `0`、`1`、`2` | 关闭、单行或双行思考预览 |
118
- | `toolView.mode` | `native`、`compact` | 内置工具调用显示为 Pi 原生卡片,或紧凑的两行摘要;默认 `native`。只对切换后新建的行生效 |
119
-
120
- `sessionName` 仅在会话有名称时显示;`hostname` 会显示主机名的短名称(主机名的第一个标签,例如从 `mba.example.com` 显示为 `mba`),并使用服务器图标;处于分离 HEAD(detached HEAD)状态时,`gitBranch` 会显示 `HEAD` 和短提交哈希,`gitCommit` 会在其后追加指向该提交的标签,且仅在开启 `gitBranch` 时生效;关闭 `extensionStatuses` 会隐藏整行扩展状态,其中也包括 MCP 状态。每条状态会保留其扩展通过 `ctx.ui.theme.fg()` 设置的颜色;未设置颜色的状态使用 muted 主题色显示。
121
-
122
- 开启 `inlineFooter` 后,两条常规 Footer 信息行会移入编辑器边框,从而节省垂直空间。顶部边框左侧显示 Git 分支,右侧信息组以当前目录开头;开启 `sessionName` 时,会话标题也会显示在左侧。Header 和扩展状态行保持独立显示;终端较窄时优先截断低优先级 Footer 数据,保留右侧统计信息和边框角。
123
-
124
- ## 单轮遥测
125
-
126
- 每次 Agent 完整运行结束后,pi-open-tui 会显示一条临时结果,并将其中的多个工具调用轮次合并统计:
127
-
128
- ```text
129
- > TPS 42.5 tok/s | ~ TTFT 1.2s | + 29.7s | ↑ 567 | ↓ 1.2k | ! stall 1x / 4.3s | $ $3.60/M
130
- ```
131
-
132
- TPS 的计算方式是:将本次运行中服务商报告的全部 Assistant 输出 Token,除以各个生成轮次的总耗时。计时范围从 `turn_start` 到 Assistant 的 `message_end`,包含 TTFT、隐藏推理、缓冲和停顿,但不包含轮次之间的工具执行时间。没有输出 Token 或无法测得生成时间时,会显示 `TPS —`。
133
-
134
- 回复流式输出时,工作计时器还会显示当前的估算速度,例如 `working 12.3s · ~54 tok/s`。`~` 表示估算值:它是最近 2 秒内流式输出的正文、思考内容和工具调用参数的速率,按拉丁文本和代码约 4 个字符 1 个 Token、中日韩字符每字 1 个 Token 估算。停顿时数值会逐渐降向零;工具执行期间和消息之间以暗色保留上一个值。由**底栏 → 实时 TPS**(`footerSegments.liveTps`)控制,与遥测通知的开关互不影响。运行结束后不再显示,以上面的精确 TPS 为准。
135
-
136
- `$ / M` 表示根据 `usage.cost.total` 得到的模型标价速率,不是底栏中的会话累计费用。所有遥测字段都可以在**遥测**页单独开关。
137
-
138
- ## 思考预览
139
-
140
- 开启 Pi 的 **Hide thinking** 后,任务运行期间 pi-open-tui 会在原生隐藏思考块的 `Thinking...` 位置显示紧凑的实时字幕。`/open-tui` 中提供**关闭、单行、双行**三种模式:
141
-
142
- - 模型推理时,思考内容的末尾片段会随 spinner 滚动(`~ think ⠋ …`);
143
- - 开始输出正文时定格为对勾(`~ think ✓`);
144
- - 双行模式中,上一条和最新一条思考内容使用相同的文字缩进;如果最新一行超出宽度,则两行随新 Token 持续显示它的最新末尾片段,不再保留上一条;
145
- - 任务结束后恢复原生 `Thinking...` 标签。
146
-
147
- ```text
148
- ~ think ⠋ 上一条思考
149
- 最新一条思考
150
- ```
151
-
152
- 该字幕仅在模型真正输出推理内容后出现,非推理模型不会显示。可见性由 Pi 自身的 Hide thinking 开关控制,切换后立即生效。每一行都按*显示宽度*截断(全角字符计 2 列),因此包含中文的思考文本也不会溢出终端。可在 `/open-tui` 的**常规 → 思考预览**中切换,或直接修改 `open-tui.json` 中的 `thinkingPeek.lines`。
153
-
154
- ## 工具视图
155
-
156
- 将**常规 → 工具视图**设为**紧凑**(`toolView.mode: "compact"`)后,Pi 内置工具(`read`、`bash`、`powershell`、`edit`、`write`、`grep`、`find`、`ls`)显示为一行调用加一行摘要:
157
-
158
- ```text
159
- ● Read(extensions/open-tui/footer.ts:1-120)
160
- └ 120 lines
161
- ● Edit(extensions/open-tui/footer.ts)
162
- └ +2 −1
163
- ● Bash(npm test)
164
- └ Done · 131 lines · 6.4s
165
- ```
166
-
167
- - Shell 命令运行中会显示最新 3 行输出和已用时间。
168
- - 圆点运行中为黄色、完成为绿色、失败为红色;失败的调用同样保持紧凑行,并显示红色摘要;Shell 命令的摘要末尾带上最后一行输出(如 `Exited with code 1 · 12 lines · 1.2s · FAIL tests/a.test.ts`),按 Ctrl+O 查看完整输出。
169
- - 点击某行只展开这一行为 Pi 原生卡片,`Ctrl+O` 展开全部行;完整输出、diff 和截断提示保持不变。
170
- - 只改变显示:工具、参数、结果以及模型看到的内容都不受影响,第三方和 MCP 工具保持各自的渲染。
171
- - 模式在 Pi 创建某行时确定,因此切换只影响新建的行;执行 `/reload` 或新开会话后整个记录都会应用。
172
-
173
- ## 本地开发
174
-
175
- ```bash
176
- npm install
177
- npm test
178
- npm run typecheck
179
- pi -e .
180
- ```
181
-
182
- ## 致谢
183
-
184
- 本项目基于多个 Pi 社区包的工作:
185
-
186
- - **[pi-haiku](https://github.com/nnocte/pi-haiku)** — 双行底栏结构和工作计时器
187
- - **[pi-claude-code-tui](https://github.com/Phoobobo/pi-claude-code-tui)** — Pi Logo 帧与圆角编辑器边框技术
188
- - **[pi-zentui](https://github.com/lmilojevicc/pi-zentui)** — Starship 风格底栏、运行环境检测、会话生命周期和设置界面模式
189
- - **[pi-tps](https://github.com/monotykamary/pi-tps)** — 单轮计时、停顿检测和保守的 TPS 计算方式
190
-
191
- Logo 帧源自 Pi 官方安装脚本(`pi.dev/install.sh`)。运行环境检测和 Git porcelain 解析借鉴了 `pi-zentui` 的结构。
192
-
193
- 特别感谢 **[LINUX DO](https://linux.do)** 社区的支持。
194
-
195
- ## 许可证
196
-
197
- [MIT](./LICENSE)
1
+ # pi-open-tui
2
+
3
+ [![omp 状态](https://omppackages.com/badge/pi-open-tui.svg)](https://omppackages.com/packages/pi-open-tui)
4
+
5
+ [English](./README.md) | **简体中文**
6
+
7
+ 一个为 [Pi](https://pi.dev) 编程代理打造的终端界面扩展,将 pi-haiku、pi-claude-code-tui 与 pi-zentui 的优秀设计整合为统一、可配置的使用体验。
8
+
9
+ ![pi-open-tui 预览](https://raw.githubusercontent.com/OldSuns/pi-open-tui/main/assets/preview_dashboard_1.png)
10
+
11
+ Pi 1.4.0 的真实终端截图。
12
+
13
+ ## 功能亮点
14
+
15
+ - **Pi 顶栏**:显示模型、思考等级、当前目录和常用斜杠命令提示
16
+ - **自适应底栏**:集中展示 Git 状态、运行环境、上下文用量、Token、费用和扩展状态
17
+ - **带边框的编辑器**:支持块状、竖线和下划线三种光标样式;保留其它扩展已安装的兼容编辑器
18
+ - **项目环境感知**:识别 50 多种运行环境,并展示 ahead/behind、已暂存、已修改、未跟踪、stash 和 detached HEAD 等 Git 状态
19
+ - **单轮遥测**:展示 TPS、首 Token 延迟(TTFT)、耗时、停顿、Token 数量和模型标价速率
20
+ - **思考预览**:模型工作时,在 Pi 隐藏思考块的 `Thinking...` 位置显示实时字幕,展示推理内容的末尾片段
21
+ - **交互式设置**:通过 `/open-tui` 配置,并支持英文和简体中文界面
22
+
23
+ ## 环境要求
24
+
25
+ - Pi 1.2.0 或更高版本
26
+ - Node.js 22.19.0 或更高版本(Pi 的最低要求)
27
+ - 支持 UTF-8 和彩色输出的终端
28
+ - 使用完整图标集时需要 [Nerd Font](https://www.nerdfonts.com/font-downloads)(可选;内置可移植 Unicode 图标)
29
+
30
+ ## 安装
31
+
32
+ 安装扩展:
33
+
34
+ ```bash
35
+ pi install npm:pi-open-tui
36
+ ```
37
+
38
+ 也可以只在当前会话中试用:
39
+
40
+ ```bash
41
+ pi -e npm:pi-open-tui
42
+ ```
43
+
44
+ ## 字体与图标
45
+
46
+ 可从 [Nerd Fonts 官方下载页](https://www.nerdfonts.com/font-downloads)或 [GitHub 最新版本](https://github.com/ryanoasis/nerd-fonts/releases/latest)下载任意已修补字体。安装后,请在终端配置中选择该字体,并重启终端。
47
+
48
+ 默认的 `auto` 模式检查终端环境,而不是已安装的字体文件。在支持 UTF-8 的交互式 TTY 中,它会使用 Nerd Font 图标,即使 Pi 运行在 runner 或子 shell 中。如果图标显示为方框、乱码或错误符号,请打开 `/open-tui`,在**外观**页选择合适的模式:
49
+
50
+ - `nerd`:终端已配置 Nerd Font 时,强制使用 Nerd Font 图标
51
+ - `unicode`:可移植 Unicode 图标(文件夹、分支、笔记本电脑、灯泡、插头、沙漏等),无需修补字体;emoji 字形通过终端的 emoji 回退渲染
52
+ - `ascii`:使用纯文本图标,无需安装修补字体
53
+ - `auto`:在支持 UTF-8 的交互式 TTY 中使用 Nerd Font 图标;SSH 会话使用可移植 Unicode 图标(字体由客户端终端决定,通常没有 Nerd Font);非交互式输出、`TERM=dumb` 或明确配置为非 UTF-8 的 locale 使用 ASCII
54
+
55
+ 如果已经安装字体,但 `auto` 仍选择 ASCII,请手动切换为 `nerd`。使用 VS Code、Windows Terminal 等应用时,只在操作系统中安装字体还不够,还需要在对应的终端配置中选中该字体。如果 SSH 客户端终端确实安装了 Nerd Font 并希望在 SSH 下使用完整图标,请将模式显式设为 `nerd`。
56
+
57
+ 如果较宽的 Nerd Font 图标占用了图标与文字之间的间隔(例如在 Kitty 中),可开启 `footerSegments.nerdIconSpacing`(`/open-tui` 中的 **底栏 → Nerd 图标后额外留空**)。开启后底栏会在 Nerd Font 图标后额外预留一格空白,包括运行环境图标,常规底栏和内嵌底栏的宽度计算都包含这格留白;Unicode/ASCII 图标与紧凑的 Git 状态标记不受影响。Kitty 用户也可以在 `kitty.conf` 中设置 `narrow_symbols U+E000-U+F8FF 1`。
58
+
59
+ ## 配置
60
+
61
+ 运行 `/open-tui` 打开设置窗口,其中包含**常规**、**外观**、**底栏**和**遥测**四个页面,并会适应终端尺寸。设置保存在 Pi 的 agent 目录内的 `open-tui.json` 中;默认目录为 `~/.pi/agent`,可通过 `PI_CODING_AGENT_DIR` 覆盖。保存失败时会提示:修改仅在当前会话生效。
62
+
63
+ 配置示例:
64
+
65
+ ```json
66
+ {
67
+ "enabled": true,
68
+ "header": true,
69
+ "inlineFooter": false,
70
+ "copyButtons": true,
71
+ "settingsLanguage": "zh",
72
+ "cursorStyle": "block",
73
+ "icons": {
74
+ "mode": "auto"
75
+ },
76
+ "footerSegments": {
77
+ "cwd": true,
78
+ "hostname": false,
79
+ "sessionName": false,
80
+ "gitBranch": true,
81
+ "gitStatus": true,
82
+ "gitCommit": false,
83
+ "runtime": true,
84
+ "context": true,
85
+ "tokens": true,
86
+ "cost": true,
87
+ "liveTps": true,
88
+ "extensionStatuses": true,
89
+ "capitalizeProviderName": true,
90
+ "nerdIconSpacing": false
91
+ },
92
+ "telemetry": {
93
+ "enabled": true,
94
+ "tps": true,
95
+ "ttft": true,
96
+ "duration": true,
97
+ "tokens": true,
98
+ "stalls": true,
99
+ "cost": true
100
+ },
101
+ "thinkingPeek": {
102
+ "lines": 1
103
+ },
104
+ "toolView": {
105
+ "mode": "native"
106
+ }
107
+ }
108
+ ```
109
+
110
+ 主要选项:
111
+
112
+ | 选项 | 可选值 | 说明 |
113
+ | --- | --- | --- |
114
+ | `settingsLanguage` | `en`、`zh` | 切换 `/open-tui` 设置界面的语言 |
115
+ | `header` | `true`、`false` | 决定是否用 open-tui 顶部信息栏覆盖 Pi 的 Header;设为 `false` 时把顶部栏位置留给 Pi 或其他扩展 |
116
+ | `inlineFooter` | `true`、`false` | 将两条主要 Footer 信息行移入编辑器上下边框以节省垂直空间,默认关闭;扩展状态行仍显示在编辑器外 |
117
+ | `copyButtons` | `true`、`false` | 全屏模式下给代码块加圆角边框,并在代码块和用户消息上显示可点击的 `[Copy]` 标签,默认开启;见[复制按钮](#复制按钮) |
118
+ | `cursorStyle` | `block`、`bar`、`underline` | `bar` 和 `underline` 需要终端支持光标形状转义序列 |
119
+ | `icons.mode` | `auto`、`nerd`、`unicode`、`ascii` | 控制底栏和遥测通知使用的图标 |
120
+ | `footerSegments` | 布尔开关 | 分别控制底栏中的各项数据 |
121
+ | `footerSegments.capitalizeProviderName` | 布尔开关 | 将底栏中提供商名称的首字母大写;设为 `false` 时保留原始大小写 |
122
+ | `footerSegments.nerdIconSpacing` | 布尔开关 | 在底栏 Nerd Font 图标后额外留一格空白;默认 `false` |
123
+ | `telemetry` | 布尔开关 | 控制遥测总开关和各项指标 |
124
+ | `thinkingPeek.lines` | `0`、`1`、`2` | 关闭、单行或双行思考预览 |
125
+ | `toolView.mode` | `native`、`compact` | Pi 原生卡片(默认),或带编辑/写入成功预览的紧凑调用与摘要行。只对切换后新建的行生效 |
126
+
127
+ `sessionName` 仅在会话有名称时显示;`hostname` 会显示主机名的短名称(主机名的第一个标签,例如从 `mba.example.com` 显示为 `mba`),并使用服务器图标;处于分离 HEAD(detached HEAD)状态时,`gitBranch` 会显示 `HEAD` 和短提交哈希,`gitCommit` 会在其后追加指向该提交的标签,且仅在开启 `gitBranch` 时生效;关闭 `extensionStatuses` 会隐藏整行扩展状态,其中也包括 MCP 状态。每条状态会保留其扩展通过 `ctx.ui.theme.fg()` 设置的颜色;未设置颜色的状态使用 muted 主题色显示。
128
+
129
+ 底栏的 Token 和费用总计包含助手回复、工具报告的用量、压缩与分支摘要以及缓存预热;缓存命中百分比表示最近一条助手回复,而非整个会话的累计比例。
130
+
131
+ 底栏第一行宽度不足时,先隐藏运行环境和上下文条,然后依次隐藏 Git、会话名称、主机名和计时器;当前目录保留到最后,并缩短为文件夹名。
132
+
133
+ 开启 `inlineFooter` 后,两条常规 Footer 信息行会移入编辑器边框,从而节省垂直空间。顶部边框左侧显示 Git 分支,右侧信息组以当前目录开头;开启 `sessionName` 时,会话标题也会显示在左侧。Header 和扩展状态行保持独立显示;终端较窄时优先截断低优先级 Footer 数据,保留右侧统计信息和边框角。
134
+
135
+ open-tui 会给保留 Pi 原生编辑器布局及光标、鼠标、内边距接口的编辑器加边框,包括基于 `CustomEditor` 的扩展。装饰直接作用于同一实例,因此灰字建议、按键处理、补全和提交回调能够保留。通过当前 `ctx.ui.setEditorComponent()` 接口注册的编辑器扩展可以排在 `pi-open-tui` 前面或后面,运行时替换编辑器也会自动加框,包括在持有新 UI 上下文的快捷键回调中替换。替换后的实例在 Pi 挂载时直接装饰,不会再次调用扩展的创建函数;临时对话框保持原样。装饰前,open-tui 会按终端宽度渲染一次编辑器,检查是否存在可识别的原生上下边界。每次加框也会检查本次实际输出;没有这些边界时按完整请求宽度重新渲染,不应用边框的鼠标坐标偏移,原生边界恢复后再继续加框。缺少这些能力或边界、或在布局检测时抛出异常的编辑器保持原样,即使开启 `inlineFooter`,底栏也会独立显示。关闭 open-tui 会撤销装饰、恢复注册接口,并保留最新的编辑器工厂,包括后注册的扩展包装。
136
+
137
+ 顺序无关的保证针对编辑器注册,不包含顶栏或底栏的替换。如果扩展调用预先保存的旧注册函数,或直接替换注册接口本身,则不在此保证范围内。
138
+
139
+ ## 单轮遥测
140
+
141
+ 每次 Agent 完整运行结束后,pi-open-tui 会显示一条临时结果,并将其中的多个工具调用轮次合并统计:
142
+
143
+ ```text
144
+ > TPS 42.5 tok/s | ~ TTFT 1.2s | + 29.7s | ↑ 567 | ↓ 1.2k | ! stall 1x / 4.3s | $ $3.60/M
145
+ ```
146
+
147
+ TPS 的计算方式是:将本次运行中服务商报告的全部 Assistant 输出 Token,除以各个生成轮次的总耗时。计时范围从 `turn_start` 到 Assistant 的 `message_end`,包含 TTFT、隐藏推理、缓冲和停顿,但不包含轮次之间的工具执行时间。没有输出 Token 或无法测得生成时间时,会显示 `TPS —`。
148
+
149
+ 回复流式输出时,工作计时器还会显示当前的估算速度,例如 `working 12.3s · ~54 tok/s`。`~` 表示估算值:它是最近 2 秒内流式输出的正文、思考内容和工具调用参数的速率,按拉丁文本和代码约 4 个字符 1 个 Token、中日韩字符每字 1 个 Token 估算。停顿时数值会逐渐降向零;工具执行期间和消息之间以暗色保留上一个值。由**底栏 → 实时 TPS**(`footerSegments.liveTps`)控制,与遥测通知的开关互不影响。运行结束后不再显示,以上面的精确 TPS 为准。
150
+
151
+ `$ / M` 表示根据 `usage.cost.total` 得到的模型标价速率,不是底栏中的会话累计费用。所有遥测字段都可以在**遥测**页单独开关。
152
+
153
+ ## 思考预览
154
+
155
+ 开启 Pi 的 **Hide thinking** 后,任务运行期间 pi-open-tui 会在原生隐藏思考块的 `Thinking...` 位置显示紧凑的实时字幕。`/open-tui` 中提供**关闭、单行、双行**三种模式:
156
+
157
+ - 模型推理时,思考内容的末尾片段会随 spinner 滚动(`~ think ⠋ …`);
158
+ - 开始输出正文时定格为对勾(`~ think ✓`);
159
+ - 双行模式中,上一条和最新一条思考内容使用相同的文字缩进;如果最新一行超出宽度,则两行随新 Token 持续显示它的最新末尾片段,不再保留上一条;
160
+ - 任务结束后恢复原生 `Thinking...` 标签。
161
+
162
+ ```text
163
+ ~ think ⠋ 上一条思考
164
+ 最新一条思考
165
+ ```
166
+
167
+ 该字幕仅在模型真正输出推理内容后出现,非推理模型不会显示。可见性由 Pi 自身的 Hide thinking 开关控制,切换后立即生效。每一行都按*显示宽度*截断(全角字符计 2 列),因此包含中文的思考文本也不会溢出终端。可在 `/open-tui` 的**常规 → 思考预览**中切换,或直接修改 `open-tui.json` 中的 `thinkingPeek.lines`。
168
+
169
+ ## 工具视图
170
+
171
+ 默认仍为**原生**模式。将**常规 → 工具视图**设为**紧凑**(`toolView.mode: "compact"`)后,Pi 内置工具(`read`、`bash`、`powershell`、`edit`、`write`、`grep`、`find`、`ls`)显示为一行调用加一行摘要,编辑和写入成功时附带预览:
172
+
173
+ ```text
174
+ ● Read(extensions/open-tui/footer.ts:1-120)
175
+ └ 120 lines
176
+ ● Edit(extensions/open-tui/footer.ts)
177
+ └ +2 −1
178
+ ● Bash(npm test)
179
+ └ Done · 131 lines · 6.4s
180
+ ```
181
+
182
+ - 成功后调用与摘要文字变暗,圆点为绿色;等待时圆点变暗,运行时圆点每秒在主题强调色与暗色之间切换。错误继续显示红色圆点与摘要。Shell 失败摘要保留最后一行输出;运行中显示最新 3 行输出和已用时间。
183
+ - `edit` 成功预览解析 Pi 的真实 diff,分别对旧代码和新代码做语法高亮。删除/新增行使用红/绿整行背景色带,在终端右边缘前留出两列。仅相邻且配对、共享非空白内容至少占 30% 的删除/新增行使用更强的变更词背景;超出匹配预算时回退到整行高亮。没有有效 diff 时保留摘要。
184
+ - `write` 成功预览使用正常、中性的终端背景,显示行号和语法高亮,不带 `+` 号。新建与覆盖写入显示相同,不对比旧文件。部分结果和错误不显示成功预览。
185
+ - 预览正文最多显示 16 行;超过时显示前 16 行,加上隐藏行数与 `Ctrl+O` 提示。编辑的上下文行和省略行也计入行数。仅紧凑模式下,长行以 `…` 横向截断,不自动换行。
186
+ - 点击某行只展开这一行为 Pi 原生卡片,`Ctrl+O` 展开全部行;原生展开视图的完整输出、diff 和截断提示保持不变。各次调用独立显示,不分组,也不增加配置项。
187
+ - 只改变显示:工具、参数、结果以及模型看到的内容都不受影响。仅接管 Pi 确认来源为内置的工具;第三方和 MCP 工具(包括替换内置同名工具的扩展)保持各自的渲染。
188
+ - 紧凑摘要会标记输出截断,包括 grep 的长行截断;方括号正文和失败信息会保留,不会被误当成工具通知删除。
189
+ - 模式在 Pi 创建某行时确定,因此切换只影响新建的行;执行 `/reload` 或新开会话后整个记录都会应用。
190
+
191
+ ## 复制按钮
192
+
193
+ 全屏模式(Pi 的 `tuiMode: "fullscreen"`)下,每个代码块都会画在圆角边框里,顶边显示语言和始终可见的 `[Copy]` 标签;每条用户消息也有 `[Copy]` 标签。点击即可把原始文本放入剪贴板,Pi 会短暂提示 `Copied!`。
194
+
195
+ ```text
196
+ ╭─ sh ─────────────── [Copy] ╮
197
+ │ pi install npm:pi-open-tui │
198
+ ╰────────────────────────────╯
199
+ ```
200
+
201
+ - 代码块:边框替代了上下两行围栏,代码块高度不变;过长的行在边框内换行。标签复制不含围栏的代码,保留缩进和制表符。用户消息和助手回复里的代码块都适用。
202
+ - 用户消息:标签位于气泡最后一行,复制你输入的原文。
203
+ - 整条助手回复没有标签,请使用 Pi 的 `/copy`。
204
+ - 回复输出过程中代码块只有边框、没有标签,避免复制到不完整的代码;边框太窄时也不显示标签;思考块保留 Pi 原生的围栏。
205
+ - 普通模式不捕获鼠标,代码块保留 Pi 原生的围栏。
206
+ - 拖动选择经过边框时会包含边框字符和 `[Copy]` 文字。
207
+ - 如果同时安装了 pi-pretty-tui,则保留它自己的代码块边框和复制按钮,不再绘制这些内容。
208
+
209
+ 可在 `/open-tui` 的**常规 → 复制按钮**中切换,或直接修改 `open-tui.json` 中的 `copyButtons`。
210
+
211
+ ## 本地开发
212
+
213
+ ```bash
214
+ npm install
215
+ npm test
216
+ npm run typecheck
217
+ pi -e .
218
+ ```
219
+
220
+ CI 在 Linux、Windows、macOS 上,使用 Node.js 22.19.0 和 24,检查 Pi 1.2.0 及最新版本。核对兼容性时应让各个 Pi 包保持同一版本。自动化测试不能替代通过 `pi -e .` 检查终端字体、鼠标交互和光标支持。
221
+
222
+ ## 致谢
223
+
224
+ 本项目基于多个 Pi 社区包的工作:
225
+
226
+ - **[pi-haiku](https://github.com/nnocte/pi-haiku)** — 双行底栏结构和工作计时器
227
+ - **[pi-claude-code-tui](https://github.com/Phoobobo/pi-claude-code-tui)** — Pi Logo 图案与圆角编辑器边框技术
228
+ - **[pi-zentui](https://github.com/lmilojevicc/pi-zentui)** — Starship 风格底栏、运行环境检测、会话生命周期和设置界面模式
229
+ - **[pi-tps](https://github.com/monotykamary/pi-tps)** — 单轮计时、停顿检测和保守的 TPS 计算方式
230
+
231
+ Logo 图案源自 Pi 官方安装脚本(`pi.dev/install.sh`)。运行环境检测和 Git porcelain 解析借鉴了 `pi-zentui` 的结构。
232
+
233
+ 特别感谢 **[LINUX DO](https://linux.do)** 社区的支持。
234
+
235
+ ## 许可证
236
+
237
+ [MIT](./LICENSE)
Binary file
@@ -46,6 +46,8 @@ export interface OpenTuiConfig {
46
46
  /** Override Pi's header with the open-tui header. When false, the header slot is left to Pi or another extension. */
47
47
  header: boolean;
48
48
  inlineFooter: boolean;
49
+ /** Clickable `Copy` labels on code blocks and user messages (fullscreen mode only). */
50
+ copyButtons: boolean;
49
51
  settingsLanguage: SettingsLanguage;
50
52
  cursorStyle: CursorStyle;
51
53
  icons: {
@@ -63,6 +65,7 @@ export const DEFAULT_CONFIG: OpenTuiConfig = {
63
65
  enabled: true,
64
66
  header: true,
65
67
  inlineFooter: false,
68
+ copyButtons: true,
66
69
  settingsLanguage: "en",
67
70
  cursorStyle: "block",
68
71
  icons: {
@@ -176,6 +179,9 @@ export function loadConfig(notify?: (msg: string, level: "warning" | "info") =>
176
179
  if (typeof config.inlineFooter !== "boolean") {
177
180
  config.inlineFooter = DEFAULT_CONFIG.inlineFooter;
178
181
  }
182
+ if (typeof config.copyButtons !== "boolean") {
183
+ config.copyButtons = DEFAULT_CONFIG.copyButtons;
184
+ }
179
185
  config.footerSegments = normalizeFlags(config.footerSegments, DEFAULT_CONFIG.footerSegments);
180
186
  config.telemetry = normalizeFlags(config.telemetry, DEFAULT_CONFIG.telemetry);
181
187
  if (typeof config.icons !== "object" || config.icons === null || !ICON_MODES.includes(config.icons.mode)) {
@@ -203,13 +209,14 @@ export function loadConfig(notify?: (msg: string, level: "warning" | "info") =>
203
209
  }
204
210
  }
205
211
 
206
- export function saveConfig(config: OpenTuiConfig): void {
212
+ export function saveConfig(config: OpenTuiConfig): boolean {
207
213
  const path = getConfigPath();
208
214
  try {
209
215
  const agentDir = getAgentDir();
210
216
  if (!existsSync(agentDir)) mkdirSync(agentDir, { recursive: true });
211
217
  writeFileSync(path, JSON.stringify(config, null, 2) + "\n", "utf8");
218
+ return true;
212
219
  } catch {
213
- // ponytail: silent fallback — config save is best-effort
220
+ return false;
214
221
  }
215
222
  }