rheinard.korf.au

← All projects

Yowazi

Clear, compiled terminal user interfaces in plain JavaScript.

Yowazi is a set of packages for building terminal user interfaces in JavaScript, compiled to single binaries with Bun. It’s inspired by Bubbletea for Go, without forcing a web paradigm like React onto the terminal.

A small project browser built with singi, rangi and kumbu, recorded running in a terminal.

Design

  • Zero runtime dependencies. Plain JavaScript with JSDoc types, and no build step.
  • Elm-style architecture. Apps are init, update and view, with no side effects in update or view.
  • Semantic themes. Colours are named by role, such as primary, alert or error, not by ANSI code.
  • Compiled binaries. Bun’s binaries are bigger than Go’s or Rust’s, at around 65 to 70MB, but they’re written in a language more developers already know.

The packages

Yowazi means clarity in Swahili, and each package is named after a Swahili word for what it does.

Package Meaning What it does
singi foundation Terminal I/O: ANSI, raw mode, input decoding
rangi colour, paint Styling: colours, text attributes, themes, the box model
kini nucleus The runtime: init, update, view and commands
semu part, piece Components: spinners, text inputs, lists, modals
picha picture Snapshot testing across themes
kibali permit Serving apps over SSH, with public-key auth
hariri edit An ASCII art editor, as a demonstration app

Built with

JavaScript and Bun.

Status

Green field. Singi and rangi are at 0.1.0.

Yowazi on GitHub

← All projects