orbit README

项目的 README,来自 github.com/imrj05/orbit。合并为一个 markdown 文件:README.md。

Orbit PI

CI License: Apache-2.0 Rust

Orbit's banner: the headline

Orbit Pi is a native desktop workbench for the pi coding agent — a chat-style GUI rendered entirely in Rust on GPUI, the GPU-accelerated UI framework Zed is built on. It speaks the pi CLI's RPC protocol directly over stdio: no browser, no webview, no Node.

Sessions you create in Orbit and in the terminal are the same sessions (~/.pi/agent/sessions/), managed by pi's own session manager.

Screenshots

A live session — streaming transcript, tool rows, and the composer:

A completed Orbit session: the agent's summary of the open-in options change and a Changed 3 files card with per-file line counts, above the composer.

Usage — requests, tokens, cost, and cache, read from your own sessions; point at any summary sparkline to read that day across the whole row:

Orbit's Usage page with request, token, cost, and cache metrics above a tokens-over-time chart.

New task Review
Orbit's new-task page with a workspace picker above the composer, and the workflow mode, model, and thinking level set in the composer. The Orbit Review panel open beside a session, showing a selected file's diff on the left and the changed-file tree on the right.
Git Providers
Orbit's Git page listing changed files with line counts and a commit box. Orbit's Providers page listing built-in and custom providers with auth status and model counts.
Plugins Skills
Orbit's Plugins page listing installed pi packages with update and remove actions. Orbit's Skills page listing project and global skills with the selected skill's SKILL.md rendered on the right.
Models Appearance
Orbit's Models page listing models grouped by provider with context sizes and favorite toggles. Orbit's Appearance settings with the design system, theme, accent color, language, and wallpaper controls.
General Agent
Orbit's General settings showing the connected pi agent, the local session store, the workspace, and notification toggles. Orbit's Agent settings with follow-up delivery, auto-compaction, auto-retry, and session titles.

Features

Chat and transcript

Sessions

Safeguards

Review and Git

Settings → Git Accounts inspects local Git author settings, generic and host-scoped credential helpers, SSH agent fingerprints and conventional public-key file presence, remote hosts and the GitHub CLI version without managing credentials. Git author identity is not authentication; a helper or loaded SSH key does not prove that a valid credential exists or that a remote accepts it. Remote access is not tested. The page does not run gh auth status, since it can contact hosts and refresh credentials, so GitHub CLI authentication remains unknown. An optional Check for updates action anonymously checks the latest stable GitHub CLI release and shows manual update commands; ordinary status refresh stays offline and Orbit does not run the update. Public-key file detection checks conventional names without opening their contents on Unix; it is unavailable on Windows. Environment-variable indicators reflect only Orbit’s process environment, which may differ from your terminal. Resolve authentication problems manually with your existing tools; credentials may be expired or lack permissions.

Explorer and Files

Terminal

Workbench

Native

Linux updates

Extract the release tarball into its own orbit-pi or orbit-pi-* directory and run bin/orbit-pi there. Do not merge it into a shared prefix such as ~/.local or /usr. The in-app installer only replaces a dedicated directory with the known release layout and no extra files or symlinks; on unsupported layouts the updater is normally disabled, so update manually or through your package manager. ORBIT_FORCE_UPDATER=1 enables checking without installation for development. Existing tarball layouts remain supported. Keep personal files outside the install directory. Linux updates retain the old directory as a hidden .orbit-pi*.rollback-* sibling; after checking the new version, you may remove that backup yourself. Release packaging changes must update the updater's layout validation before adding files.

Structure

┌───────────────────────────────────────────┐
│  Orbit (Rust) — GPUI, Metal-rendered UI   │
│  crates/orbit-pi                          │
│  window, transcript, markdown, workbench  │
└──────────────┬────────────────────────────┘
               │ newline-delimited JSON RPC over stdio
┌──────────────▼────────────────────────────┐
│  pi CLI (child process, per open session) │
│  pi --mode rpc — sessions, models, tools  │
└──────────────┬────────────────────────────┘
               │
┌──────────────▼────────────────────────────┐
│  ~/.pi/agent/ — sessions, config, usage   │
│  (same data the pi CLI uses)              │
└───────────────────────────────────────────┘

