Skip to content
Terminal color capabilities detection
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
tasks
.gitignore
.rspec
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
ISSUE_TEMPLATE.md
LICENSE.txt
PULL_REQUEST_TEMPLATE.md
README.md
Rakefile
appveyor.yml
tty-color.gemspec

README.md

tty logo

TTY::Color Gitter

Gem Version Build Status Build status Code Climate Coverage Status Inline docs

Terminal color capabilities detection.

TTY::Color provides independent color support detection component for TTY toolkit.

Installation

Add this line to your application's Gemfile:

gem 'tty-color'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-color

Usage

TTY::Color allows you to check if terminal supports color:

TTY::Color.color?    # => true
TTY::Color.support?  # => true

Also you can get the number of colors supported by the terminal:

TTY::Color.mode # => 64

TTY::Color is just a module hence you can include it into your scripts directly:

#!/usr/bin/env ruby

include TTY::Color

puts color?

Command line tool

tty-color-cli is a command line tool for the TTY::Color.

To check if terminal supports colors do:

color -s

And to check color mode:

color -m

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-color. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

  1. Fork it ( https://github.com/piotrmurach/tty-color/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Copyright

Copyright (c) 2016 Piotr Murach. See LICENSE for further details.

You can’t perform that action at this time.