pi-web README

The project's README from github.com/agegr/pi-web. As one markdown file: README.md.

Pi Web

中文文档 | 日本語 | Русский

Local browser UI for the pi coding agent. Pi Web uses the same local configuration and session files as pi, so you can browse and resume conversations, run agent turns, configure models and resources, and inspect project files from a browser.

Pi Web displaying a pi session with structured Markdown, tool calls, and project navigation

Features

Quick Start

Pi Web requires Node.js 22.19.0 or newer. Check your version with node --version, then run:

npx @agegr/pi-web@latest

The CLI opens a browser after the server is ready. If it does not, open http://127.0.0.1:30141. Pi Web listens only on 127.0.0.1 by default.

If no model provider is configured yet, open the Models panel to sign in or add an API key.

To install the pi-web command globally:

npm install -g @agegr/pi-web@latest
pi-web

To update, stop the running process with Ctrl+C and run the same install command again. To uninstall, run npm uninstall -g @agegr/pi-web.

Configuration

For port and hostname, command-line options override the corresponding environment variables. Either --no-open or PI_WEB_NO_OPEN=1 disables automatic browser opening. Run pi-web --help (or -h) to print startup options and exit without starting the server. Unknown options exit with an error.

Option or environment variable Purpose Default
--help, -h Print startup options and exit —
--port <port>, -p <port>, or PORT Server port 30141
--hostname <host>, -H <host>, or PI_WEB_HOSTNAME Bind hostname 127.0.0.1
--no-open or PI_WEB_NO_OPEN=1 Do not open a browser automatically Browser opens
PI_WEB_SKIP_VERSION_CHECK=1 Disable Pi Web update checks Unset
PI_WEB_ALLOWED_HOSTS Additional exact proxy or custom hostnames, comma-separated Unset
PI_WEB_PASSWORD Enable browser password login; API clients may use Basic Auth with username pi Authentication disabled
PI_WEB_IDLE_TIMEOUT_MS Session idle timeout in milliseconds, up to 2147483647; 0 disables idle shutdown; invalid or out-of-range values use the default 600000 (10 min)

For example:

pi-web --help
pi-web -p 8080 -H 0.0.0.0 --no-open

Remote Access

Binding to a non-loopback address exposes an agent that can execute high-privilege actions. On a trusted LAN, require a long random password:

PI_WEB_PASSWORD='a-long-random-password' pi-web --hostname 0.0.0.0

Password authentication does not encrypt the connection. Do not expose Pi Web over plain HTTP to the internet; use HTTPS through a trusted reverse proxy or a trusted VPN. If a reverse proxy sends an external hostname, add that exact name to PI_WEB_ALLOWED_HOSTS. This allow-list does not change the address Pi Web binds to.

HTTP Proxy

Server-side model and API requests honor the standard HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables.

On macOS or Linux:

HTTP_PROXY=http://127.0.0.1:7890 \
HTTPS_PROXY=http://127.0.0.1:7890 \
NO_PROXY=localhost,127.0.0.1 \
npx @agegr/pi-web@latest

On Windows PowerShell:

$env:HTTP_PROXY = "http://127.0.0.1:7890"
$env:HTTPS_PROXY = "http://127.0.0.1:7890"
$env:NO_PROXY = "localhost,127.0.0.1"
npx @agegr/pi-web@latest

Notes

Downstream Session Context Menu

Electron wrappers and other downstream integrations can provide a session-row context menu without patching SessionSidebar. Listen for the cancelable pi-web:session-row-contextmenu browser event and call preventDefault() synchronously when the integration will handle it:

window.addEventListener("pi-web:session-row-contextmenu", (event) => {
  event.preventDefault();
  const { id, path, cwd, name, clientX, clientY, refresh } = event.detail;

  void openSessionMenu({ id, path, cwd, name, clientX, clientY }).then((changed) => {
    if (changed) refresh();
  });
});