Orbit spawns the pi CLI as a child process per open session and speaks its RPC protocol: JSON requests on stdin, JSON-line events on stdout (text/thinking deltas, tool calls, question dialogs, settle signals). Everything user-facing is painted by GPUI on Metal — no DOM, no CSS, no browser engine. The agent runtime stays pi itself, so the model catalog, thinking levels, and persistence remain pi's own.

Project layout

crates/orbit-pi/      The GPUI app — window, transcript, markdown, workbench
crates/orbit-rpc/     pi CLI RPC client (process lifecycle + JSONL protocol)
contrib/              Bundled pi extensions (access guard, auth/quota bridges)
scripts/make-dmg.sh   Build a signed .app + DMG (arm64 / universal)
assets/icons/         App icon (logo-icon.png source, icon.icns, icon.png)
marketing/            Next.js landing page
PRODUCT.md            Product definition, capabilities, constraints
INTENT.md             Architecture decisions + phase plan
AGENTS.md             Conventions for agents and humans working on this repo
PRIVACY.md            What Orbit does and does not send

Roadmap

Orbit is a workbench, not just a chat window. The confirmed direction lives in PRODUCT.md, architecture decisions in INTENT.md, and shipped work in CHANGELOG.md. Every unchecked item below is open for a pull request — read CONTRIBUTING.md and claim the linked issue before starting.

Planned features

