@alexlikevibe/pi-bg
v2.2.0
Published
Background tasks extension for pi. Claude Code parity — auto-background capped at 30s (min(timeout, 30)), run_in_background flag, Ctrl+Shift+B manual background with live hint, mid-turn <task-notification> completion messages, streaming jobs attach, file-
Maintainers
Readme
pi-bg
构建还在跑,代理不该干等着。 这就是 Claude Code 的后台任务体验,如今搬到了 Pi 上:扔出一条长命令,它不会卡住整个会话,而是悄悄溜到后台,代理则继续埋头干活。30 秒自动转后台、Ctrl+Shift+B 一键秒转、输出全程捕获、卡顿自动检测,外加一个功能齐全的作业管理器 —— 全都打包进一个扩展里。
安装
pi install npm:@alexlikevibe/pi-bg或者直接从 GitHub 装:
pi install git:github.com/iefnaf/pi-bg只需 Pi v0.37+,要求仅此一条 —— 零外部依赖,也不用 tmux。后台作业就是普通的 Node.js 子进程,输出直接写进一个文件描述符。没什么要装的,也没什么要盯着的。
为什么你会想要它
会话卡死,到此为止。 开发服务器、测试套件、构建 —— 任何跑过 30 秒还没完事的命令,都会被悄悄挪到后台。代理收到提醒,转头就去干下一件事,而不是盯着转圈圈的进度条发呆。想让它早点滚到后台?随时手动一推就行。
用起来像 Claude Code,因为它就是照着 Claude Code 做的。 前后台来回切换的这一整套动作 —— Ctrl+Shift+B 转后台、输出捕获、完成提醒、卡顿检测 —— 全都直接建在 Claude Code 的实现之上。一样的消息格式,一样的终端原生图标,一样「代理永不停手」的节奏。要是你早已练出肌肉记忆,那这里照样能用。
一个像样的作业管理器,而不是临时凑数。 /bg-list 打开一个交互式作业管理器:列出作业、瞄一眼输出、干掉跑飞的、或者挂上去等结果,样样都行。
快速开始
# 代理跑一条长命令 —— 30 秒后自动转后台
bash({ command: "npm run build" })
# 不想等?一上来就丢进后台
bash({ command: "npm run dev", run_in_background: true })
# 或者扔了就不管,直接进后台
bash_bg({ command: "npm run dev", name: "devserver" })
# 看看现在有啥在跑
jobs({ action: "list" })
# 一次性在所有作业的输出里 grep
jobs({ action: "search", pattern: "error|warning" })
# 把整个任务甩给一个后台代理
agent_bg({ prompt: "重构 auth 模块" })命令在跑的时候,随手按下 Ctrl+Shift+B,它就地转入后台 —— 命令跑过几秒后,输入框下方会浮现一行淡淡的 (ctrl+shift+b to run in background) 提示。代理收到通知,你手还没从键盘上松开,它已经回去接着干了。
工具
bash(覆盖)
内置的 bash 工具,但多了点求生本能。命令照常运行 —— 可一旦某条冲破 30 秒,它就悄悄滑进后台。没有决策提示,也不强制开新轮:工具结果本身(Command running in background with ID: …)就告诉代理输出去了哪里。
| 参数 | 说明 |
|------|------|
| command | 要运行的 shell 命令 |
| timeout | 转后台前最长等待(秒,默认:120,硬上限 30) |
| run_in_background | 跳过前台运行和自动后台计时器,立即在后台启动命令 |
bash_bg
当你心里有数,知道这是个慢活儿。命令直接在后台启动 —— 没有前台竞速,也不用干等超时。
| 参数 | 说明 |
|------|------|
| command | 要运行的 shell 命令 |
| name | 可选的可读作业标签 |
| timeout | 可选超时(秒);超时只杀掉无法自动转后台的命令(如 sleep),其余照跑不误 |
| notify | 发送完成通知(默认:true) |
jobs
后台一切的指挥中心:列表、读输出、终止、挂上去等、搜索、清理,或者拉一份统计。
| 操作 | 说明 |
|------|------|
| list | 显示所有运行中和最近完成的作业 |
| output | 读取某个作业的日志尾部 |
| kill | 终止运行中的作业 |
| attach | 等作业完成后返回它的输出 |
| search | 在所有作业日志里做正则搜索 |
| cleanup | 清除已完成/失败的作业,回收磁盘空间 |
| stats | 聚合指标:总启动数、运行中、已完成、失败、平均时长 |
agent_bg
给自己克隆一个搭档。它会拉起一个分离的 pi -p 进程,带上从当前会话派生的连续性提示,然后把进度实时回传给你。
| 参数 | 说明 |
|------|------|
| prompt | 后台代理的任务描述 |
| cwd | 工作目录(默认:当前) |
monitor
流式推送事件,而不是只等一次。bash_bg/run_in_background 在完成时通知一次,而 monitor 把进程变成实时事件流——每一行 stdout(或每个 WebSocket 帧)都会变成一条通知,直接送进代理的回合,代理则继续干活。这是 Claude Code 一分为二中的“流式”那一半:一次性的“完成时告诉我”交给 run_in_background,逐事件的“每次发生 X 都告诉我”交给 monitor。
// 持续通知每一行错误
monitor({ command: "tail -f deploy.log | grep --line-buffered -E 'ERROR|Traceback'", description: "deploy.log 中的错误" })
// 每个 CI 检查到达时推送一条,运行结束时退出
monitor({ command: "…会退出的轮询循环…", description: "PR 123 的 CI 检查" })
// 订阅 WebSocket 数据流——每个文本帧即一个事件
monitor({ ws: { url: "wss://events.example.com/stream" }, description: "部署事件", persistent: true })| 参数 | 说明 |
|------|------|
| command | Shell 脚本;每行 stdout 即一个事件。与 ws 互斥。 |
| ws | WebSocket 源 { url, protocols? };每个文本帧即一个事件。与 command 互斥。 |
| description | 显示在每条通知上(请写得具体)。必填。 |
| persistent | 运行整个会话(无超时);用 jobs action='kill' 停止。默认 false。 |
| timeout_ms | 终止该监视的截止时间(默认 300000,最大 3600000)。persistent 时忽略。 |
监视器与后台工具共享同一套作业注册表、侧边栏(以 ◉ 标记)和 jobs 管理器——只有 stdout 是事件流(stderr 会捕获到单独的 .err 文件),输出按行缓冲,所以请用 grep --line-buffered/awk fflush(),绝不要用 head。一个疯狂刷事件的监视器会被自动停止,你可以用更严格的过滤器重新启动。ws 源需要带有全局 WebSocket 的运行时(Node 22+),否则请改用 websocat 之类的 command。
持久监视器与磁盘: 非
persistent监视器的输出日志有上限(输出过大时会被终止)。但persistent监视器本就预期跑满整个会话,因此其日志不做大小限制——让长期运行的tail -f对准经过过滤的流而不是 firehose,用完后用jobs action='kill'停止。
键盘快捷键
手别离开键盘。
| 快捷键 | 操作 |
|-------|------|
| Ctrl+Shift+B | 把所有正在运行的前台命令转后台 —— 代理继续干活(对应 Claude Code 的 Ctrl+B;pi 自己把 Ctrl+B 保留为编辑器光标左移)。在没有 extended-keys 的 tmux 里请改用 /bg。 |
| Ctrl+Shift+J | 打开后台作业管理器 |
| Shift+Down | 打开后台作业管理器 |
| Ctrl+Shift+X | 终止最近一个运行中的作业 |
命令
更喜欢斜杠命令?同样的本事,换个入口而已。
| 命令 | 说明 |
|------|------|
| /bg | 把当前进程转后台(等同 Ctrl+Shift+B) |
| /bg-list | 打开交互式后台作业管理器 |
| /bg-version | 显示已加载扩展的版本/路径,方便排查重载问题 |
工作原理
没什么魔法,就是一台干净利落的状态机:
命令启动(直接 Node.js child_process.spawn)
→ 2 秒内完成? 立即返回结果
→ 30 秒还在跑? 自动转后台 → 工具结果带上新的任务 ID
→ 你按了 Ctrl+Shift+B? 立即转后台 → 代理继续
后台作业运行中
→ 输出经由文件描述符捕获到 /tmp/pi-bg/<id>.log
→ 卡顿检测:输出停摆且尾部看起来像交互式提示时,警告代理
→ 超量检测:输出冲破上限时,直接终止作业
→ 完成时:独立的 <task-notification> 在轮次中途送达,附带状态 + 输出路径后台作业以分离的 Node.js 子进程运行,stdout/stderr 直接接到一个日志文件描述符上 ——
跟 Claude Code 的做法分毫不差。没有 tmux,没有外部进程管理器,你的命令和它的日志
之间什么都不隔。最多 16 个后台作业同时跑;想塞第 17 个?会被客气地挡回去,直到
腾出空位。注册表纯粹在内存里:会话关闭 —— 任何原因的关闭,不只是退出 —— 都会杀掉
所有运行中的任务,下一个会话不会复活任何东西。/tmp/pi-bg 里的日志文件就留给操作系统
自己清理。
在底层,三种任务类型(shell、agent、monitor)共用一个统一的内存注册表和同一个通知引擎。
子进程监听 exit 事件而非 close,因此继承了输出描述符的守护化孙进程无法拖着作业不放。
每个结束的任务都恰好发送一次自己的 <task-notification> —— 用 jobs output/attach
读过已结束作业的输出即标记为已读、抑制待发的提醒;已完成但未读的作业在 jobs list 和
侧边栏中显示 , unread。
协作式转向(对齐 Claude Code)
前台正跑着一条可转后台的命令时,你打了一条消息 —— 扩展会在 Pi 把它排进转向队列之前就先一步介入:
- 正在跑的前台命令滑入后台(输出继续捕获 —— 一点不丢)。
- 当前的代理轮次被中断。
- 代理一空闲,你的消息就作为一个全新的用户轮次重新注入。
这正是 Claude Code 的行为:在可中断的工具运行期间提交输入,会中断该工具并开启新一轮,而不是把你的消息晾在长任务后面排队。不轮询,也不必干等下一轮。
适用范围: 这只对本扩展接管的 bash 工具生效。扩展没有包裹的其他长任务工具,会回退到 Pi 原生的转向机制(排队,在下一个轮次边界投递)。
状态栏
一个实时的胶囊小组件让运行中的作业始终在你眼前 —— 每个都带着已运行时长和命令预览。完成数和失败数也一并显示在状态行里。想看全貌时,Shift+Down 或 /bg-list 打开作业管理器。
版本发布
2.2.0 —— 等待指引决策树 + 日志轮询 guard(#2)
- 有序等待指引。
bash/bash_bg的指引改为按优先级教学:不急 → 结束回合(任务通知会唤醒你带回结果);本回合就要 →jobs attach(被中断就再 attach);等的是条件而非退出 →monitor。sleep-guard 引导里的until循环示范已删除。 - 新增 guard:拦截日志轮询循环。
until grep … /tmp/pi-bg/<id>.log; do sleep …; done和对本扩展自己日志的tail -f,在bash和bash_bg中都会被拒绝,并引导到 attach / monitor / 结束回合。一次性读取(cat、tail -n)不受影响;非扩展路径的循环和 tail 永不拦截。 - attach 措辞:中断跟随时改为提示“再 attach 一次继续等”,而不是只指向
jobs output。 - 实验验证:
pi -p会话在回合结束后不等待后台任务直接退出 —— 通知无处投递,因此非交互/子代理场景下attach仍是唯一的等待方式。
2.1.0 —— 前台等待硬上限 30 秒(#1)
- 前台命令最多等 30 秒就自动转后台 —— 等待时长 =
min(timeout, 30秒)。显式传timeout只能缩短等待,不能超过硬上限。以前模型传timeout: 600会让整个回合阻塞满 600 秒;现在 30 秒整就转后台,结果照常通过<task-notification>稍后投递。 - 前台只留给快命令。预期较长的任务请用
run_in_background(一次完成通知)或monitor工具(逐事件流式)。 - 不变:2 秒快速完成窗口、
sleep黑名单(不可转后台的命令仍在等待上限处被 kill)、后台任务生命周期。
2.0.0 —— Claude Code 对齐重构
后台引擎从头到尾照着 Claude Code 的真实实现重建了一遍。
重大变更
job_decide没了。 自动转后台超时触发时,命令悄悄滑进后台 —— 工具结果本身(Command running in background with ID: …)就是通知。没有决策提示,也不强制开新轮。- 任务 ID 格式变了。 顺序号
job-<pid>-<n>换成带类型的随机 ID:b…(shell)、m…(monitor)、a…(agent)加 8 位 base36 字符(如b7f3k9a2x1)。 - 不再跨会话复活。 后台任务撑不过会话重启/重载 —— 任何原因的会话关闭都会杀掉所有运行中的任务。注册表纯粹在内存里;
/tmp/pi-bg/*.log日志文件留给操作系统自己清理(24 小时旧日志清扫也一并移除)。 - 完成通知改为独立的
<task-notification>消息,在轮次中途送达(pi 的 steer 模式)—— 代理在工具调用之间就能作出反应。回合边界的合并汇总和空闲合并窗口都没了。
引擎
- 靠
notified闩锁(CC 的markTaskNotified)保证恰好一次:用jobs output/attach读过已结束作业的输出,就会抑制其待发的通知;已完成但未读的作业在jobs list和侧边栏显示, unread;已通知的终止作业从实时列表移除(近期的仍留在 recent-terminal 环里)。 - shell/monitor/agent 三种类型统一进一个内存注册表(
jobs list每行带[shell|agent|monitor]标签),单一通知引擎(src/notify.ts),spawn 改用exit事件,守护化孙进程再也拖不住作业。 - Ctrl+Shift+B(及
/bg)现在把所有正在运行的前台命令转后台,而不只是最近那条。 - 面向用户的字符串全部对齐 CC(手动转后台、
jobs kill、未知 ID 报错、完成摘要、卡顿警告);超时强杀会在日志里留下Command timed out after Ns,让模型能把超时和失败区分开。
1.1.2 —— 一条汇总,而非一墙通知
- 后台通知在回合边界合并。 在一次长回合中完成的作业和监视器,不再在回合回复后堆出一墙
[job-finished]/[bg-monitor-event]。它们会先累积,在回合结束(agent_end)时合并为一条汇总——"4 background events — 1 completed (job-19), 1 failed (job-30 exit 1); 2 monitors ended (API health, port 4000)." 代理空闲时则用一个短窗口合并。监视器的流事件(你正在盯的匹配行)保持实时。 - 一个守卫会清空那些被异常结束的回合滞留下来的通知,确保不会有通知被卡住而未送达。
1.1.1 —— 对齐修复、防数据丢失、实时进度
- 侧边栏实时进度。 运行中作业的标签现在显示其最新输出行(每秒刷新),而不只是命令——长轮询/构建的进度一目了然(
◉ qdrant: {"indexed":8540629,"status":"grey"} (2m10s))。ANSI/控制序列会被剥离,保持组件整洁且无法被转义注入。 - 不再有滞留的
sleep作业。 朴素的sleep N等待(即使是嵌入式的——cd x; sleep 600; check、换行分隔、或后台运行)现在在bash与bash_bg两侧都会被拦截,并引导到会随工作一起结束的工具:jobs attach、monitor工具,或会在就绪时退出的until循环。真正轮询循环内部的 sleep 绝不会被误拦。 - 取消行为对齐 Claude Code(已对照 CC 源码验证)。 按 Esc 会杀掉正在运行的前台命令(一次有意的取消),而输入新消息、Ctrl+Shift+B 或自动后台超时则改为把它移到后台——正是 CC 的
user-cancel与interrupt之分。长任务靠超时自动后台 +run_in_background来保护,而不是忽略取消。
1.1.7 —— Ctrl+Shift+B(pi 保留键位修复)
- 后台快捷键从 Ctrl+B 改为 Ctrl+Shift+B。 新版 pi 把
ctrl+b保留为编辑器内置的光标左移(tui.editor.cursorLeft),扩展占用该键时会在启动时打印 “extension shortcut conflict” 诊断,并且会让 pi 编辑器里的光标左移悄悄失效。其余不变:实时提示改为(ctrl+shift+b to run in background),/bg在任何环境下可用(在没有 extended-keys 的 tmux 里请用/bg)。
1.1.0 —— monitor 工具 & 合并完成通知
- 新增
monitor工具 —— Claude Code 一分为二中的“流式”那一半:每一行 stdout(或每个 WebSocket 帧)在发生时即变成一条通知。用于逐事件的数据流(tail -f | grep、轮询循环、文件监视、ws 数据流),而一次性的“完成时告诉我”仍交给run_in_background。支持command/ws源、persistent监视、timeout_ms截止时间、按行精确跟随,以及刷屏时自动停止。在侧边栏和jobs管理器中以◉标记显示。 - 不再有
[job-finished]的刷屏 —— 一批后台作业同时完成时,现在会合并成一条汇总通知,而不是在你下一条消息后堆出一行行陈旧的提示。 - 内部:将
MonitorSession抽取到MonitorSource接缝之后(command + ws 适配器),使流式/终止生命周期可被单元测试。零新增依赖(ws 使用运行时的全局WebSocket,Node 22+)。
1.0.2 —— Ctrl+B 对齐 & 更友好的 jobs
- 现在 Ctrl+B 是主后台快捷键(Ctrl+Shift+B 保留为别名),命令运行时输入框下方会浮现一行
(ctrl+b to run in background)提示,与 Claude Code 一致。在 tmux 里会附上"(twice)"说明。 jobs attach在等待时会流式输出作业的实时日志(以前是静默的),文案也改成了"Following … live output";中途分离后作业继续在后台运行。- 侧边栏胶囊实时跳动 —— 时长每秒更新,不再停在绘制时的那一刻。
- 作业完成/超时通知更紧凑了(一行代理 follow-up + 一个 UI 提示),让代理持续知情,又不刷屏。
1.0.1 —— 对齐 Claude Code(首个发布的 1.x)
重头戏。后台引擎从头到尾重写了一遍,对齐 Claude Code 的架构,零外部依赖。这是 npm 上的第一个 1.x,把这次对齐重写连同一整轮扎实的正确性、性能强化一并奉上。
重大变更
- 移除了 tmux。 后台作业现在以直接的 Node.js
child_process.spawn进程运行,用文件描述符捕获输出。tmux 不再使用、也不再需要 —— 没有什么要装的了。 - 默认自动转后台超时现在是 120 秒(原为 15 秒),与 Claude Code 看齐。想覆盖就显式传一个
timeout。 - 后台日志从
/tmp/pi-bg-<id>.log挪到了专用目录/tmp/pi-bg/<id>.log。
亮点
bash工具新增run_in_background: true参数。agent_bg现在实时流式回传进度,并会解析pi二进制路径(就算装在非标准$PATH下也照样能用)。- 协作式转向把你的消息作为一个 follow-up 轮次投递 —— 没有轮询循环。
- 后台作业并发上限为 16。
- 代码与 UI 全部改为纯英文。
修复与内部改进(重写后强化)
- 协作式转向不再杀掉它刚刚转入后台的那条命令。
- 生成失败(
ENOENT/EMFILE/EAGAIN)会被妥善处理,而不是把代理拖崩。 - 四条生成路径统一收拢进单个
startBackgroundJob服务函数;前台清理移进finally,任何退出路径都不会遗留作业。 - 日志搜索在各作业间并发执行,旧日志清扫也改成了有界异步。
0.3.1 及更早
基于 tmux 的后台作业、15 秒自动转后台、协作式转向,以及交互式作业管理器。
开发
git clone https://github.com/iefnaf/pi-bg.git
cd pi-bg
pnpm install
pnpm check # 类型检查
pnpm test # 运行测试需要 Node.js ≥ 22、pnpm ≥ 10。无需 tmux,也没有别的外部依赖 —— 你 clone 下来的就是你跑起来的。
贡献
欢迎提 PR。流程如下:
- Fork 仓库
- 建一个功能分支(
git checkout -b feat/my-feature) - 确保
pnpm check和pnpm test都通过 - 用 Conventional Commits 提交
- 向
main提 PR
许可证
MIT © patty.io & alexlikevibe
作者
alexlikevibe · GitHub
基于 pi-patty-bg-tasks(原作者 Patty)个人维护的分支。
