mibu

mibu is a pure Zig library for low-level terminal manipulation.

Status: This library is in beta. Breaking changes may occur.

Tested with zig version 0.16.0 on Linux and Windows

Features

• Zero heap allocations.
• UTF-8 character support.
• Terminal raw mode support.
• Text styling: bold, italic, underline.
• Color output: supports 8, 16, and true color (24-bit).
• Cursor movement and positioning functions.
• Screen clearing and erasing utilities.
• Key event handling: codepoints, modifiers, and special keys.
• Mouse event handling: click, scroll, and release actions.

How to use

Add the library as a dependency in your build.zig.zon file:

zig fetch --save git+https://github.com/xyaman/mibu

Import the dependency in your build.zig file:

const mibu_dep = b.dependency("mibu", .{});
exe.root_module.addImport("mibu", mibu_dep.module("mibu"));

Use the library in your Zig code:

const std = @import("std");
const mibu = @import("mibu");
const color = mibu.color;

pub fn main() void {
    std.debug.print("{s}Hello World in purple!{s}\n", .{ color.fgRGB(.{ .r = 97, .g = 37, .b = 160 }), color.reset });
}

Getting Started

See the examples directory.

You can run the examples with the following command:

# Prints text with different colors
zig build color

# Prints what key you pressed, until you press `q` or `ctrl+c`
zig build event

# Switch to alternate screen
zig build alternate_screen

# Detect terminal background color
zig build termbg

TODO

• Mouse: Click and move (drag)

Projects that use mibu

• gurgeous/tennis — A small CLI for printing stylized CSV tables
• tornikegomareli/lumen — Real-time hardware monitoring TUI for macOS
• lance0/ahab — A Docker cleanup TUI
• zigtris — A minimal terminal Tetris written in Zig
• 2048 in zig — 2048 implementation in Zig