UART Kit for Tabby

Tabby 串口 / UART 调试工具插件：日志保存 + 手动关键字高亮，面向嵌入式开发时分析串口输出。

项目说明

| 项 | 内容 | |---|---| | 名称 | tabby-uart-kit | | 版本 | 1.1.3 | | 仓库 | https://github.com/jaeckzeng/tabby-uart-kit | | 作者 | jack ([email protected]) | | 协议 | MIT | | 类型 | Tabby 插件（tabby-plugin） |

适用场景

• 串口调试时保存完整会话日志（.log），支持 ANSI 过滤或原样保留
• 分析大量 log 时，手动标记关键字并着色区分（ERROR、模块名、地址等）
• 多窗口并行调试，各窗口高亮标记互不影响

一句话描述（可用于 GitHub About）

Tabby 串口调试插件：保存 UART 日志到文件，支持 8 色手动关键字高亮（F8 / Shift+F8）。

推荐 Topics

tabby-plugin tabby uart serial embedded log highlight terminal

基于 Eugeny/tabby-save-output fork 并扩展。高亮实现参考 moemoechu/tabby-highlight。

功能

日志保存

• 右键 保存输出到文件... 手动录制
• 可选自动保存（全部 / 仅 SSH）
• ANSI 处理：strip（纯文本）/ raw（保留转义序列）
• 默认文件名：时间戳 - COM口.log（串口标签使用实际 COM 口名）

关键字高亮

• 默认无高亮，需用户手动标记
• 每个终端窗口独立维护 8 个高亮槽
• 选中文字 → F8 标记/取消
• Shift+F8 清除当前窗口全部高亮
• 样式：明亮底色 + 黑字（荧光笔效果）
• 8 种底色，支持浅色/深色主题自动切换

快捷键

| 按键 | 功能 | |------|------| | F8 | 对选中文字切换高亮（标记到槽位 / 取消已有标记） | | Shift+F8 | 清除当前窗口全部高亮 |

可在 Tabby Settings → Hotkeys 中修改绑定。

安装

npm 安装（发布后）

tabby install tabby-uart-kit

安装后须彻底退出 Tabby（托盘图标 → Quit），再重新打开。插件会出现在 设置 → 插件 → 已安装；功能入口在 设置 → UART 工具包。

Tabby 通过 package.json 的 keywords 中的 tabby-plugin 识别插件，不需要额外的 "tabby-plugin": "..." 字段。

本地开发安装

先完全退出 Tabby，再在项目根目录执行：

npm install --legacy-peer-deps --ignore-scripts   # 首次需要
npm run install:local          # Git Bash / WSL
# 或
npm run install:local:win      # PowerShell / Windows

脚本会构建并将 package.json + 完整 dist/ 复制到 %APPDATA%\tabby\plugins\node_modules\tabby-uart-kit\。

手动复制

1. npm run build
2. 将 package.json 和 dist/ 复制到 Tabby 插件目录下的 node_modules/tabby-uart-kit/（Settings → Plugins → Open Plugins Directory）
3. 彻底退出并重启 Tabby

安装后看不到插件？

1. 彻底退出 Tabby（不要只关窗口；托盘右键 Quit，或任务管理器结束 Tabby 进程）
2. 打开开发者工具（Ctrl+Shift+I）→ Console，搜索 uart-kit 或 Could not load
3. 确认 %APPDATA%\tabby\plugins\node_modules\tabby-uart-kit\dist\index.js 存在
4. 新发布的包可能暂未出现在 npm 搜索的「可用插件」列表，但本地已安装后会在「已安装」中显示

配置

设置 → UART 工具包 / UART Kit（随 Tabby 语言自动切换）：

• Save Log：自动保存、目录、ANSI 模式
• Highlight：8 组 light/dark 底色（默认沿用 highlightwords 配色）

关键字不在 Settings 中预置，仅通过终端选中 + F8 标记。

License

MIT — 详见 LICENSE