Files
lumbridge-code/README.md
T
2026-08-31 15:42:26 -07:00

63 lines
2.7 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 product-definition phase. The current
binary is deliberately only a scaffold. We are validating the terminal engine,
UI stack, process/session model, ACP integration, packaging, and usage-data
contracts before committing to 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.
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).