shui

🚀 Quick Start

Install shui and print your first styled message in seconds.

git clone https://github.com/kud/shui ~/.shui
source ~/.shui/shui.zsh

shui message success "Deployment complete"
shui message error   "Build failed"
shui message warning "Deprecated flag used"
shui message info    "Running in dry-run mode"
shui message muted   "Skipped (already up-to-date)"
✅ Deployment complete
❌ Build failed
⚠ī¸ Deprecated flag used
ℹī¸ Running in dry-run mode
   Skipped (already up-to-date)

đŸ“Ĩ Importing in a script

Source shui at the top of any Zsh script:

#!/usr/bin/env zsh
source "${0:A:h}/lib/shui/shui.zsh"

${0:A:h} is the Zsh idiom for the absolute directory of the current script — the path resolves correctly regardless of where you call the script from.

To select a theme before loading:

SHUI_THEME=minimal SHUI_ICONS=emoji source shui.zsh

đŸ“Ļ Installation

Manually

git clone https://github.com/kud/shui ~/.shui
git submodule add https://github.com/kud/shui lib/shui

Antidote

Add kud/shui to your .zsh_plugins.txt, then antidote load.

Zinit

zinit light kud/shui

Oh My Zsh

git clone https://github.com/kud/shui ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/shui

Then add shui to the plugins array in ~/.zshrc.

Zplug

zplug "kud/shui"

✅ Requirements

  • Zsh 5.0+
  • A Nerd Font for the default and minimal themes — or use SHUI_ICONS=emoji or SHUI_ICONS=none.

👋 Introduction

A fluid terminal UI for Zsh — semantic components, a token-based theme engine, and one consistent API.

🧩 Components

Messages, text, layout, badges, pills, boxes, and tables.

On this page

đŸ“Ĩ Importing in a scriptđŸ“Ļ InstallationManuallyAs a project submodule (recommended for scripts)AntidoteZinitOh My ZshZplug✅ Requirements