Project

boreal

0.0
The project is in a healthy, maintained state
True 24-bit Nord palette theming for CLI tools. Wraps TTY components (box, table, spinner, progress) with unified Nord styling via the Paint gem.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 13.0
~> 3.12

Runtime

~> 2.3
~> 0.8
~> 0.7
~> 0.12
 Project Readme

boreal

Nord-themed CLI look-and-feel for Ruby.

Overview

Boreal provides true 24-bit Nord palette theming for CLI tools. It wraps TTY components (box, table, spinner, progress bar, banner, logger) with unified Nord styling via the Paint gem. All components share a consistent color palette and semantic roles (success, warning, error, info).

Installation

gem 'boreal'

Requires Ruby >= 3.3.0.

Usage

require 'boreal'

# Paint text with semantic roles
Boreal.paint("ok", :success)
Boreal.bold("important", :warning)
Boreal.status(:error, "something broke")

# Components
Boreal::Components::Table.new(headers: [...], rows: [...]).render
Boreal::Components::Spinner.new("Loading...").run { do_work }
Boreal::Components::Progress.new(total: 100).advance(10)
Boreal::Components::Box.new("Title", "content").render
Boreal::Components::Banner.new("App Name").render
Boreal::Components::Logger.info("message")

Dependencies

  • paint -- true 24-bit color
  • tty-box, tty-table, tty-spinner, tty-progressbar -- TTY components
  • pastel -- Pastel compatibility layer

License

Apache-2.0