The detail object contains id, path, cwd, optional name, pointer coordinates, and a refresh() callback for actions that change the session list. If no listener cancels the extension event, Pi Web preserves the browser's native context menu. This hook is browser-side and independent of Pi agent extensions.

Extension Session Liveness

Server-side Pi extensions with detached work can prevent automatic idle session eviction through the versioned global registry:

const liveness = globalThis[Symbol.for("@agegr/pi-web/session-liveness/v1")];
const release = liveness?.version === 1
  ? liveness.register({
      name: "my-extension",
      sessionId,
      sessionFile: sessionFile || undefined,
      isActive: () => detachedJobs.size > 0,
    })
  : () => {};

Register once per active extension session and call the returned idempotent release function on session shutdown, replacement, or reload. isActive must be synchronous, cheap, and scoped to the supplied exact session id or file. Provider errors fail safe by preserving that session. This lease only affects automatic idle eviction; explicit shutdown and Stop fallback cleanup still take precedence.

Development

npm install
npm run dev

The development server runs at http://127.0.0.1:30141. Run the common checks with:

npm test
node_modules/.bin/tsc --noEmit
npm run lint

Do not run next build or npm run build during normal development. It writes to .next/ and can interfere with the development server; leave builds for release work.

Contributor guides: Internationalization and Release process.

Repository Layout

app/             Next.js UI and API routes
components/      React UI components
hooks/           Client state and interaction hooks
lib/             Session, agent, model, file, Git, and security logic
public/          Static assets and PWA files
bin/             npm CLI entrypoint and launch option parsing
docs/            Focused user and contributor guides

See AGENTS.md for the architecture notes and detailed file map.

License

MIT

pi-web (agegr/pi-web)

Searching Database…

7.5K ·GitHub
Pi-web
What is this?A local browser UI for the pi coding agent: browse and resume conversations, run agent turns, configure models, and inspect project files — using the same data as the pi CLI.
So is this a desktop app, or does it run in my browser?It runs as a small local web server started with the pi-web command, and you use it in your browser. It shares pi's config and session files, so the CLI and this UI stay in sync.
How do I get it running?Install it globally with npm install -g @agegr/pi-web and run pi-web — the server starts on port 30141 and opens your browser automatically. Re-run the same install command to update.
Do I need anything installed before it works?Node.js 22.19.0 or newer. If no model provider is configured yet, you sign in or add an API key from the Models panel inside Pi Web.
Can I open it from another computer, or is it strictly local?By default it listens only on 127.0.0.1. Remote use is possible, but password login does not encrypt traffic, so the README says to use HTTPS via a reverse proxy or VPN and never expose it over plain HTTP.
Where does it keep my sessions and project files?Everything stays on your machine: it reads pi data from ~/.pi/agent, and the file browser only sees working directories you select in Pi Web — it is not a general filesystem browser.
What can I do with my past conversations?The session workspace lets you browse, resume, rename, export, and delete conversations grouped by project, showing running state, context usage, cost, and compaction details. You can branch two ways: start an independent session from an earlier message, or create an in-session branch with Edit from here.
Can it handle my Git worktrees?Yes — you can switch checkouts from the sidebar while sessions from the same repository stay grouped together, and inspect Git diffs of project files.
Which file types can it preview?Source code, Markdown, images, audio, PDFs, and DOCX, with automatic refresh. You can also browse and upload project files from the UI.
Which languages is the interface available in?English, Simplified Chinese, and Traditional Chinese. It follows your browser language at first, and a switcher sits in the top bar.
What are similar projects?wicked-studio, control-center, multi-agent-discuss, wechat-miniapp-radar, codeburn, Resume-Matcher, html-anything, neko-master
Which topics is it in?i18n, nextjs, git, dashboard, coding-agent, web-app, react, npm, chinese, ai-agents, llm, nodejs
Creator
agegr
Size
9 MB
Stars
7.5K
Updated
CommitOct 15Releasev0.12.2Oct 15
Age
6mo
Commits · 90 Days