Skip to content

docs: consolidate README, cut repetitive sections #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parsakhaz merged 1 commit into from
Apr 11, 2026
Merged

docs: consolidate README, cut repetitive sections #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 5 additions & 60 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

<br />

[Installation](#installation) · [Features](#features) · [Keyboard Shortcuts](#keyboard-shortcuts) · [Building from Source](#building-from-source)
[Installation](#installation) · [What Flying Feels Like](#what-flying-feels-like) · [Keyboard Shortcuts](#keyboard-shortcuts) · [Building from Source](#building-from-source)

</div>

Expand Down Expand Up @@ -92,45 +92,13 @@ Pane is the only tool that is a real desktop app, agent-agnostic, cross-platform

---

## Two Core Primitives
## How It Works

**Panes** — One per feature, one worktree each. Create a pane, get an isolated workspace. Delete a pane, everything cleans up.
Two primitives: **panes** and **tabs**. One pane per feature, one worktree each. Inside every pane, everything lives in tabs — agents, diff viewer, file explorer, git tree, logs, multiple terminals. Create a pane, get an isolated workspace. Delete a pane, everything cleans up. Your agents never step on each other, and every tab persists across restarts.

**Tabs** — Agents, diff viewer, file explorer, git tree, logs — everything lives in tabs. Everything persists across restarts.
Your agents already talk to Linear, Jira, GitHub, and Slack through MCPs and CLI tools. The terminal is the universal integration layer. Pane doesn't re-integrate what your agents already access — it gives them a place to run.

---

## The Integration Layer

Agents already access Linear, Jira, GitHub, Slack through MCPs and CLI tools. The terminal is the universal integration layer. Pane doesn't re-integrate what your agents already access — it provides the runtime environment.

---

## Features

### Agent-Agnostic
Run any CLI tool. Future agents work instantly — no waiting for official support. This is a promise, not a feature.

### Parallel Panes
Each pane gets its own worktree and multiple terminals. Close your laptop; everything persists when reopened.

### Keyboard-First
Every action has a shortcut. Command palette via `⌘K`. If something takes more than 100ms, it's a bug.

### Built-In Git Workflow
View diffs with syntax highlighting. Commit, push, rebase, squash, merge — all from keyboard shortcuts. Preview git commands before executing.

### Cross-Platform — Actually
Not "Mac-first with a Windows waitlist." Windows, Mac, and Linux — same UI, same shortcuts, same speed. Built by developers who use Windows daily.

### Everything is a Tab
Multiple views per session: Output, Diff, Terminal, Editor, Logs. Full xterm.js terminals with 50,000-line scrollback. Navigate with left/right arrows without touching the mouse.

### Session Management
Create sessions with templates. Archive instead of delete. Continue conversations with full history. AI-powered session naming. Real-time status tracking. Prompt history with search and one-click reuse.

### Notifications
Desktop and sound notifications for session status changes. Know when an agent is waiting for input, finished, or errored — without watching it.
Other tools build custom chat UIs that only work with agents they've explicitly added support for. Pane gives every agent a real terminal. "Future CLI agent support" isn't a roadmap item here — it's the default. You bring the agents, Pane makes them fly.

---

Expand Down Expand Up @@ -211,20 +179,6 @@ Pane is for the other 75%. And for Mac developers who want to choose their own a

---

## Design Principles

**Keyboard-first, always.** Every action has a shortcut. Power users never touch the mouse. New users discover shortcuts naturally. The keyboard isn't an alternative input — it's THE input.

**Agent-agnostic, forever.** We will never lock you into a single agent. Claude Code, Codex, Aider, Goose, your custom CLI tool — if it runs in a terminal, it runs in Pane.

**Cross-platform, actually.** The developer on a Surface Pro deserves the same tool as the developer on a MacBook Pro.

**Git-native, not git-adjacent.** Managing agent output IS managing git. The agent writes code. You review it. You commit it. That loop should be seamless.

**Speed is a feature.** If something takes more than 100ms, it's a bug. If an animation doesn't serve a purpose, remove it. If a UI element doesn't earn its pixels, it goes.

---

## Who Pane Is For

- **Developers on Windows and Linux** who are underserved by Mac-only AI coding tools
Expand Down Expand Up @@ -259,15 +213,6 @@ Pane uses xterm.js — the same terminal engine powering VS Code's integrated te

---

## Adding Custom Agents

Pane supports any CLI tool that runs in a terminal. See the docs for extending it:

- [Adding New CLI Tools](./docs/ADDING_NEW_CLI_TOOLS.md)
- [Implementing New CLI Agents](./docs/IMPLEMENTING_NEW_CLI_AGENTS.md)

---

## Building from Source

```bash
Expand Down
Loading