pi-gui README

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

pi-gui

The desktop app for the pi coding agent.

License: MIT Latest release Platform

Run agents in parallel threads, each in its own git worktree if you want one. Review every change, run the tests in a real terminal, and ship without leaving the window. pi-gui is a desktop shell around @earendil-works/pi-coding-agent, not a separate agent: sessions, models, auth and tools all run through pi itself, so anything you set up with the pi CLI carries over.

An agent in pi-gui fixing a bug, running the tests, then the change open in the review tab

A real run: the agent fixes a bug, adds a test and runs it, then the change opens for review. (Watch in full quality)

Features

Run agents side by side

Every task gets its own thread. Start it in your checkout or in a fresh git worktree, then start the next one while it works. The sidebar shows what is running, what finished and what needs you. Pin threads, group them by time or workspace, and archive the ones you are done with.

pi-gui running an agent thread while two other threads work in the sidebar

Review every change before it lands

The Review tab shows exactly what the agent touched. Compare uncommitted work, a branch against its base, or a single turn, and stage or unstage it file by file.

The Review tab showing the diff an agent made to src/price.js

Terminal and files in the same window

The workbench beside the conversation holds a real terminal, a file explorer and editor, the review tab, your worktrees, and tabs from desktop extensions. Each task keeps its own layout.

The integrated terminal running the test suite next to the thread

Everything is a keystroke away

The command palette listing recent chats and actions
Shortcut (macOS; use Ctrl on Linux and Windows) Does
⌘ K Search chats, workspaces and actions
⌘ P Open any file in the current checkout
Ctrl Tab Switch between recent threads
⌘ 1 to 9 Jump to a thread in the sidebar
⌘ J Toggle the terminal
⌘ R Toggle the Review tab
⌘ ⌥ B Show or hide the workbench
Enter while a run is going Queue a follow-up
⌘ Enter while a run is going Steer the current run

And the rest

Install

pi-gui runs on macOS (Apple Silicon), Linux (x64) and Windows (x64).

Download the latest .dmg (macOS), .AppImage or .deb (Linux), or .exe (Windows) from the Releases page.

On macOS you can also use Homebrew:

brew tap minghinmatthewlam/tap
brew install --cask pi-gui

Update with brew upgrade --cask pi-gui. A Homebrew upgrade may ask you to re-confirm macOS permissions or Dock placement. Other installs tell you when a new release is out and update from the Releases page.

Building from source is for contributors; see Development.

Quickstart

  1. Install pi-gui and open it.
  2. Open Settings → Providers and connect a model provider (OAuth or API key).
  3. Add a workspace: a local project folder.
  4. Click New thread, choose Local or Worktree, and send your first prompt.

pi-gui reads and writes pi's own session files and settings, so threads, credentials and skills are shared with the pi CLI.

Architecture

pi-gui is an Electron app with a tight main, preload and renderer boundary, on top of the pi runtime:

See docs/architecture.md for ownership and boundaries.

Development

Requires Node 22.19 or newer (CI runs Node 22) and pnpm through corepack. pnpm-lock.yaml is the authoritative lockfile.

corepack enable
pnpm install

Common commands, from the repo root:

pnpm dev            # run the desktop app with hot reload
pnpm check          # CI baseline: format, lint, renderer boundaries, types, guard and driver tests
pnpm build          # build the desktop app and the website
pnpm typecheck      # type-check all workspaces
pnpm lint           # correctness rules plus typed promise and unsafe-any checks
pnpm format         # apply the shared formatter
pnpm test           # each workspace's tests (desktop runs the core E2E lane)
pnpm marketing:media  # re-record the README and website media from a real agent run

pnpm check is the shared local and CI baseline. It does not launch Electron or replace the desktop, website-build and package CI jobs; see docs/ci-baseline.md.

Desktop end-to-end tests drive the real Electron app with Playwright, in lanes. pnpm test runs the core lane; to run everything:

pnpm --filter @pi-gui/desktop run test:e2e:all   # core + live + native

See apps/desktop/README.md for the lanes, packaging on each platform, and how the product media is recorded.

Repository layout

Contributing

Contributions are welcome. See CONTRIBUTING.md for setup, verification expectations and the desktop test lanes. Desktop changes should be verified on the real Electron app, not only by unit tests.

Computer use

Native computer use is not built into pi-gui. Desktop and browser control is available separately through the standalone computer-use-mcp server, which any MCP-capable agent can use.

Acknowledgements

Built on @earendil-works/pi-coding-agent and the pi runtime and ecosystem.

License

MIT © Matthew Lam

pi-gui (minghinmatthewlam/pi-gui)

Searching Database…

1.3K ·GitHub
What is this?pi-gui is a desktop app for the pi coding agent: you run coding agents in parallel threads, review every change they make, run tests in a real terminal, and ship without leaving the window.
Is it its own agent, or a shell around something else?It is a desktop shell around the pi runtime (@earendil-works/pi-coding-agent), not a separate agent: sessions, models, auth and tools run through pi itself, so anything you set up with the pi CLI carries over.
Do I need an API key or an account to use it?You connect a model provider in the Providers settings: sign in with OAuth, paste an API key, or point at a custom endpoint. Model and thinking level are picked per thread.
Any install gotchas to know about?Windows builds are not code-signed yet, so SmartScreen may ask you to confirm. macOS releases are signed and notarized, and a Homebrew upgrade may ask you to re-confirm macOS permissions or Dock placement.
Which systems does it run on — will it work on an Intel Mac?It runs on macOS (Apple Silicon only), Linux (x64) and Windows (x64), so Intel Macs are not covered.
Where do my sessions and settings live?pi stores each session as a JSONL transcript on disk, and pi-gui reads those files instead of keeping its own copy, so threads, credentials and skills are shared with the pi CLI.
How does running agents in parallel actually work?Every task gets its own thread: start it in your existing checkout or in a fresh git worktree, then start the next one while it works. The sidebar shows what is running, what finished and what needs you; threads can be pinned, grouped by time or workspace, and archived.
How do I check what the agent actually changed?The Review tab shows exactly what the agent touched — uncommitted work, a branch against its base, or a single turn — and you stage or unstage it file by file. A real terminal, file explorer and editor sit in the workbench beside the conversation, with a per-task layout.
Can an agent kick off other agents?Yes — a thread can start, read and message other threads, which show up in the sidebar like any other. You get notifications when a background thread finishes, fails or needs your attention, and you can fork a thread from any message or rewind with /tree.
Can it rerun a prompt on a schedule?Yes, scheduled tasks let pi rerun a prompt on a schedule — a weekly dependency check, for example — while the app is open. It also supports turning pi skills and extensions on and off, and desktop extensions get their own workbench tabs.
Size
20.8 MB
Stars
1.3K
Age
6mo
Commits · 90 Days