Important

I archived this repo here and moved it to Codeberg for several reasons.
🛠️ It's still active there!

NattyUI ​ᓚᕠᗢ

This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, natty user interface you like to have for your command line applications. It contains elegant, simple and beautiful tools that enhance your command line interfaces functionally and aesthetically.

• Gem: rubygems.org
• Source: codeberg.org
• Help: rubydoc.info

Features

• automatic line break of all text output
• markup of text attributes and colors using a BBCode like syntax
• automatic detection if ANSI is available
• support of NO_COLOR convention
• support of CSIu input protocol
• headings
• text separators
• lists
• various types of text blocks with automatic alignment
• text columns
• tables
• task lists
• progress indicators
• and more!

Help

📕 See the online help and have a look at the examples directory to learn from code.

Run Examples

You can execute all examples by

ruby ./examples/examples.rb

or see the non-ANSI version

NO_COLOR=1 ruby ./examples/examples.rb

Installation

You can install the gem in your system with

gem install natty-ui

or you can use Bundler to add NattyUI to your own project:

bundle add natty-ui

After that you only need one line of code to have everything together

require 'natty-ui'