- Rust 98.9%
- Nix 0.6%
- Makefile 0.3%
- Python 0.2%
f85297331fSigned-off-by: NotAShelf <raf@notashelf.dev> Change-Id: If376069bf3f86db85cca48255eab96116a6a6964 |
||
|---|---|---|
| contrib | ||
| crates | ||
| doc | ||
| fuzz | ||
| nix | ||
| scripts | ||
| terminfo | ||
| .clippy.toml | ||
| .deny.toml | ||
| .envrc | ||
| .gitignore | ||
| .rustfmt.toml | ||
| .taplo.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| flake.lock | ||
| flake.nix | ||
| Makefile | ||
| README.md | ||
🍺 beer
A terminal worth pouring time into.
A small, fast, Wayland-native terminal emulator written in Rust drawn entirely on the CPU, with no GPU pipeline, no tabs, and no async runtime to get in the way.
Why another terminal?
Two reasons, actually. The first one and the one that motivated me try and build my own terminal is, obviously, that I just wanted to. While I don't necessarily find Wayland interesting, I've been meaning to get a bit acquainted with it for personal reasons. That, combined with my personal disagreements with foot's handling of fullscreen transparency, and a C codebase I found hard to keep up to date if I were to fork, I decided to look for a new terminal.
Most terminals reach for the GPU and a stack of abstractions before they draw a
single glyph. beer goes the other way. It takes its cues from foot to keep
the moving parts few, render with the CPU through wl_shm, talk to a real PTY,
and stay out of the way. Since I could not identify and settle with a terminal
that checks all the boxes, I decided to write one for real.
The result is a terminal that starts instantly, sits quietly in the background, and spends its cycles on your shell rather than on itself. It is the kind of tool you forget is running which, for a terminal, is the highest compliment. Pour one, get to work.
Project status
beer is pre-1.0 but already comfortable as a daily driver on Wayland. It
renders truecolor text with styled attributes and colour emoji, scrolls back
with incremental search, handles mouse selection and clipboard, follows the
compositor's fractional scale, and speaks the kitty keyboard, graphics, and
text-sizing protocols. It runs standalone or as a daemon that hosts many windows
from one process.
Feature requests are welcome, but not everything will be implemented.
Tip
Manual pages (
beer(1),beer.toml(5),beer-themes(7)) are generated fromdoc/with scdoc and installed by the package; a commented starting config lives atcontrib/beer.toml.
What's in here
This is a Cargo workspace with five production crates and one separate fuzzing crate:
crates/beer- the terminal application itself. Start here for the feature list, installation, configuration, and day-to-day use.crates/beer-protocols- the reusable, self-documenting building blocks the terminal is made of, and a readable reference for the escape sequences and protocolsbeerspeaks.crates/beer-ipc- the Unix-socket protocol used by daemon and client processes.crates/beer-window- the platform-neutral application/windowing contract.crates/beer-wayland- the Wayland backend that drives the application contract.
cargo-fuzz targets for protocol parsers and decoders.
If you just want to run it, head to the application README. If you are curious how a terminal actually talks to the programs inside it, the protocols README is a friendly tour.