tty logo

TTY::Link

Gem Version Build Status Build status Maintainability Coverage Status Inline docs

Hyperlinks in your terminal

TTY::Link allows you to test whether a terminal supports hyperlinks and print them to the console. It is a component in TTY toolkit

Terminal emulators such as iTerm2 or GNOME, XFCE that use VTE widget support web style hyperlinks via Ctrl+click or Cmd+click.

Installation

Add this line to your application's Gemfile:

gem 'tty-link'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-link

Usage

To print hyperlink in your terminal do:

puts TTY::Link.link_to("TTY toolkit", "https://ttytoolkit.org")
# =>
# TTY toolkit

In cases when the terminal cannot support hyperlinks, an alternative is printed:

# TTY toolkit -> https://ttytoolkit.org

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-link. 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.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the TTY::Link project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright

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