Skip to content
Terminal screen detection - cross platform, major ruby interpreters
Ruby
Branch: master
Clone or download
Latest commit 59c6404 May 19, 2019

README.md

tty logo

TTY::Screen Gitter

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

Terminal screen size detection which works on Linux, OS X and Windows/Cygwin platforms and supports MRI, JRuby and Rubinius interpreters.

TTY::Screen provides independent terminal screen size detection component for TTY toolkit.

Installation

Add this line to your application's Gemfile:

gem 'tty-screen'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-screen

1. Usage

TTY::Screen allows you to detect terminal screen size by calling size method which returns [height, width] tuple.

TTY::Screen.size     # => [51, 280]

To read terminal width do:

TTY::Screen.width    # => 280
TTY::Screen.columns  # => 280
TTY::Screen.cols     # => 280

Similarly, to read terminal height do:

TTY::Screen.height   # => 51
TTY::Screen.rows     # => 51
TTY::Screen.lines    # => 51

Contributing

  1. Fork it ( https://github.com/piotrmurach/tty-screen/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

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.

Copyright

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

You can’t perform that action at this time.