Description
TerminalImage is a library to show images on terminals. Currently, this library supports iTerm2 and terminals with libsixel installed.
TerminalImage alternatives and similar gems
Based on the "CLI Utilities" category
-
tty-command
Execute shell commands with pretty output logging and capture stdout, stderr and exit status.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of TerminalImage or a related project?
README
TerminalImage
TerminalImage is a library to show images on terminals. Currently, this library supports iTerm2 and terminals with libsixel installed.
[](./images/example.png)
Installation
Add this line to your application's Gemfile:
gem 'terminal_image'
Terminals other than iTerm2:
Please install libsixel's img2sixel command following https://github.com/saitoha/libsixel#install
Usage
# Print image by File object
TerminalImage.show(File.open('your-image-path.png'))
# Print image from URL
TerminalImage.show_url('https://raw.githubusercontent.com/unhappychoice/terminal_image/master/images/sample.png')
# Get encoded string ready to be displayed
string = TerminalImage.encode(File.open('your-image-path.png'))
# Get encoded string ready to be displayed from URL
string = TerminalImage.encode_url('https://raw.githubusercontent.com/unhappychoice/terminal_image/master/images/sample.png')
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/unhappychoice/terminal_image. 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 TerminalImage projectβs codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
*Note that all licence references and agreements mentioned in the TerminalImage README section above
are relevant to that project's source code only.