Feature Area Description Status Tracking
Workflow modes Composer Start a session scoped to Plan Mode, Build Mode, or Ask Mode instead of one undifferentiated chat. Shipped —
Follow-up on settle Transcript Show a queued follow-up inline once a run ends, not only in the compose queue. Planned —
Suggested follow-ups Transcript Propose 2–3 context-grounded next prompts as composer inserts after a run settles. Proposed #10
GitHub client Workbench Browse and manage remote commits, graph, issues, and pull requests in-app. In progress — Issues and Pull requests ship with comments, reviews, merges, and branch checkouts; a remote-commits view remains open (#8 closed for the issues/PRs half) —
Pi extension support Workbench First-class list / install / enable / configure / debug of pi extensions, including community ones. In progress — Plugins installs, updates, and removes packages; a dedicated extensions surface with enable/configure/debug is still open #7
Global default model Models Pin pi's global default model and thinking effort from within Orbit. Shipped — Settings → Agent sets the model and thinking level every new session starts on (Orbit's own store; pi's global settings are untouched) #9
Voice dictation Composer Dictate prompts into the composer. Planned —
Diff review and terminal Workbench Inline diff review and an integrated terminal. Shipped — Review pane with per-turn checkpoints and view controls, plus a login-shell terminal (⌘J) —
Terminal tabs Terminal Run several shells in the bottom panel without losing the ones in the background. Shipped — ⌘T / ⌘W / ⌘⇧] / ⌘⇧[, each tab holding its own PTY —
Git worktrees Workbench List, create, open, move, lock, repair, and prune worktrees, and work in one as the active workspace. Shipped — Worktrees page, Work in on the status bar in a repository and on the new-task page, plus an optional per-repository setup script. Clone from URL is implemented, with the Windows job-object cancellation path covered on the Windows CI leg; manual GUI verification remains. —
Session retention Workbench Keep pi's session store from growing without bound. Shipped — Settings → Privacy archives or deletes idle sessions on a schedule, alongside Orbit and pi scratch-file cleanup —
Parallel sessions Sessions Run multiple agents / sessions side by side. Planned —
Explorer gaps Explorer Quick-open, sticky scroll, and directory folding in the file tree. Planned — expand/collapse, filter, hidden toggle, and git badges ship today —
Markdown export Transcript Save the visible transcript or an individual response as Markdown. In progress — response footer and transcript palette actions are implemented; GUI verification remains —
Conversation fork/rewind Sessions Branch and rewind a conversation. In progress — user-message rewind, response-footer fork picker, and a palette action create a new session and leave the old one in the sidebar. The response footer opens a chooser because pi forks before user messages; GUI verification remains —
Scroll-perf measurement Performance On-device measurement of transcript scroll performance. Planned —
Design-system unification Design One token layer (colour, geometry, state, motion) across every surface, with the interaction-state and motion contracts enforced by scripts. Done — see DESIGN.md and docs/design-system-audit.md —

Contributor checklist


Credits

Orbit leans on a lot of other people's work. The full license texts ship in NOTICE and beside each asset in the repo.

The agent

Framework and libraries

Icons

Fonts

Every family in crates/orbit-pi/assets/fonts/bundled/ ships under the SIL Open Font License 1.1: Anonymous Pro, Atkinson Hyperlegible, Cascadia Code, Commit Mono, DM Mono, DM Sans, Fira Code, Fixel Text, Geist, Geist Mono, IBM Plex Mono, Inconsolata, Inter, Iosevka, JetBrains Mono, Manrope, Martian Mono, Noto Sans, Noto Sans Mono, Onest, Roboto, Roboto Mono, Source Code Pro, Source Sans 3, and Space Mono. IBM Plex Sans and Lilex come from Zed's font set, also OFL 1.1.

Marketing site

Built with Next.js, React, Tailwind CSS, Base UI, HugeIcons for React, and shadcn/ui patterns. Sora and Geist Mono are served through next/font. The Apple mark in the download buttons follows gilbarbara/logos (CC0), and the Tux mark comes from tandpfun/skill-icons (MIT).

People

Something missing from this list is a bug. Open an issue and it gets fixed.


Setup, checks, and commit conventions live in CONTRIBUTING.md. Orbit is licensed under Apache-2.0; report vulnerabilities per SECURITY.md. Data handling is documented in PRIVACY.md.

orbit (imrj05/orbit)

正在搜索数据库…

159 ·GitHub
这是什么?Orbit 是为 pi 编程智能体打造的原生桌面图形界面,完全用 Rust 在 GPUI 上渲染(GPUI 是 Zed 所基于的 GPU 加速框架)。它直接通过 stdio 使用 pi 命令行工具的 RPC 协议与之通信,因此界面中不涉及浏览器、网页视图或 Node 运行时。
Orbit 是独立应用还是 pi 的插件?它是一个独立的原生应用,为每个会话启动一个 pi 命令行工具子进程,并通过 stdio RPC 与其通信,而不是运行在 pi 内部的插件,也不是对 pi 的网页封装。
我该如何安装和运行 Orbit?下载适用于你操作系统的已签名版本:macOS 为 .dmg(已签名并公证,通用版)或 .tar.gz,Windows 为 .exe/.zip,Linux 为 .deb/.tar.gz。安装后的更新在应用内完成,且所有平台的更新均已签名。
运行 Orbit 之前需要先安装什么?你的系统需要安装 pi 命令行工具、Node 和 Git;Orbit 会在首次运行时进行依赖检查,并为缺失的组件给出安装命令。
Orbit 会对智能体在我电脑上的操作进行沙箱隔离吗?不会。Orbit 只会根据你选择的访问模式,通过允许/拒绝确认栏来拦截会修改内容的工具调用;它不提供沙箱,而 pi 本身也没有附带沙箱。
Orbit 会发送任何使用数据或遥测信息吗?不会。没有分析客户端、没有标识符,也没有对外发送的事件队列;所有内容都保存在你本地磁盘上自己的 pi 会话文件中。
在 Orbit 中启动的会话与在 pi 终端中启动的会话有区别吗?没有区别,它们是同一批会话,保存在 ~/.pi/agent/sessions/ 下,并由 pi 自己的会话管理器管理,因此你可以在 Orbit 图形界面和终端之间自由切换。
我能在 Orbit 里管理 pi 的 MCP 服务器吗?可以,在 Settings → MCP 中你可以全局或按项目添加、编辑和校验 MCP 服务器,并配有密钥存储,以及直接从 pi 自身命令行工具获取的实时状态和工具列表。
Orbit 支持同时在多个 Git 分支上工作吗?支持。Worktrees 页面可以让你创建、打开、重命名、锁定和清理 Git worktree,每个 worktree 都会作为独立的活动工作区打开,并拥有自己的 Explorer、终端和智能体会话。
Orbit 中的 Review 面板究竟会显示什么?它会显示来自可选来源的差异:智能体上一轮的改动、未提交/未暂存/已暂存的更改、某次提交或某个分支;可以选择统一视图或并排视图,并支持在文件和差异块之间用键盘完整导航。
作者
imrj05
大小
316.4 MB
星标
159
时长
2个月
提交 · 90 天