@andy8647/pi-toolbox0.3.3
Rounded transparent tool boxes for pi coding agent — frames every tool (including MCP), bash syntax highlighting, click a box to expand it alone
Untested on omp
This is a pi package. No one has reported whether it works on omp yet. If you try it, add your result below.
Reports 0
No reports yet.
Readme
pi-toolbox
Rounded transparent tool boxes for the pi coding agent — and a transcript that folds a reply's tool calls into one line you can click open.
Features
- Rounded borders — ╭╮╰╯ box drawing instead of pi's default ┌┐└┘
- Every tool box — built-in tools, MCP calls (pi-mcp-adapter), subagents, and any other extension's tools all get the same frame
- Every message box — compaction and branch summaries, skill invocations, and extension custom messages get the same frame, each kind in its own border color (user messages are left to pi-starline by default)
- Per-tool border colors — successful boxes take their tool's color (bash/read/edit/write/… configurable); pending stays grey, errors stay red
- Nerd Font icons — every box gets a kind icon; file tools show the target file's nvim-web-devicons glyph right in front of the path (
write /tmp/x.tsrenderswrite /tmp/x.ts) - Transparent background — no solid background fill, works with terminal transparency
- Grouped tool calls — every tool call between two pieces of assistant text collapses to one line
(
▸ 4 calls · bash×3 read×1 · 1.2s). Click it and it turns into a▾header with one row per call under a│gutter; click a row for that call's full box, the box to fold it back, the▾header to fold the whole group. The assistant's text always shows and is what separates groups, so you can still see a reply drifting; tool-only model steps don't split a group. Edits and writes never fold — their diff shows like any normal box (alwaysShowTools). Running and failed calls keep their own row under a folded summary (which also counts the failures), every row says what the call produced (12 lines,3 matches,exit 1), andctrl+ostill expands everything (and collapses back to the summary) - Background jobs — a call that starts a long-running process (pi-processes'
process start) shows the process's state on its row:◐ process ticker running 12s · READY matched, then✓ … exited 0 · 20s/✗ … exit 1/⊘ … killed SIGTERM. The summary spins while one runs (◐ 1 running), and the[process] …notification messages are folded into the row — pi-processes still delivers them to the model, toolbox just doesn't draw them twice - One-line boxes — collapsed boxes keep a single row of output (
bashResultLines), and a multi-line command plus(+N more lines, ctrl+o to expand), so a long tool call no longer owns the screen;ctrl+orestores the whole command - Bash syntax highlighting — commands get token-level coloring (commands, flags, strings, variables, operators, etc.)
- Click a box to fold it — clicks land on pi's own expand toggle at the right row, for every tool
including
renderShell: "self"ones (edit, MCP) - Scroll-safe caching — an unchanged box costs one line comparison per frame, nothing is re-framed
What it looks like
Checking the build first.
▸ 5 calls · bash×3 read×2 · 1 failed · 2.4s
│ ✗ bash pnpm test exit 1 · 1.8s
╭──────────────────────────────────────────────╮
│ src/app.ts │
│ -12 const retries = 3; │
│ +12 const retries = 5; │
╰──────────────────────────────────────────────╯
▸ 2 calls · bash×1 process×1 · ◐ 1 running · 0.1s
│ ◐ process dev-server running 42s · ready matched
Click ▸ 5 calls and it becomes a ▾ header with one row per call:
▾ 5 calls · bash×3 read×2 · 1 failed · 2.4s
│ ✓ bash git status --short 4 lines · 0.1s
│ ✓ read src/app.ts 120 lines · 0.0s
│ ✗ bash pnpm test exit 1 · 1.8s
│ …
Installation
pi install npm:@andy8647/pi-toolbox
Requires pi ≥ 1.1.0 (component mouse events, tool durations).
Or straight from the repo:
pi install git:github.com/Andy8647/pi-toolbox
Restart pi to activate.
Releasing
.github/workflows/publish.yml publishes to npm on a published GitHub Release,
using npm's Trusted Publisher (OIDC) — no NPM_TOKEN secret. Bump version in
package.json, tag vX.Y.Z, and publish the release; the workflow fails fast
if the tag and the manifest version disagree.
Configuration
Add a toolbox key to your ~/.pi/agent/settings.json; changes apply on /reload:
{
"toolbox": {
"enabled": true,
"highlightBash": true,
"frameMessages": true,
"frameUserMessages": false,
"icons": true,
"bashResultLines": 1,
"groupTools": true,
"alwaysShowTools": ["edit", "write"],
"backgroundJobs": true,
"hideJobNotifications": true,
"toolColors": {
"bash": "bashMode",
"read": "toolTitle",
"edit": "syntaxVariable",
"write": "syntaxVariable",
"grep": "syntaxOperator",
"find": "syntaxOperator",
"ls": "syntaxOperator",
"mcp": "customMessageLabel"
},
"messageBorderColors": {
"user": "toolTitle",
"compaction": "customMessageLabel",
"branch": "mdCode",
"skill": "accent",
"custom": "warning"
}
}
}
| Key | Type | Default | Description |
|---|---|---|---|
enabled |
boolean | true |
Enable/disable the extension |
highlightBash |
boolean | true |
Syntax-highlight bash commands |
frameMessages |
boolean | true |
Frame compaction/branch/skill/custom-message boxes like tool boxes |
frameUserMessages |
boolean | false |
Also frame user messages — off by default because pi-starline already restyles UserMessageComponent, and two render patches on one prototype fight over the output. Enable only without pi-starline |
icons |
boolean | true |
Nerd Font icons on every box. Requires a Nerd Font; set false otherwise |
groupTools |
boolean | true |
Fold the tool calls between two assistant text blocks (or a user message) into one summary line; click it for one row per call, a row for its full box, the box to fold it back, the ▾ header to fold the group. false renders every call as its own box |
backgroundJobs |
boolean | true |
A call that started a background job (pi-processes) shows the job's live state on its row and in the summary. Running or failed jobs keep their row while folded. The spinner turns once a second for a job's first 5 minutes, then stands still (a dev server can run for hours) |
hideJobNotifications |
boolean | true |
Don't draw a job's notification messages ([process] "ticker" matched stdout: READY) once its row shows them. Only drawing — the model still receives them. Jobs without a row keep their messages |
alwaysShowTools |
string[] | ["edit", "write"] |
Tools that never fold: they keep pi's own box (with the diff) and end the group before them, so later calls start a new one. [] folds everything |
bashResultLines |
number | 1 |
Visual lines of bash output shown while collapsed. pi's renderer hard-codes 5 with no setting; raise this for more context, 0 to hide output until you expand |
toolColors |
object | see above | Border color per tool name for successful executions (pending stays grey, errors stay red, unlisted tools take accent). When set, the map replaces the defaults — {} disables per-tool colors |
messageBorderColors |
object | see above | Per-kind message-box border colors; merged over the defaults |
All color values are theme fg color names (ThemeColor), so they follow the
active theme. Default palette rationale: tool boxes reserve green/red/grey for
execution status, so message kinds get hues that don't collide —
customMessageLabel (mauve, matching the [compaction] label) for
compactions, mdCode (peach) for branch summaries, accent (sky) for skill
invocations, warning (yellow) for extension notices.
How it works
pi builds one ToolExecutionComponent per tool call, no matter which extension
registered the tool. The extension API cannot wrap another extension's
renderers, so pi-toolbox patches that component's render instead — which is
why MCP and subagent boxes are framed too. Message boxes (compaction, branch
summary, skill invocation, extension custom message) never go through that
component; their own prototypes get the same treatment, with two exceptions
that keep their native styling: custom messages rendered by an
extension-provided renderer, and ! bash-mode executions, which already draw
their own border. User messages are skipped by default because pi-starline
patches the same prototype. Only bash is re-registered, purely to add syntax
highlighting to the command row.
An unchanged box returns its cached line array outright: pi re-renders the whole transcript on every frame, including every mouse packet while scrolling. Measured against unpatched pi at 300 boxes / 2400 lines: +0.03 ms per full render.
Grouping
Groups are derived at render time from transcript order — nothing is
persisted, so a reloaded session folds the same way. A boundary is a user
message or an assistant message with visible text; pi gives every model step its
own assistant message, and steps that only call a tool don't split a group.
ctrl+o and pi's own box clicks both arrive through setExpanded, which is how
the group levels stay in step with pi's per-box expand flag.
Background jobs
pi has no notion of a job that outlives its tool call, so background-jobs.ts
has a small provider interface. pi-processes is the one provider: its
processes:* events on pi's shared extension bus keep a row live, its persisted
ad-process:notification messages rebuild a reloaded session, and a process it
no longer knows reads not running. If that protocol changes, rows fall back to
plain tool rows.
Mouse
Clicks come from pi's own fullscreen mode (tuiMode: "fullscreen", pi ≥ 0.86
component mouse events); toolbox never turns on mouse reporting itself. Only left
clicks on its own rows are taken — presses and drags pass through, so text
selection works as usual. Without fullscreen there are no clicks: ctrl+o still
toggles every box.
Compatible themes
For the best transparent experience, set tool background colors to "" in your theme:
{
"toolPendingBg": "",
"toolSuccessBg": "",
"toolErrorBg": ""
}
License
MIT