pi-web-ui 0.80.1 → 0.81.0
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/CHANGELOG.md +69 -0
- package/README.md +257 -76
- package/README.zh-CN.md +236 -51
- package/deploy/nginx-subpath.conf +85 -88
- package/dist/server/mcp-bridge.js +45 -7
- package/dist/server/plugins.js +23 -2
- package/package.json +5 -3
- package/plugins/catalog.json +18 -0
- package/web/dist/assets/{TerminalPanel-DrYGGZSV.js → TerminalPanel-GQZf9XvH.js} +1 -1
- package/web/dist/assets/index-72bjWuR-.css +10 -0
- package/web/dist/assets/index-CiRSpf3e.js +347 -0
- package/web/dist/index.html +2 -2
- package/web/dist/assets/index-BFA8Pn_5.js +0 -347
- package/web/dist/assets/index-BduNm7_u.css +0 -10
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**English** | [简体中文](https://github.com/xing-shuyin/pi-web-ui/blob/main/README.zh-CN.md)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
_The polished browser cockpit for the [pi coding agent](https://pi.dev)._
|
|
8
8
|
|
|
9
9
|
<p>
|
|
10
10
|
<a href="https://www.npmjs.com/package/pi-web-ui"><img src="https://img.shields.io/npm/v/pi-web-ui?color=cb3837&logo=npm&label=pi-web-ui" alt="npm version"></a>
|
|
@@ -37,22 +37,25 @@ theme switching, and a full settings panel — tuned for daily development.
|
|
|
37
37
|
|
|
38
38
|
## ✨ Highlights
|
|
39
39
|
|
|
40
|
-
| 💬 **Chat that works like you do**
|
|
41
|
-
|
|
|
40
|
+
| 💬 **Chat that works like you do** | 🖼️ **Files & images** | 🧩 **Extensible by design** | 🔒 **Private by default** |
|
|
41
|
+
| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
42
42
|
| Streaming replies, steer & follow-up queueing, slash commands, multiple conversations per project, edit-&-re-ask. | Attach files, paste images, ask about pictures (vision bridge), preview anything with GBK fallback. | Drop-in UI **plugins** (extra top-bar tabs + agent tools) and standalone **themes** — no rebuild, no restart. | Loopback-only, credential-safe: provider keys & headers never reach the browser. |
|
|
43
43
|
|
|
44
44
|
## 📚 Table of Contents
|
|
45
45
|
|
|
46
46
|
- 🚀 [Features](#features)
|
|
47
|
+
- ⌨️ [Keyboard shortcuts](#keyboard-shortcuts)
|
|
47
48
|
- 🖼️ [Screenshots](#screenshots)
|
|
48
49
|
- 📦 [Install](#install)
|
|
49
50
|
- ⚡ [Quick start](#quick-start)
|
|
50
51
|
- 🖥️ [System service](#system-service)
|
|
52
|
+
- 🐳 [Docker](#docker)
|
|
51
53
|
- 🧩 [Plugins](#plugins)
|
|
52
54
|
- 🎨 [Themes](#themes)
|
|
55
|
+
- 🔧 [Tuning & advanced environment variables](#tuning--advanced-environment-variables)
|
|
53
56
|
- 🔒 [Security](#security)
|
|
54
|
-
- 🪪 [Code signing policy](
|
|
55
|
-
- 🔐 [Privacy](
|
|
57
|
+
- 🪪 [Code signing policy](#-code-signing-policy)
|
|
58
|
+
- 🔐 [Privacy](#-privacy)
|
|
56
59
|
- 🌐 [Reverse proxy (nginx)](#reverse-proxy-nginx)
|
|
57
60
|
- 🤝 [Contribute](#contribute)
|
|
58
61
|
- 📄 [License](#license)
|
|
@@ -70,7 +73,30 @@ theme switching, and a full settings panel — tuned for daily development.
|
|
|
70
73
|
- Long threads auto-collapse messages older than 30 into lazy summary rows (click to expand).
|
|
71
74
|
- Question navigation — a floating rail plus per-question tags to jump between questions.
|
|
72
75
|
- **Prompt templates** — the empty chat state shows a one-click template gallery (repo init, code review, research, merge conflicts…); click a card to fill the input, or save the current draft as your own template.
|
|
73
|
-
- **Auto-retry on model errors** — configurable retry count per conversation; when retries run out the failed turn is marked red with a one-click Retry button.
|
|
76
|
+
- **Auto-retry on model errors** — configurable retry count per conversation (default 6, `0` = fail immediately); when retries run out the failed turn is marked red with a one-click Retry button.
|
|
77
|
+
- **Queue control** — a queued steer/follow-up bubble can be dropped (✕) or **recalled (↩)**, which pulls its text back into the composer (appended on a new line if you already typed something — it never overwrites your draft).
|
|
78
|
+
- **Message anatomy** — each message header shows the role, the model that produced it and a local `HH:MM` timestamp, and every text block has a copy button. Attachments render as their own collapsible card with a mode chip (`lines` / `ref` / `bridged` / `inline n lines`), a copy button and a vision-bridge “transcribed” note; a skill invocation becomes a skill card with the full `SKILL.md`, next to the arguments you typed.
|
|
79
|
+
- **Compaction, visible** — compacted context shows up as a card (“compacted from N tokens”) that auto-expands and jumps when it arrives, and a live banner counts up (“compacting context · 12s”) naming the trigger (manual / threshold / overflow).
|
|
80
|
+
|
|
81
|
+
### 🗂️ Projects & sessions
|
|
82
|
+
|
|
83
|
+
- **Switching projects** — the workspace root (what the agent reads/writes and where the terminal starts) changes without a restart:
|
|
84
|
+
- **Bottom-right path in the status bar** — click `📁 <path>` to open the folder picker: type a path (`Tab` completes), `↑` goes up one level, `💻` jumps to the computer root so you can change drives, click a folder to enter it and hit **Select** — or **Select this folder** to take the folder you are browsing. **+ New folder** creates a directory on the spot; `Esc` or a click outside closes it.
|
|
85
|
+
- **Right panel file tree** — right-click any folder → **Open as project** (the same menu has **Upload files to this folder**).
|
|
86
|
+
- **Left panel → Recent projects**, or `/cwd <path>` from the input box (`/cwd` alone reports the current directory).
|
|
87
|
+
- The startup default comes from `--cwd <dir>` / `PI_WEB_CWD`.
|
|
88
|
+
- **Conversations run in parallel** — each conversation has its own agent runtime and keeps streaming after you switch away; up to 8 can be open per project (subagents don't count).
|
|
89
|
+
- **Running list** — grouped by project (the current one first), with subagent children indented under their parent, badges for subagent / error (the tooltip carries the reason) / streaming, inline rename (✎) and a scoped ✕ that offers “dismiss finished subagents only” or “force-dismiss everything” (a second confirmation while a run is streaming). Right-clicking a row scopes the menu to that conversation's subtree.
|
|
90
|
+
- **History** — sessions are read from `<agentDir>/sessions/--<cwd>--/`, i.e. the same transcripts the pi CLI/TUI writes, so the browser and a terminal `pi` session share one list per project. Rename (✎ — the same `session_info` entry pi's `/name` writes) and two-step delete.
|
|
91
|
+
- **Recent projects** — stored per browser, merged with every directory that has transcripts, minus the ones you removed (tombstones) and the ones that no longer exist, sorted by last use (20 shown, 30 stored).
|
|
92
|
+
- **Coming back** — reconnecting restores the last workspace the browser used (with a notice), the tab title can show the project folder, and each project remembers its own model + active provider key for _new_ chats (a chat that already has messages keeps its own model).
|
|
93
|
+
- If the server was shut down mid-answer, the next attach reports it once (“last run was interrupted”) instead of leaving a silent gap in the history.
|
|
94
|
+
|
|
95
|
+
### 🔎 Search & navigation
|
|
96
|
+
|
|
97
|
+
- **Global search (Ctrl/Cmd+K)** — one box, three sources: conversation transcripts (full text, assistant output included; up to 50 hits, each with a jump anchor), recent projects, and workspace file names (bounded walk: 50 results / 20 000 entries / 4 s / depth 24 — it tells you when it truncated instead of hanging). ↑/↓ then Enter to open, Esc to close. Clicking a conversation restores it and jumps to the matching message, a project switches the workspace and re-runs the search, a file opens its preview.
|
|
98
|
+
- **In-conversation search (Ctrl/Cmd+F)** — searches the text actually rendered in the open chat (case-insensitive, highlighted through the CSS Custom Highlight API), Enter / Shift+Enter to step through hits, Esc to close. Messages collapsed by the summary view are indexed from their message data, so long threads stay searchable without force-expanding everything — only the message you land on is expanded.
|
|
99
|
+
- **Long-thread ergonomics** — messages older than 30 collapse into one-line summary rows (with thinking / tool / bash / image counts and a 90-character preview), the question rail lists every question you asked, a “back to bottom” chip appears once you scroll up, the list follows streaming output only while you are pinned to the bottom (a real scroll-up is respected), and messages far outside the viewport are swapped for equal-height placeholders.
|
|
74
100
|
|
|
75
101
|
### 🤖 Subagents & templates
|
|
76
102
|
|
|
@@ -85,19 +111,68 @@ theme switching, and a full settings panel — tuned for daily development.
|
|
|
85
111
|
- Attach arbitrary files without a workspace path — stored in a global uploads dir, inlined when small, referenced by absolute path otherwise.
|
|
86
112
|
- File preview — line numbers, click/drag/Shift selection (add to chat as `lines`), GBK fallback decoding, binary hex view, media preview over HTTP with Range support, and a download button.
|
|
87
113
|
- Live file tree — the server watches the listed directory (`fs.watch`) and re-lists on change; oversized directories show a truncation warning.
|
|
114
|
+
- **Browse anywhere** — the tree climbs past the workspace root to a 💻 “This computer” level that lists every mounted drive (`/` on POSIX), the breadcrumb jumps straight to any level, `..` goes up, and a listing that vanished or lost its permissions degrades into an empty list plus a warning instead of an error page.
|
|
115
|
+
- **Row actions** — hover a file for download / attach inline (+) / attach as reference (🔗) / copy name / copy path; folders offer reference-attach, copy name and copy path (copying falls back to a hidden textarea on plain-HTTP origins where the clipboard API is unavailable).
|
|
116
|
+
- **Upload from the tree** — right-click a **folder row** → **Upload files to this folder** (that folder's menu also offers **Open as project**), or right-click a file row / the panel body → **Upload files to current directory** (the directory you are browsing). Dragging OS files onto a folder row uploads into exactly that folder (the row highlights), dropping them on the panel uploads into the browsed directory, and dragging a _folder_ warns that folders aren't supported instead of doing nothing. Uploads accept one file up to 100 MB, refuse empty files, strip the name to a basename with Windows-illegal characters replaced (200-char clamp), create the target directory if needed, and refresh the listing afterwards even if you are browsing somewhere else.
|
|
117
|
+
- **Listings that stay honest** — on Windows/macOS a recursive watcher on the workspace root refreshes the tree for changes in _any_ subdirectory (400 ms debounce), with a 10 s polling fallback — announced once per workspace — on network drives where watching isn't supported; POSIX hides build noise (`node_modules`, `.git`, `dist`, `.venv`, …) and caps at 500 entries, Windows hides only dependency/VCS/data directories and caps at 2000, and both say when they truncated.
|
|
118
|
+
- **The preview is an editor too** — text files can be edited in place and saved with Ctrl/Cmd+S (2 MB cap, dirty-guarded; closing with unsaved changes asks first), Markdown toggles between rendered and source, HTML renders in a sandboxed iframe through a directory-mapped URL so relative CSS/images resolve (with a per-file “enable scripts” opt-in that never grants same-origin), images and videos stream over HTTP Range, binaries get a hex dump, and text gets line numbers, selection by click/drag/Shift (add to chat as `lines`), zoom 50–200 %, a word-wrap toggle and fullscreen.
|
|
119
|
+
- **Download without Safe Browsing fights** — downloads fetch the bytes and use the browser's save picker where available (falling back to a blob link, and to native streaming above 200 MB), sanitize Windows-illegal file names and report a cancelled dialog as “not an error”.
|
|
88
120
|
|
|
89
121
|
### 🖥️ Terminal & Git
|
|
90
122
|
|
|
91
|
-
- Built-in terminal (xterm.js + node-pty) with per-client PTY management; Windows
|
|
92
|
-
- **
|
|
123
|
+
- Built-in terminal (xterm.js + node-pty) with per-client PTY management; on Windows it picks Git Bash, falls back to a bundled busybox download, then `cmd`. Up to 16 live terminals (agent-opened ones don't count), each keeping its own 8000-line scrollback while you switch tabs; tabs can be renamed inline, closed (which really kills the process) and show their exit code in the scrollback.
|
|
124
|
+
- **Saved commands** — the sidebar's upper half is the project's `.pi/commands.json` list (`name` + `command` + `cwd`, `${pwd}` expands to the workspace): click a row to run it (a same-titled tab is reused and restarted, VS Code task style), add/edit/delete entries, and reload the file from disk.
|
|
125
|
+
- **AI bash grouping** — terminals the agent opens through its bash takeover are folded into an “AI bash” group so they don't bury your own tabs.
|
|
126
|
+
- **Terminal-backed bash** (Settings → Tools, off by default) — the agent's `bash` tool then runs inside a visible persistent terminal instead of a hidden process, so shell state (`cd`, venv, ssh) survives between calls; a silence threshold (default 15 s, `0` = wait forever) moves a quiet command to the background, and `head`/`tail` trim what the model has to read.
|
|
127
|
+
- **Liveness detection** — when a terminal the agent is using goes silent while the chat is still streaming, the server steers the AI with the tail of its output (“read it / answer it / close it”) instead of letting the turn hang.
|
|
128
|
+
- **Source control (Git) panel** — status / branch / diff / history / untracked files via a hidden query terminal, plus per-file stage (+) and unstage (−), a commit box (Enter commits, IME-safe) with “Commit all” (`git add -A && git commit`), a branch picker that groups local and remote-tracking refs (picking a remote one creates a local branch tracking it), and detached-HEAD / `↑ahead ↓behind` badges. The “Commit tree” tab loads `git log --graph` with per-commit diffs. Writes (commit / branch switch / push / pull) run in the visible terminal and the view follows them there; the panel refreshes itself when the repository's real git dir changes (worktrees included) and via a 30 s fallback poll, so commits made outside the browser show up by themselves.
|
|
93
129
|
|
|
94
130
|
### 🎛️ Models & settings
|
|
95
131
|
|
|
96
132
|
- Theme switching — pick a theme in the top bar; themes are pure `:root` palette overrides on top of the single layout stylesheet (default dark + bundled light/dark palettes). See [Themes](#themes) for how to add your own or contribute one.
|
|
97
133
|
- Model management — edit `models.json` in the UI and set per-provider API keys (keys/headers never leave the server).
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
134
|
+
- **Model picker** — searchable by name/provider/id, with a provider sidebar once you have several providers; models you pick often float to the top with a “used N×” badge plus reasoning/vision badges, opening it scrolls to the active model, and the footer keeps **Refresh models** and **Manage models**.
|
|
135
|
+
- **Several keys per provider** — built-in providers can store multiple named keys (`<agentDir>/provider-keys.json`): add a second key without losing the first, activate another by name, remove one (dropping the active key promotes the next). The picker lists each key separately, so picking a model under a key switches to it — and only nicknames reach the browser.
|
|
136
|
+
- **Custom providers** — add/edit/delete a provider (API type, `baseUrl`, key, optional auth header) with per-model metadata (context window, max output, text/text-image, reasoning); **Fetch models** probes `/models` _server-side_ (so a LAN/loopback endpoint works despite CORS) and merges what it advertises, and an existing provider can be re-probed in place. Hand-edited `models.json` is picked up with **Reload models.json** (comments allowed, like the SDK).
|
|
137
|
+
- Thinking level per model — seven levels, but the ones the current model doesn't support are shown disabled rather than silently snapped to another.
|
|
138
|
+
- First-run setup wizard — installs the pi CLI for you when it's missing (with failure detail, Retry and Skip) and then takes a provider + API key so you can start immediately.
|
|
139
|
+
- Settings panel:
|
|
140
|
+
- **System prompt** — a `{{token}}` compose template over 11 sources (soul / tools / guidelines / pi docs / append / persona / terminal / markers / context / skills / cwd) with click-to-append token chips, per-source overrides (an `auto` badge, “seed from default”, per-source reset; environment-derived sources stay read-only), and two viewers showing the prompt actually in effect and the tool schema actually sent to the model.
|
|
141
|
+
- **Input history & quick phrases** — a bounded history (1–500 entries, optional per-entry character cap, two-step clear) that ↑/↓ walks through when the caret sits on the first/last **visual** line of the draft (auto-wrapped lines count), and the chips above the composer (edit / reorder / delete / reset to defaults).
|
|
142
|
+
- **Skills** — per-skill switches plus a **Full** chip that injects a whole `SKILL.md` into the prompt instead of its catalog line (8 KB per file, 32 KB total).
|
|
143
|
+
- **Extensions** — per-extension switches, and one-click uninstall for `npm:`-installed ones (runs `pi remove npm:<pkg>` in a reusable terminal tab).
|
|
144
|
+
- **UI plugins**, **goal review**, **vision bridge** and **subagent templates** have their own pages — see [Plugins](#plugins).
|
|
145
|
+
- **Presets** — save the current combination (prompt template/mode/overrides, skill & extension switches, tool switches, terminal-bash settings, retry count, reviewer prompt, skill full-text list) under a name and re-apply or delete it; deliberately _not_ captured (questionnaire, goal mode, display prefs, vision bridge, default subagent model, quick phrases) stay as they are.
|
|
146
|
+
- **Apply timing** — tool switches, retry count, display preferences, markers and the skill full-text list apply immediately; the prompt template/overrides and skill/extension switches need a session reload, and a change made mid-answer is deferred with a “takes effect after this reply” notice.
|
|
147
|
+
- **Display preferences** — thinking blocks expanded or collapsed by default, tool cards expanded by default, wide chat column (drops the 860 px cap on very wide viewports), project name in the browser tab title, and a chat wallpaper (image URL or upload, with dim and blur sliders).
|
|
148
|
+
|
|
149
|
+
### 🧩 Agent tools & inline markers
|
|
150
|
+
|
|
151
|
+
- **Tool switches** — Settings → Tools lists every optional agent tool as its own switch: the 7 terminal tools (default **off**), the 7 `subagent_*` tools (default on), `edit_soft` (default off), `delegate_task`, `ask_user_question` and `todo_list` (default on). Toggling is live (no reload) and the tools stay registered so they can come back; `bash` and the SDK's own `edit`/`read` are deliberately outside the catalog and cannot be disabled.
|
|
152
|
+
- **Inline markers** — instead of a tool round-trip the AI writes state changes straight into its reply: `[[todo:new:<subject>]]` / `[[todo:set:<id>,in_progress]]` / `[[todo:remove:<id>]]` / `[[todo:dep:<id>,blocks=<id>]]` for the task list, `[[notify:<level>:<message>]]` for a non-interruptive notice, and `[[conv:rename:<title>]]` to retitle the chat. Markers are applied as soon as a reply bubble is final, a bad marker comes back as a browser notice, and the task list also renders as a live widget under the file tree (`N/M done` with ✓ / ◐ / ○) that follows the active conversation and survives a reload — it is stored in that conversation's own session branch. Settings → Tools has a master switch plus one switch per marker (these are global, shared by all browsers).
|
|
153
|
+
- **`edit_soft`** — a looser `edit` (default off) for when indentation or whitespace makes the built-in tool fail: exact substring first, then trimmed line-core matching, `newText` written verbatim with the file's line endings/BOM preserved, and a diff + unified patch in the result. It also tolerates sloppy input (a JSON string, a bare object, legacy top-level `oldText`/`newText`).
|
|
154
|
+
- **`delegate_task`** — hands a specialist template a six-section brief (TASK / EXPECTED OUTCOME / REQUIRED TOOLS / MUST DO / MUST NOT DO / CONTEXT) validated on the server: a missing template, a task under 20 characters or any empty section is rejected, and the error tells the model which templates it may use. Cards render the brief as labelled sections, and a finished delegation gets a button that jumps to the subagent's conversation.
|
|
155
|
+
- **`ask_user_question`** — the pi engine has no questionnaire tool, so pi-web-ui adds one: the model asks structured questions (single/multi-select with rich option previews, plus free text) which open as a dialog; answers go back as the tool result, cancelling returns a tool error, waiting for you is exempt from the tool watchdog, and an unanswered questionnaire survives a page refresh or reconnect.
|
|
156
|
+
- **MCP servers** — drop a `<dataDir>/mcp.json` (`{"servers":{"github":{"command":"node","args":["mcp.js"],"cwd":"/x"}}}`) and every tool a stdio MCP server advertises becomes an ordinary agent tool, executed server-side; one server failing to start only logs a line and leaves the others working. The file is read at startup, so restart pi-web-ui after editing it.
|
|
157
|
+
- **Extension UI bridge** — pi extensions can drive the browser: `setWidget` renders live panels under the file tree (click a title to open it centred), `setStatus` puts text in the status bar, `notify` raises a toast, and `select` / `confirm` / `input` open an inline request panel above the composer with Markdown-rendered options (Esc cancels). ANSI colour codes in widget text are stripped, so extension footers don't arrive as escape-sequence noise.
|
|
158
|
+
- **Plugin extras** — plugins can register `/commands` (badge “plugin”, executed server-side without spending tokens), register background tasks with their own stop button, declare a settings form, subscribe to run/tool/conversation events, and reach the host from their client bundle via `window.__piWebUiHost`. See [Plugins](#plugins).
|
|
159
|
+
|
|
160
|
+
### 🔔 Sounds & notifications
|
|
161
|
+
|
|
162
|
+
- **Sound alerts** — a master switch plus one cue per event (question asked / run finished / run started / error), each with its own preview button, and a volume slider (0–100 %).
|
|
163
|
+
- **Desktop / OS notifications** — off by default; enabling them asks the browser for permission from the click itself and switches back off (persistently) if you deny it. Notifications go through the service worker, so they also work when the installed PWA is in the background, they cover run-finished / question-asked / error, and clicking one brings the app window back to the front. They are suppressed while you are demonstrably watching the page — including the Windows case where the browser still reports focus and visibility while the window is minimised (detected from the native window rectangle instead).
|
|
164
|
+
|
|
165
|
+
### 📱 PWA & offline
|
|
166
|
+
|
|
167
|
+
- **Installable** — a web-app manifest (standalone window, 192/512/1024 + maskable icons, `./`-relative so sub-path deployments work) means “Install app” in Chrome/Edge or “Add to home screen” on mobile gives you its own window and icon.
|
|
168
|
+
- **Offline app shell** — the service worker serves navigations network-first with a cached shell fallback (the app reopens while your backend is down or restarting) and caches hashed assets cache-first, while never caching `/ws`, `/api`, `/themes` or `/plugins`; a new worker takes over already-open pages immediately.
|
|
169
|
+
- **Refresh prompts when they matter** — a persistent banner appears if the page was loaded from a build whose wire protocol differs from the server's (i.e. right after an update), and the browser tab title can show the current project folder.
|
|
170
|
+
|
|
171
|
+
### 🌍 Languages & language packs
|
|
172
|
+
|
|
173
|
+
- The top-bar language menu lists every language by its native name, and **Get more languages** opens a manager showing each downloadable pack's version with Download / Remove buttons (and a Refresh button) — packs land in `<dataDir>/locales/`, so you can also drop a valid pack file there by hand for a fully offline install.
|
|
174
|
+
- A first-time visitor without a stored choice gets the language their browser asks for, then the instance default (`PI_WEB_LOCALE`), then English; once you pick one it sticks.
|
|
175
|
+
- The server renders AI-facing text (tool return values, prompt sections, notices) in the same language, so a Chinese UI also gets Chinese answers from tools like `subagent_list`.
|
|
101
176
|
|
|
102
177
|
### 🎯 Goal mode
|
|
103
178
|
|
|
@@ -114,50 +189,87 @@ theme switching, and a full settings panel — tuned for daily development.
|
|
|
114
189
|
- **Question dialog** — the model's `ask_user_question` surfaces as a browser dialog (single/multi-select + free text) with queueing and a countdown.
|
|
115
190
|
- **Tools & MCP bridge** — plugin AI tools and external MCP servers (`mcp.json`) are bridged into the DSH runtime, so the DSH model can call them (executed server-side).
|
|
116
191
|
- **Skill enable/disable** — the DSH skill catalog is exposed in Settings; disabling a skill filters it out of the model's view at runtime.
|
|
117
|
-
- **DSH user patches** — drop `.yml` Cordis patches into `<dataDir>/dsh-patches/` to extend the runtime and reload from Settings.
|
|
192
|
+
- **DSH user patches** — drop `.yml` Cordis patches into `<dataDir>/dsh-patches/` to extend the runtime and reload from Settings; the Settings → Plugins page lists them with size/mtime and the resolved path, and a broken file is skipped with its error on the runtime's stderr.
|
|
193
|
+
|
|
194
|
+
**How DSH differs from the pi engine** (worth knowing before you switch):
|
|
195
|
+
|
|
196
|
+
- Thinking intensity is fixed to `high` — asking for another level answers “DeepSeek V4 only supports high thinking”.
|
|
197
|
+
- The footer's token/cost/context figures come from DeepSeek's published per-million pricing against a 1M-token window.
|
|
198
|
+
- Opening a past session replays it read-only: sending a prompt starts a **new** branch with the old conversation injected as context, because the runtime has no in-place resume. The same applies to edit-&-re-ask.
|
|
199
|
+
- **Stop** kills the runtime process tree, so every running DSH conversation stops (you get a notice), and a half-finished goal is cleared first. Stopping only the bash tool isn't supported.
|
|
200
|
+
- Sessions live in `<dataDir>/dsh-sessions/` (separate from the pi engine's transcripts) and are swept after `PI_WEB_DSH_SESSION_RETENTION_DAYS` (90); open conversations are capped at 8 per project; a crashed runtime is restarted with 1 s/3 s/9 s back-off, at most twice per 60 s, then it stops and points you at the API key and the DSH dependencies.
|
|
201
|
+
- The tool runs in a `workspace-write` sandbox with approvals off — your Stop button is the control. Questionnaires are a one-question-at-a-time wizard with option previews and a countdown.
|
|
202
|
+
- pi-only features answer with an explicit notice (and their UI is hidden) instead of failing silently: session rename, `/compact`, `/reload`, extension hot-reload, subagent templates, custom providers / multiple keys, provider model probing, installing the pi CLI, the vision bridge and the per-tool switches.
|
|
118
203
|
|
|
119
204
|
### ⚙️ Background tasks
|
|
120
205
|
|
|
121
|
-
- Background-task panel — servers launched by the agent are detected
|
|
122
|
-
-
|
|
206
|
+
- Background-task panel — servers launched by the agent are detected by diffing the listening ports before and after a bash run and listed with port / pid / name / command (click the command to expand it fully); stop one or kill all, and the top-bar chip carries a live count badge.
|
|
207
|
+
- The list belongs to the browser client, not the conversation: it survives project switches, conversation switches and reconnects, and is refreshed server-side every 30 s with processes that exited pruned. Detection deliberately ignores known desktop apps and processes whose parent chain traces back to `explorer` rather than to the server, so a browser you opened yourself isn't reported as “started by the agent”.
|
|
208
|
+
- Plugin-registered tasks show a 🧩 marker and their live status text, and stop through the plugin's own callback (a mail-polling task, for instance).
|
|
209
|
+
- Tool watchdog — a tool call running over 20 minutes is aborted automatically (`PI_WEB_TOOL_TIMEOUT_MS`; questionnaires are exempt).
|
|
123
210
|
- **Stop bash command only** — abort a running bash tool without killing the conversation.
|
|
211
|
+
- **Stall warning** — if a streaming run goes completely silent for 3 minutes (`PI_WEB_STALL_NOTIFY_MS`, `0` = off) you get a warning naming the conversation, without aborting it.
|
|
124
212
|
|
|
125
213
|
### 🛡️ Safety & operations
|
|
126
214
|
|
|
127
215
|
- Loopback-only by default; set `PI_WEB_HOST=0.0.0.0` for LAN / containers.
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
216
|
+
- **Token auth** — `PI_WEB_TOKEN` accepts any of `Authorization: Bearer …`, `X-PI-Token: …`, `?token=…` or the `pi_web_token` cookie. A `?token=` link logs you in once, strips the token from the address bar and stores the cookie; every authorised request refreshes it and a stale cookie is expired on the 401 response, so after changing the password one correct `?token=` visit recovers permanently. `/api/health` stays open for probes.
|
|
217
|
+
- WebSocket Origin/Host same-authority check — cross-origin pages are rejected (403), `Origin: null` (a `file://` page) is rejected outright, and when a token is configured a bad credential is refused _before_ the upgrade; `PI_WEB_ALLOW_ORIGINS` whitelist for reverse proxies.
|
|
218
|
+
- **Host allow-list** — `PI_WEB_ALLOW_HOSTS=host1,host2` adds a strict hostname allow-list on top of the always-on same-authority check.
|
|
219
|
+
- **Instance scoping** — `PI_WEB_TABS=chat,terminal,git` exposes only those tabs: hidden tabs are also refused _server-side_ (their messages answer with an explanation), and `chat` can never be switched off. `PI_WEB_MANAGED=1` declares the instance as deployed from outside: the server refuses self-update, pi-CLI installs and marketplace installs with a reason, and the UI hides those entry points (the version chip becomes a plain label saying the deployment owns updates).
|
|
220
|
+
- **File boundaries** — workspace-relative reads/writes reject `..` escapes (a path outside the workspace is only reachable through explicit absolute / machine browsing); inline `/api/file` streaming is limited to images, video and HTML, so a binary can never be smuggled through an `<img>` tag — anything else needs `?download=1` (attachment disposition). The HTML preview route is always served sandboxed.
|
|
221
|
+
- Quiesce drain mode via a local control socket (`server status|quiesce|unquiesce`) — refuses new prompts/forks/resumes (and, on the DSH engine, brand-new client connections) while in-flight runs finish.
|
|
222
|
+
- Credentials stay server-side — provider headers (which may carry `Authorization`) are never sent to the browser, and provider API keys reach it only as nicknames.
|
|
223
|
+
- 9 UI languages — Chinese/English built in, plus 8 downloadable packs (German, Spanish, French, Italian, Japanese, Korean, Portuguese, Russian); the top-bar language menu installs or removes packs — see [Languages & language packs](#-languages--language-packs).
|
|
224
|
+
- **Retention** — uploaded files older than `PI_WEB_UPLOAD_RETENTION_DAYS` (14; `0` = never) are swept at startup and every 6 h; DSH sessions have their own 90-day sweep.
|
|
225
|
+
- **Operational watchdogs** — tool timeout, model-stall warning and terminal liveness are all tunable, see [Tuning & advanced environment variables](#tuning--advanced-environment-variables).
|
|
132
226
|
|
|
133
227
|
### 🚢 Deploy & update
|
|
134
228
|
|
|
135
|
-
- Foreground, global npm install, Docker (docker
|
|
136
|
-
-
|
|
137
|
-
|
|
229
|
+
- Foreground, global npm install, Docker (see [Docker](#docker)), macOS launchd, Linux systemd, Windows autostart (a per-user `Run` key with a console-free launcher and a crash watchdog), and a desktop shortcut (`server shortcut`).
|
|
230
|
+
- `server install --print` prints the launchd plist / systemd unit / Windows launcher it _would_ write and exits, so you can review it before installing.
|
|
231
|
+
- **Update panel** — the version chip shows an amber dot when a newer web UI exists and a badge with how many _other_ components have updates. “Check all updates” compares the web UI, the globally installed pi core and the direct packages declared in `<agentDir>/npm/package.json`; each row has its own Update, plus “Update all” and “Re-check all”, and the commands run in a visible terminal (`pi update npm:<name>` for pi extensions — the only command that updates the copy pi actually loads — and `npm i -g <name>@latest` for the rest). A “just published (<30 min)” warning tells you npm's cached metadata may be stale. On an instance owned by launchd/systemd/the Windows watchdog there is also a **Restart service** button; on a foreground instance there isn't, because nothing would bring it back.
|
|
232
|
+
- **Plugin updates from the CLI** — `pi-web-ui plugins --check-updates` compares each installed plugin's recorded commit with the remote HEAD and prints the exact update command; every `install --force` snapshots the outgoing version into `<dataDir>/plugin-backups/` (newest 3 kept, and it auto-rolls back if the copy fails), so `pi-web-ui plugins --rollback <id>` can undo an upgrade.
|
|
233
|
+
- In the pi CLI there is also `/webui` (from the bundled `extensions/webui.ts`): `/webui` starts a server on the first free port from 8787, and `/webui --port 9000`, `--cwd <path>`, `--no-browser`, `status` and `stop` manage it — one subprocess per pi session, killed when the session shuts down so no orphan servers linger.
|
|
234
|
+
|
|
235
|
+
## Keyboard shortcuts
|
|
236
|
+
|
|
237
|
+
| Keys | What it does |
|
|
238
|
+
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
239
|
+
| `Enter` | Send. On touch-first devices `Enter` inserts a newline instead and `Ctrl/Cmd+Enter` sends (Windows touch laptops are treated as desktops). |
|
|
240
|
+
| `Shift+Enter` | Newline in the composer. |
|
|
241
|
+
| `↑` / `↓` | Walk the global prompt history (persisted across conversations) when the caret is on the first/last **visual** line — auto-wrapped lines count, so `↑` inside a long one-paragraph draft moves the caret up a line instead of switching history; `Esc` returns to your draft. |
|
|
242
|
+
| `Ctrl/Cmd+K` | Global search over conversations, projects and workspace file names. |
|
|
243
|
+
| `Ctrl/Cmd+F` | Search inside the open conversation — `Enter` next hit, `Shift+Enter` previous, `Esc` closes. |
|
|
244
|
+
| `/` | Open the slash-command picker (`↑`/`↓` to move, `Tab` or `Enter` to complete, `Esc` to dismiss; typing a space closes it). |
|
|
245
|
+
| `Ctrl/Cmd+S` | Save while editing a file in the preview. |
|
|
246
|
+
| `Ctrl/Cmd+A` | Select all lines in the preview (when the caret isn't in a text field). |
|
|
247
|
+
| `Ctrl/Cmd+Enter` | Submit the edit-&-re-ask editor. |
|
|
248
|
+
| `Ctrl/Cmd+C` / `Ctrl/Cmd+V` | In the terminal: copy the current selection (no selection = `^C` goes to the shell) / paste natively. |
|
|
249
|
+
| `Esc` | Close the preview, a dialog, the command picker, a questionnaire or an extension request panel — with unsaved preview edits it asks first. |
|
|
250
|
+
| Drag & drop | Dropping files anywhere in the window attaches them to the chat; over the file tree it uploads into the folder you dropped on; folders can't be dropped (expand and pick files). |
|
|
138
251
|
|
|
139
252
|
## Screenshots
|
|
140
253
|
|
|
141
254
|

|
|
142
255
|
|
|
143
|
-
|
|
256
|
+
_Chat with prompt templates_
|
|
144
257
|
|
|
145
258
|

|
|
146
259
|
|
|
147
|
-
|
|
260
|
+
_Run trajectory timeline (run-trace plugin)_
|
|
148
261
|
|
|
149
262
|

|
|
150
263
|
|
|
151
|
-
|
|
264
|
+
_Settings panel_
|
|
152
265
|
|
|
153
266
|

|
|
154
267
|
|
|
155
|
-
|
|
268
|
+
_Built-in terminal_
|
|
156
269
|
|
|
157
270
|

|
|
158
271
|
|
|
159
|
-
|
|
160
|
-
|
|
272
|
+
_Git source control panel_
|
|
161
273
|
|
|
162
274
|
## Install
|
|
163
275
|
|
|
@@ -193,7 +305,7 @@ fight over port `8787`, separate data directory, both can run side by side.
|
|
|
193
305
|
**Nothing is code signed yet**: on Windows SmartScreen shows an “unknown
|
|
194
306
|
publisher” prompt, and on macOS you have to right-click → **Open** the app the
|
|
195
307
|
first time (Gatekeeper is stricter than SmartScreen) — see the
|
|
196
|
-
[code signing policy](
|
|
308
|
+
[code signing policy](#-code-signing-policy). Build it locally with
|
|
197
309
|
`npm run desktop:dist`.
|
|
198
310
|
|
|
199
311
|
### Termux (Android)
|
|
@@ -250,16 +362,17 @@ pi-web-ui # foreground, http://localho
|
|
|
250
362
|
**Start flags & environment variables** — every setting can be passed as a `--flag` on the command
|
|
251
363
|
line **or** set as an environment variable (flag wins). Pick whichever you prefer:
|
|
252
364
|
|
|
253
|
-
| Flag
|
|
254
|
-
|
|
|
255
|
-
| `--port <n>`
|
|
256
|
-
| `--cwd <dir>`
|
|
257
|
-
| `--data-dir <dir>`
|
|
258
|
-
| `--engine <pi\|dsh>` | `PI_WEB_ENGINE`
|
|
259
|
-
| `--host <addr>`
|
|
260
|
-
| `--agent-dir <dir>`
|
|
261
|
-
|
|
|
262
|
-
| _env only_
|
|
365
|
+
| Flag | Env var | Default | Purpose |
|
|
366
|
+
| -------------------- | --------------------- | ------------- | -------------------------------------------------------- |
|
|
367
|
+
| `--port <n>` | `PI_WEB_PORT` | `8787` | HTTP port |
|
|
368
|
+
| `--cwd <dir>` | `PI_WEB_CWD` | current dir | workspace root (read/write/terminal) |
|
|
369
|
+
| `--data-dir <dir>` | `PI_WEB_DATA_DIR` | `~/.pi-web` | data dir (UI state, plugins, uploads, themes, locales) |
|
|
370
|
+
| `--engine <pi\|dsh>` | `PI_WEB_ENGINE` | `pi` | agent engine; `--engine dsh` = DeepSeek Harness |
|
|
371
|
+
| `--host <addr>` | `PI_WEB_HOST` | `127.0.0.1` | listen address (`0.0.0.0` for LAN/Docker) |
|
|
372
|
+
| `--agent-dir <dir>` | `PI_CODING_AGENT_DIR` | `~/.pi/agent` | pi config dir (auth.json, models.json, sessions, skills) |
|
|
373
|
+
| `--no-browser` | — | off | start without auto-opening the browser |
|
|
374
|
+
| _env only_ | `PI_WEB_TOKEN` | empty | optional shared auth token |
|
|
375
|
+
| _env only_ | `PI_WEB_DSH_*` | — | dsh runtime, patches & debug settings |
|
|
263
376
|
|
|
264
377
|
The two are equivalent — pick one:
|
|
265
378
|
|
|
@@ -274,7 +387,7 @@ DeepSeek API key (read from `~/.pi/agent/auth.json`, set in the provider/API-key
|
|
|
274
387
|
**Stop**
|
|
275
388
|
|
|
276
389
|
- **Foreground**: press `Ctrl+C` in the terminal running it.
|
|
277
|
-
- **As a service**: `pi-web-ui server stop
|
|
390
|
+
- **As a service**: `pi-web-ui server stop`. On **Linux and Windows** auto-start is kept (the next login/boot brings it back, until `server uninstall`); on **macOS** `stop` unloads the launchd agent, so it no longer starts at login — `pi-web-ui server start` brings it back.
|
|
278
391
|
|
|
279
392
|
**Update**
|
|
280
393
|
|
|
@@ -289,9 +402,7 @@ pi-web-ui server restart # restart the service to apply it (foreground: res
|
|
|
289
402
|
npm uninstall -g pi-web-ui
|
|
290
403
|
```
|
|
291
404
|
|
|
292
|
-
Uninstalling does **not** delete your chats —
|
|
293
|
-
`<cwd>/.pi-web` (or `PI_WEB_DATA_DIR`) and survives uninstall/upgrade.
|
|
294
|
-
|
|
405
|
+
Uninstalling does **not** delete your chats: the transcripts you see in the history panel live in `<agentDir>/sessions/` (default `~/.pi/agent/sessions/`, per project), and the rest of your state — UI settings, recent projects, plugins, uploads, themes, language packs — lives in `<dataDir>` (default `~/.pi-web/`). Both survive uninstall, upgrade and reinstall; rerunning `pi-web-ui server install` afterward picks them up again (and if you plan to delete them, back up `sessions/` and `plugins/` first — an uninstall never touches either).
|
|
295
406
|
|
|
296
407
|
## System service
|
|
297
408
|
|
|
@@ -326,6 +437,31 @@ by hand. See the [start flags table](#quick-start) above.
|
|
|
326
437
|
pi-web-ui server install --engine dsh --port 9000 --cwd /path/to/project
|
|
327
438
|
```
|
|
328
439
|
|
|
440
|
+
## Docker
|
|
441
|
+
|
|
442
|
+
The image builds the frontend and the server, keeps the compiler toolchain `node-pty` needs, pre-installs the DSH runtime (so `PI_WEB_ENGINE=dsh` works without extra steps), runs as the non-root `node` user and declares `/app/.pi-web` as a volume:
|
|
443
|
+
|
|
444
|
+
```bash
|
|
445
|
+
docker compose up -d # then open http://localhost:8787
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
`docker-compose.yml` already sets `PI_WEB_HOST=0.0.0.0` (required for port mapping) and persists the data dir in the named volume `pi-web-data`. The commented blocks in that file cover the usual container tweaks — switching to the DSH engine, mounting a `dsh-patches` directory, mounting your project as `PI_WEB_CWD`, and mounting `~/.pi/agent` read-only as `PI_CODING_AGENT_DIR` so the container sees your API keys and model config:
|
|
449
|
+
|
|
450
|
+
```yaml
|
|
451
|
+
services:
|
|
452
|
+
pi-web-ui:
|
|
453
|
+
build: .
|
|
454
|
+
ports: ["8787:8787"]
|
|
455
|
+
environment:
|
|
456
|
+
PI_WEB_HOST: 0.0.0.0
|
|
457
|
+
# PI_WEB_ENGINE: dsh
|
|
458
|
+
volumes:
|
|
459
|
+
- pi-web-data:/app/.pi-web
|
|
460
|
+
# - ./my-project:/workspace:ro
|
|
461
|
+
# - ~/.pi/agent:/root/.pi/agent:ro
|
|
462
|
+
volumes:
|
|
463
|
+
pi-web-data:
|
|
464
|
+
```
|
|
329
465
|
|
|
330
466
|
## Plugins
|
|
331
467
|
|
|
@@ -342,13 +478,14 @@ up in the UI.
|
|
|
342
478
|
These plugins ship in this repository (`plugins/<id>/`) and can be installed
|
|
343
479
|
straight from GitHub:
|
|
344
480
|
|
|
345
|
-
| Plugin
|
|
346
|
-
|
|
|
347
|
-
| 📬 [webmail](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/webmail)
|
|
348
|
-
| 🗄️ [db-client](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/db-client)
|
|
349
|
-
| 📝 [vscode-editor](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/vscode-editor) | VS Code-like workbench: multi-root file tree (local + SSH hosts), CodeMirror multi-tab editor, Remote-SSH remote file browsing/editing, draggable multi-terminal panel (xterm.js), SFTP sync & upload/download to your computer. Auto-installs `ssh2`.
|
|
350
|
-
| 📊 [mermaid](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/mermaid)
|
|
351
|
-
| 🧭 [run-trace](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/run-trace)
|
|
481
|
+
| Plugin | What it does |
|
|
482
|
+
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
483
|
+
| 📬 [webmail](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/webmail) | IMAP inbox browsing / search / read / mark / delete + SMTP sending, new-mail notifications, and an optional "allow AI to manage my mailbox" switch (six `mail_*` agent tools). Auto-installs its npm deps on first activation. |
|
|
484
|
+
| 🗄️ [db-client](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/db-client) | Database workbench: connection manager + schema tree for MySQL / PostgreSQL / SQLite / SQL Server / MongoDB / Redis — table structure, paginated data with sorting, SQL editor, and row editing. Drivers auto-install on first use. |
|
|
485
|
+
| 📝 [vscode-editor](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/vscode-editor) | VS Code-like workbench: multi-root file tree (local + SSH hosts), CodeMirror multi-tab editor, Remote-SSH remote file browsing/editing, draggable multi-terminal panel (xterm.js), SFTP sync & upload/download to your computer. Auto-installs `ssh2`. |
|
|
486
|
+
| 📊 [mermaid](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/mermaid) | Renders ` ```mermaid ` fences in chat messages as SVG diagrams (fenced-code renderer plugin, offline-first local engine). |
|
|
487
|
+
| 🧭 [run-trace](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/run-trace) | Run trajectory: task → thinking → tools → file changes → result timeline with replay and node details. |
|
|
488
|
+
| 📖 [legado-web](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/legado-web) | Legado book reader (📖 阅读): search / discovery / book info / TOC / chapter reading on top of Android-compatible **book sources**, with source import, health checking and dead-source cleanup, and four agent tools (`legado_rules`, `legado_book_sources`, `legado_source_probe`, `legado_run_rule`) plus an “🤖 AI fix this source” button that opens a new chat with the failure context. Sources/shelf/progress persist under `<dataDir>/legado-web/`. |
|
|
352
489
|
|
|
353
490
|
`plugins/demo-mailbox` stays in the repo as the minimal plugin template (server entry + client view + two-way message protocol) and test fixture — start there if you want to write your own.
|
|
354
491
|
|
|
@@ -410,6 +547,7 @@ pi-web-ui install https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/web
|
|
|
410
547
|
`db-connections.json`, vscode-editor's `ssh-hosts.json`) are **not** covered
|
|
411
548
|
by that preservation — back those up before a forced reinstall.
|
|
412
549
|
- Refresh the browser afterwards; no server restart needed.
|
|
550
|
+
- **Which plugins are outdated?** `pi-web-ui plugins --check-updates` compares each plugin's recorded commit against the remote HEAD and prints the exact update command. `pi-web-ui plugins --rollback <id>` restores the newest pre-upgrade snapshot (every `--force` install snapshots the old directory into `<dataDir>/plugin-backups/`, keeping the latest three, and rolls itself back if the copy fails).
|
|
413
551
|
|
|
414
552
|
### Activating
|
|
415
553
|
|
|
@@ -431,6 +569,29 @@ pi-web-ui uninstall <id> # remove a plugin
|
|
|
431
569
|
disappears. Plugin configuration written inside the plugin dir is removed
|
|
432
570
|
too — back up `<dataDir>/plugins/<id>/config.json` first if you need it.
|
|
433
571
|
|
|
572
|
+
## Browser extension
|
|
573
|
+
|
|
574
|
+
### 🎯 Web element picker (page-picker)
|
|
575
|
+
|
|
576
|
+
Pick elements on the site you are developing and turn them into context an AI can act on, then drop it
|
|
577
|
+
straight into the pi-web-ui composer (`Alt+Shift+P` or the toolbar icon → hover highlight → click to pick
|
|
578
|
+
→ `Shift`+click for multi-select → add a note → "Add to chat").
|
|
579
|
+
|
|
580
|
+
It is a **browser extension**, not a pi-web-ui server plugin (so `pi-web-ui install` does not apply):
|
|
581
|
+
|
|
582
|
+
**Download & install** (no Node required): [`page-picker-extension.zip`](https://github.com/xing-shuyin/pi-web-ui/releases/latest/download/page-picker-extension.zip) → unzip →
|
|
583
|
+
open `chrome://extensions`, enable "Developer mode", choose "Load unpacked" and select the unzipped
|
|
584
|
+
folder → open the extension options and set your pi-web-ui address (click "Authorize this address"
|
|
585
|
+
first for remote/LAN addresses).
|
|
586
|
+
|
|
587
|
+
See [`plugins/page-picker/README.md`](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins/page-picker) for the interaction details,
|
|
588
|
+
what gets captured, remote/LAN setups and known limitations.
|
|
589
|
+
|
|
590
|
+
It captures what actually lets an AI fix the code in one shot — not a screenshot: the React component
|
|
591
|
+
source location from the fiber (`Card.tsx:18:5` plus the component chain), the Vue SFC file, the
|
|
592
|
+
**source file and line** of the CSS rules that matched (reverse-computed in Vite dev), a computed-style
|
|
593
|
+
subset limited to values that differ from the defaults, a short unique selector, an HTML skeleton and
|
|
594
|
+
truncated text. An optional element screenshot rides along as a chat attachment.
|
|
434
595
|
|
|
435
596
|
## Themes
|
|
436
597
|
|
|
@@ -474,6 +635,28 @@ Want your theme shipped to everyone? Open a pull request at [github.com/xing-shu
|
|
|
474
635
|
|
|
475
636
|
Rules for merged themes: the file must be a single CSS file, set the `--term-*` variables for a readable terminal, and override `.hljs` syntax colors for readable code on light themes.
|
|
476
637
|
|
|
638
|
+
## Tuning & advanced environment variables
|
|
639
|
+
|
|
640
|
+
All optional — the defaults are what the app is developed against. Full reference: [`docs/env-vars.md`](docs/env-vars.md).
|
|
641
|
+
|
|
642
|
+
| Variable | Default | What it changes |
|
|
643
|
+
| ------------------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
644
|
+
| `PI_WEB_TOOL_TIMEOUT_MS` | `1200000` (20 min) | Per-tool-call watchdog; a tool still running is aborted (`ask_user_question` is exempt). |
|
|
645
|
+
| `PI_WEB_STALL_NOTIFY_MS` | `180000` (3 min) | Warn — without aborting — when a streaming run produces no event at all; `0` disables. |
|
|
646
|
+
| `PI_WEB_TERMINAL_IDLE_MS` | `15000` | Nudge the AI when a terminal it opened goes silent for this long; `0` disables. |
|
|
647
|
+
| `PI_WEB_TERMINAL_IDLE_LINES` | `10` | How many trailing terminal lines that nudge quotes back (1–500). |
|
|
648
|
+
| `PI_WEB_INLINE_FILE_MAX` | `12288` (12 KB) | Size under which a path-less uploaded file is inlined instead of referenced. |
|
|
649
|
+
| `PI_WEB_VISION_TIMEOUT_MS` | `90000` | Timeout for one whole vision-bridge transcription batch. |
|
|
650
|
+
| `PI_WEB_UPLOAD_RETENTION_DAYS` | `14` | Retention for `<dataDir>/uploads/`; `0` never sweeps. |
|
|
651
|
+
| `PI_WEB_SHELL` | auto | Windows only: which shell node-pty spawns (auto: `PI_WEB_SHELL` → `$SHELL` → Git Bash → bundled busybox → `%COMSPEC%` → PowerShell). |
|
|
652
|
+
| `PI_WEB_TABS` | all tabs | Comma-separated tab allow-list (`chat,terminal,git,search,tasks,settings,plugins`); hidden tabs are refused server-side, `chat` can't be turned off. |
|
|
653
|
+
| `PI_WEB_MANAGED` | off | `1`/`true` declares the instance externally deployed: self-update, pi-CLI install and plugin installs are refused with a reason and hidden in the UI. |
|
|
654
|
+
| `PI_WEB_ALLOW_HOSTS` | empty | Strict hostname allow-list for the HTTP/WS `Host` header, on top of the always-on same-authority check. |
|
|
655
|
+
| `PI_WEB_LOCALE` | empty | Fallback UI language for first-time visitors (an explicit choice and the browser's languages win over it). |
|
|
656
|
+
| `PI_WEB_LOCALE_BASE_URL` | GitHub raw | Where language packs are downloaded from — point it at a mirror for offline/intranet installs. |
|
|
657
|
+
| `PI_WEB_PKG_ROOT` | auto | Overrides where the server looks for `package.json`, `themes/`, `plugins/catalog.json` and `web/dist` (non-standard install layouts). |
|
|
658
|
+
| `PI_CODING_AGENT_SESSION_DIR` | empty | Flat session layout for pi instead of `<agentDir>/sessions/--<cwd>--/` (changes what the history list reads). |
|
|
659
|
+
| `DSH_*` | — | DSH runtime knobs: `PI_WEB_DSH_RUNTIME`, `PI_WEB_DSH_DATA_DIR`, `PI_WEB_DSH_PATCH_DIR`, `PI_WEB_DSH_QUESTION_TIMEOUT_MS`, `PI_WEB_DSH_TOOL_TIMEOUT_MS`, `PI_WEB_DSH_SESSION_RETENTION_DAYS`, `PI_WEB_DSH_DEBUG`. |
|
|
477
660
|
|
|
478
661
|
## Security
|
|
479
662
|
|
|
@@ -492,7 +675,6 @@ Rules for merged themes: the file must be a single CSS file, set the `--term-*`
|
|
|
492
675
|
`Authorization` / API keys) are never sent to the browser; the model
|
|
493
676
|
management UI edits everything else and the server preserves the headers.
|
|
494
677
|
|
|
495
|
-
|
|
496
678
|
## 🪪 Code signing policy
|
|
497
679
|
|
|
498
680
|
Free code signing provided by [SignPath.io](https://signpath.io), certificate by
|
|
@@ -507,36 +689,38 @@ build of the source code at that tag.
|
|
|
507
689
|
|
|
508
690
|
### Team roles
|
|
509
691
|
|
|
510
|
-
| Role
|
|
511
|
-
|
|
|
512
|
-
| **Authors / committers** (may push to `main`)
|
|
692
|
+
| Role | Who |
|
|
693
|
+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
694
|
+
| **Authors / committers** (may push to `main`) | [@xing-shuyin](https://github.com/xing-shuyin) |
|
|
513
695
|
| **Reviewers** (every non-committer change arrives as a PR and is reviewed before merge) | [@xing-shuyin](https://github.com/xing-shuyin) — community contributions are credited in the [contributors graph](https://github.com/xing-shuyin/pi-web-ui/graphs/contributors) |
|
|
514
|
-
| **Approvers** (must approve each signing request)
|
|
696
|
+
| **Approvers** (must approve each signing request) | [@xing-shuyin](https://github.com/xing-shuyin) |
|
|
515
697
|
|
|
516
698
|
All team members use multi-factor authentication for both GitHub and SignPath.
|
|
517
699
|
Our release artifacts contain no binaries we did not build ourselves, except
|
|
518
700
|
upstream open-source components bundled by npm and electron-builder (see
|
|
519
701
|
[License](#license)).
|
|
520
702
|
|
|
521
|
-
**Privacy policy:** see [Privacy](
|
|
703
|
+
**Privacy policy:** see [Privacy](#-privacy) below.
|
|
522
704
|
|
|
523
705
|
## 🔐 Privacy
|
|
524
706
|
|
|
525
707
|
pi-web-ui runs entirely on your own machine and has **no telemetry, no analytics
|
|
526
708
|
and no accounts of its own**. Conversations, attachments, settings and terminal
|
|
527
|
-
history stay
|
|
528
|
-
|
|
529
|
-
|
|
709
|
+
history stay on your disk: chat transcripts in the pi agent dir
|
|
710
|
+
(`~/.pi/agent/sessions/` by default), everything else (UI settings, recent
|
|
711
|
+
projects, plugins, uploads, themes, language packs) in the data dir
|
|
712
|
+
(`~/.pi-web/`, or `%APPDATA%\pi-web-ui\data` for the desktop app). The HTTP
|
|
713
|
+
server binds loopback unless you explicitly expose it.
|
|
530
714
|
|
|
531
715
|
Network requests happen only in these cases:
|
|
532
716
|
|
|
533
|
-
| When
|
|
534
|
-
|
|
|
535
|
-
| You send a message, or the agent calls a model
|
|
536
|
-
| Model catalog refresh (startup, then every 4 h)
|
|
537
|
-
| You install or update a plugin, theme or language pack
|
|
538
|
-
| You check for or install an update
|
|
539
|
-
| Terminals on Windows, when neither Git Bash nor a `bash` on `PATH` exists | `frippery.org`
|
|
717
|
+
| When | To | What leaves your machine |
|
|
718
|
+
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
719
|
+
| You send a message, or the agent calls a model | the model providers **you** configure (e.g. `api.openai.com`, `api.opencode.ai`, a local endpoint) | your prompt, the attached file contents and the conversation context |
|
|
720
|
+
| Model catalog refresh (startup, then every 4 h) | `pi.dev` | nothing but the request itself |
|
|
721
|
+
| You install or update a plugin, theme or language pack | `github.com` / `raw.githubusercontent.com` | nothing but the request itself |
|
|
722
|
+
| You check for or install an update | `registry.npmjs.org` | nothing but the request itself |
|
|
723
|
+
| Terminals on Windows, when neither Git Bash nor a `bash` on `PATH` exists | `frippery.org` | one download of `busybox64u.exe` into `~/.pi-web/bin/bash.exe`, reused offline afterwards |
|
|
540
724
|
|
|
541
725
|
Reverse-proxy setups, the optional `PI_WEB_TOKEN` password and Docker port
|
|
542
726
|
mappings are under your control — see [Security](#security).
|
|
@@ -581,7 +765,6 @@ server {
|
|
|
581
765
|
# Absolute-path assets/API the built frontend requests (root, not /pi/)
|
|
582
766
|
location /assets/ { proxy_pass http://127.0.0.1:8787; }
|
|
583
767
|
location = /favicon.svg { proxy_pass http://127.0.0.1:8787; }
|
|
584
|
-
location = /favicon-streaming.svg { proxy_pass http://127.0.0.1:8787; }
|
|
585
768
|
location = /api/file { proxy_pass http://127.0.0.1:8787; }
|
|
586
769
|
location = /api/health { proxy_pass http://127.0.0.1:8787; }
|
|
587
770
|
}
|
|
@@ -607,18 +790,17 @@ Key points:
|
|
|
607
790
|
|
|
608
791
|
Full working example (with an frp tunnel): `deploy/nginx-subpath.conf`.
|
|
609
792
|
|
|
610
|
-
|
|
611
793
|
## Contribute
|
|
612
794
|
|
|
613
795
|
pi-web-ui is a small open-source project — **your contributions are what make it grow**. Code, plugins, themes, docs, translations, ideas: everything is welcome, and every merged PR ships to all users with the next `npm publish`. ❤️
|
|
614
796
|
|
|
615
|
-
| Way to contribute
|
|
616
|
-
|
|
|
617
|
-
| 🧩 **Write a plugin**
|
|
618
|
-
| 🎨 **Contribute a theme**
|
|
619
|
-
| 💻 **Fix a bug / add a feature** | Look for [open issues](https://github.com/xing-shuyin/pi-web-ui/issues) or propose something new. Fork → branch → PR. Keep the code conventions in `AGENTS.md` (tabs, i18n keys in both languages, protocol changes in `server/protocol.ts`).
|
|
620
|
-
| 📖 **Docs & translations**
|
|
621
|
-
| 💡 **Ideas & feedback**
|
|
797
|
+
| Way to contribute | How to get started |
|
|
798
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
799
|
+
| 🧩 **Write a plugin** | Build your own UI tab + agent tools. Copy `plugins/demo-mailbox` as the minimal template (it doubles as the test fixture), develop locally, then either open a PR to ship it in the [catalog](#plugin-catalog) or [publish it standalone](https://github.com/xing-shuyin/pi-web-ui/tree/main/plugins). |
|
|
800
|
+
| 🎨 **Contribute a theme** | Copy `themes/white.css` (light) or `themes/cyberpunk.css` (dark) as a pure-palette template, tweak the `:root` palette + `--term-*` + `.hljs`, verify with `npm run dev`, then open a PR — full walkthrough in [Contributing a theme](#contributing-a-theme-to-the-repository-github). |
|
|
801
|
+
| 💻 **Fix a bug / add a feature** | Look for [open issues](https://github.com/xing-shuyin/pi-web-ui/issues) or propose something new. Fork → branch → PR. Keep the code conventions in `AGENTS.md` (tabs, i18n keys in both languages, protocol changes in `server/protocol.ts`). |
|
|
802
|
+
| 📖 **Docs & translations** | Improve the READMEs, write plugin docs, fix typos, or help translate the UI / docs into more languages. |
|
|
803
|
+
| 💡 **Ideas & feedback** | Open an [issue](https://github.com/xing-shuyin/pi-web-ui/issues) or start a [discussion](https://github.com/xing-shuyin/pi-web-ui/discussions) — feature requests, bug reports, UI polish ideas, deployment experience reports. |
|
|
622
804
|
|
|
623
805
|
**Before opening a PR**, a quick sanity pass keeps reviewers happy:
|
|
624
806
|
|
|
@@ -633,7 +815,6 @@ pi-web-ui is a small open-source project — **your contributions are what make
|
|
|
633
815
|
> built something cool on top (plugin, theme, deployment recipe), tell us — we
|
|
634
816
|
> love showcasing community work.
|
|
635
817
|
|
|
636
|
-
|
|
637
818
|
## License
|
|
638
819
|
|
|
639
|
-
[MIT](LICENSE)
|
|
820
|
+
[MIT](LICENSE)
|