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
Что это такое?pi-gui — настольное приложение для кодинг-агента pi: вы запускаете агентов параллельно в нескольких ветках, просматриваете каждое их изменение, гоняете тесты в настоящем терминале и доводите задачу до конца, не выходя из окна.
Это самостоятельный агент или оболочка над чем-то другим?Это настольная оболочка над рантаймом pi (@earendil-works/pi-coding-agent), а не отдельный агент: сессии, модели, авторизация и инструменты работают через сам pi, так что всё, что вы настроили через pi CLI, подхватится автоматически.
Нужен ли API-ключ или аккаунт, чтобы этим пользоваться?Провайдера модели вы подключаете в настройках Providers: войдите через OAuth, вставьте API-ключ или укажите свой endpoint. Модель и уровень «размышлений» выбираются отдельно для каждой ветки.
Есть ли подводные камни при установке?Сборки для Windows пока не имеют цифровой подписи, поэтому SmartScreen может попросить подтвердить запуск. Релизы для macOS подписаны и нотаризованы, а после обновления через Homebrew может понадобиться заново подтвердить разрешения macOS или закрепление в Dock.
На каких системах работает — пойдёт ли на Intel Mac?Работает на macOS (только Apple Silicon), Linux (x64) и Windows (x64), так что Intel Mac не поддерживается.
Где хранятся мои сессии и настройки?pi сохраняет каждую сессию как JSONL-транскрипт на диске, а pi-gui читает эти файлы, а не ведёт свою копию, поэтому ветки, учётные данные и скиллы общие с pi CLI.
Как вообще работает параллельный запуск агентов?Каждая задача получает собственную ветку: запустите её в существующем чекауте или в новом git worktree, и, пока она работает, запускайте следующую. В сайдбаре видно, что выполняется, что завершилось и где нужно ваше участие; ветки можно закреплять, группировать по времени или по воркспейсу и архивировать.
Как проверить, что агент реально изменил?Вкладка Review показывает ровно то, что трогал агент — незакоммиченные изменения, ветку относительно её базы или отдельный ход, — и вы добавляете или убираете файлы из индекса по одному. Рядом с перепиской в workbench находятся настоящий терминал, проводник по файлам и редактор, со своей раскладкой для каждой задачи.
Может ли агент запускать других агентов?Да — ветка может запускать другие ветки, читать их и писать им, и в сайдбаре они выглядят как обычные. Вы получите уведомление, когда фоновая ветка завершится, упадёт или потребует вашего внимания, а ещё можно форкнуть ветку из любого сообщения или откатиться назад командой /tree.
Можно ли запускать промпт по расписанию?Да, запланированные задачи позволяют pi выполнять промпт по расписанию — скажем, еженедельную проверку зависимостей, — пока приложение открыто. Также можно включать и выключать скиллы и расширения pi, а десктопные расширения получают собственные вкладки в workbench.
Size
20.8 MB
Stars
1.3K
Age
6mo
Commits · 90 Days