Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/piotrmurach/tty-color

Terminal color capabilities detection
https://github.com/piotrmurach/tty-color

cli color ruby-gem tty tty-components

Last synced: about 1 month ago
JSON representation

Terminal color capabilities detection

Host: GitHub
URL: https://github.com/piotrmurach/tty-color
Owner: piotrmurach
License: mit
Created: 2016-01-01T19:03:47.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2024-03-31T21:13:54.000Z (9 months ago)
Last Synced: 2024-10-29T12:59:34.401Z (about 2 months ago)
Topics: cli, color, ruby-gem, tty, tty-components
Language: Ruby
Homepage: https://ttytoolkit.org
Size: 132 KB
Stars: 35
Watchers: 5
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

Open-Source-Ruby-and-Rails-Apps - tty-color - Terminal color capabilities detection 🔥 ✅ 🚀 (Happy Exploring 🤘)

README

        


  



# TTY::Color

[![Gem Version](https://badge.fury.io/rb/tty-color.svg)][gem]

[![Actions CI](https://github.com/piotrmurach/tty-color/actions/workflows/ci.yml/badge.svg)][gh_actions_ci]

[![Build status](https://ci.appveyor.com/api/projects/status/j1nflklmnfrb2yrf?svg=true)][appveyor]

[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-color/badges/gpa.svg)][codeclimate]

[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-color/badge.svg)][coverage]

[gem]: https://badge.fury.io/rb/tty-color

[gh_actions_ci]: https://github.com/piotrmurach/tty-color/actions/workflows/ci.yml

[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-color

[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-color

[coverage]: https://coveralls.io/github/piotrmurach/tty-color

> Terminal color capabilities detection.

**TTY::Color** provides independent color support detection component for [TTY](https://github.com/piotrmurach/tty) toolkit.

## Installation

Add this line to your application's Gemfile:

```ruby

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:

```ruby

TTY::Color.color?    # => true

TTY::Color.support?  # => true

```

You can also get the number of colors supported by the terminal using `mode` method:

```ruby

TTY::Color.mode # => 64

```

To detect if color support has been disabled with `NO_COLOR` environment variable, use `disabled?`:

```ruby

TTY::Color.disabled? # => false

```

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

```ruby

#!/usr/bin/env ruby

include TTY::Color

puts color?

```

## Command line tool

[tty-color-cli](https://github.com/piotrmurach/tty-color-cli) is a command line tool for the **TTY::Color**.

To check if terminal supports colors use `-s|--support`:

```bash

tty-color -s

tty-color --support

# => true

```

And to check color mode use `-m|--mode` option:

```bash

tty-color -m

tty-color --mode

# => 256

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## 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](http://contributor-covenant.org) 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

## Code of Conduct

Everyone interacting in the TTY::Color project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-color/blob/master/CODE_OF_CONDUCT.md).

## Copyright

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