orca/README.md
Neil 0637883cce
Update README to include features list
Added features section to README with key functionalities.
2026-03-27 15:55:14 -07:00

54 lines
1.3 KiB
Markdown

<p align="center">
<img src="build/icon.png" alt="Orca" width="128" />
</p>
<h1 align="center">Orca</h1>
<strong>A cross-platform AI Orchestrator for nerds.</strong><br/>
Seamlessly manage multiple worktrees and open multiple terminals running anything — Claude Code, Codex, OpenCode, and more.<br/>
Built-in status tracking, notifications, and unread markers. Makes coding multiple features across multiple repos a breeze.
Learn more at <a align="center" href="https://www.orcabuild.ai">www.OrcaBuild.ai</a>
<p align="center">
<img src="screenshot.png" alt="Orca Screenshot" width="800" />
</p>
## Features
* Manage multiple worktrees
* Multiple terminals, tabs and panes
* Get worktree notifications (plus ability to manually mark threads as unread -- similar to Gmail ⭐)
* See which worktrees have working agents
* GitHub integrations for GH PRs (automatic), ability to link GH issues (via `gh` cli), and a GH checks viewer
* File editor, search, source control tab (see worktree changes, make edits, easily commit)
## Install
Grab a release from https://www.orcabuild.ai/ or download from the GH release page
## Developing
### Install
```bash
$ pnpm install
```
### Development
```bash
$ pnpm dev
```
### Build
```bash
# For windows
$ pnpm build:win
# For macOS
$ pnpm build:mac
# For Linux
$ pnpm build:linux
```