How do I install and use Paint gem for terminal colors in Ruby?

Add `gem 'paint'` to your Gemfile and run `bundle install`, then require it with `require 'paint'`. Use `Paint['text', :red]` for basic colorization, with options for effects and RGB colors.

Paint vs rainbow gem: which is better for Ruby CLI tools?

Paint is faster and avoids core extensions, making it ideal for libraries. Rainbow offers string extensions like `'text'.red` for convenience but can cause conflicts in larger projects.

Does Paint work on Windows without extra software?

No, native Windows command prompt lacks ANSI support. You need tools like ansicon, ConEmu, or WSL to enable color output, as noted in the README's Windows support section.

How to use true color mode in Paint if it doesn't work automatically?

Since Paint 2.0, true color is default. If issues arise, manually set `Paint.mode = 256` at the start of your code and report the terminal to help improve detection.

Can I colorize only specific parts of a string with Paint?

Yes, use the templating feature: `Paint%['main %{sub}', color, sub: ['text', :blue]]`. This allows nested colorization, but be aware it creates complex escape sequences.

What terminals support all the effects in Paint like italic or blink?

Most terminals support basic effects like bold and underline, but advanced ones are rarely supported. Check your terminal's ANSI compatibility; Paint includes a list of often and not widely supported effects.

Open-Awesome

Paint

MITRuby

A fast Ruby gem for adding ANSI terminal colors and effects with a simple API and true color support.

GitHub

384 stars21 forks0 contributors

What is Paint?

Paint is a Ruby gem that adds ANSI terminal colors and effects to text output. It solves the problem of colorizing command-line interface (CLI) output with a fast, simple API that supports true color, 256-color palettes, and various text effects. It automatically detects terminal capabilities and falls back appropriately.

Target Audience

Ruby developers building command-line tools, libraries, or applications that require colored terminal output, especially those who need a lightweight, non-intrusive solution without core extensions.

Value Proposition

Developers choose Paint for its speed, simplicity, and flexibility—it outperforms similar gems, offers a clean API without monkey-patching, and supports advanced features like true color and nested colorization, making it ideal for both simple scripts and complex libraries.

Overview

Ruby gem for ANSI terminal colors 🎨︎ VERY FAST

Use Cases

Best For

Adding colored output to Ruby CLI tools and scripts
Building libraries that need terminal colors without core extensions
Creating rich, color-coded log messages in terminal applications
Developing educational tools that demonstrate ANSI escape codes
Enhancing command-line game interfaces with dynamic colors
Formatting terminal reports or dashboards with colored sections

Not Ideal For

Projects targeting Windows command prompt without additional ANSI support tools like ansicon or ConEmu
Developers who prefer monkey-patched string methods for quick colorization in scripts
Applications requiring widely supported advanced terminal effects like italic or rapid blink

Pros & Cons

Pros

No Core Extensions

Does not monkey-patch String class, making it safe for library development and avoiding conflicts with other gems, as highlighted in the README's philosophy.

Simple and Fast API

Uses a single `Paint.[]` method for all colorization needs, with benchmarks showing it outperforms similar gems like term-ansicolor and rainbow.

True Color Support

Defaults to 24-bit true color in Paint 2.0 with automatic fallback to 256 or 16 colors based on terminal detection, ensuring rich output on modern terminals.

Flexible Effects and Nesting

Supports a wide range of ANSI effects and allows colorizing substrings via templating with the `%` method, though the README notes it can create verbose sequences.

Cons

Windows Compatibility Issues

Relies on external tools like ansicon or WSL for ANSI support on native Windows, adding setup complexity and potential cross-platform headaches.

Unsupported Effects

Many ANSI effects listed, such as italic or rapid blink, are not widely supported across terminals, reducing their practical utility in real-world applications.

Verbose Nested Sequences

Substitution for nested colorization generates lengthy escape sequences that can be hard to debug and may impact performance in large or complex outputs.

Frequently Asked Questions

Related Projects

tmuxinator

Manage complex tmux sessions easily

Stars13,682

Forks625

Last commit13 days ago

colorls

A Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. :tada:

Stars5,129

Forks397

Last commit4 months ago

awesome_print

Pretty print your Ruby objects with style -- in full color and with proper indentation

Stars4,083

Forks449

Last commit1 year ago

Betty

Friendly English-like interface for your command line. Don't remember a command? Ask Betty.

Stars2,603

Forks210

Last commit5 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub