Files
lumbridge-code/README.md
T
2026-08-31 17:46:18 -07:00

74 lines
3.6 KiB
Markdown

# Lumbridge
Lumbridge is a fast, local-first workspace and terminal multiplexer for agentic
engineers. It will run coding harnesses side by side, preserve their sessions,
connect rich agents through ACP, and show trustworthy account and usage context
without forcing users into one model vendor.
The first supported desktop platforms are:
- macOS (Apple Silicon first, Intel when CI capacity is available)
- Ubuntu Linux
- Omarchy and compatible Arch Linux systems
Lumbridge is free and open source under Apache-2.0. Releases will be published
as installable binaries; building from source will remain supported.
## Status
This repository is in architecture and vertical-slice phase. The installable
binary is still a scaffold, while the isolated native UI spikes now exercise an
interactive 20/60/20 workspace backed by six live comparison surfaces, and the
root workspace contains the first bounded local PTY, runtime actor, VT engine,
and capability-gated workspace command boundaries. The GPUI slice shows a
responsive one-, three-, or five-lane work band—five on a 3440 px ultrawide—with
one styled actor-owned VT session and five deterministic comparison surfaces.
Retained-history navigation is wired. We are still validating terminal text
selection and mouse input, standalone runtime IPC/durability, ACP integration,
packaging, and usage-data contracts before a large implementation.
## Product shape
- A native desktop shell with tabs, panes, workspaces, worktrees, diffs, and an
agent-aware footer.
- A Rust session runtime that survives UI restarts and can later run headless.
- ACP-native integrations where available, with supervised PTYs as the universal
fallback for any CLI harness.
- First-class harnesses for Claude Code, Codex, DeepSeek Harness, Pi, Hermes,
OpenClaw, Goose, Gemini CLI, and OpenCode.
- Subscription login owned by the upstream harness, plus separate BYOK provider
profiles for OpenAI, Anthropic, Gemini, Groq, Cerebras, DeepSeek, and more.
- Usage history, burn rate, reset windows, and forecasts with visible data
provenance instead of invented precision.
- Optional first-class Buzz channels, messages, agents, and confirmed redacted
pane sharing without making Buzz a requirement.
- An optional Lumbridge Harness that can suggest, coordinate, and—with explicit
execution capability—manage agents through the same audited command plane as
the human UI. Lumbridge remains useful without it.
Start with [the product spec](docs/PRODUCT_SPEC.md),
[architecture](docs/ARCHITECTURE.md), [research map](docs/RESEARCH.md), and
[captured upstream revisions](docs/RESEARCH_SNAPSHOTS.md). The native UI choice
is intentionally open; see [the measured decision plan](docs/UI_OPTIONS.md).
## Scaffold
```bash
bacon # continuous check; t tests, c lints, v runs the full gate
cargo xtest # fast isolated tests with nextest
./scripts/ci.sh # format + strict Clippy + tests + doctests
cargo run -p lumbridge
```
See [the testing strategy](docs/TESTING.md) for fake harnesses, ACP replay,
terminal conformance, UI driving, recovery, performance, and packaging tests.
The accepted local/remote boundary is recorded in
[decision 0003](docs/decisions/0003-local-data-and-remote-sessions.md). The two
native shell candidates live in [`spikes/`](spikes/), with results tracked in
[the UI scorecard](docs/UI_SPIKE_SCORECARD.md).
The signed-protocol and pane-sharing boundary is in
[the Buzz integration design](docs/BUZZ_INTEGRATION.md).
Brand masters, platform-ready raster exports, and usage rules are in
[`assets/brand/`](assets/brand/) and [the brand guide](docs/BRAND.md).