{"id":17159848,"url":"https://github.com/unhappychoice/terminal_image","last_synced_at":"2025-04-07T10:28:46.143Z","repository":{"id":35116064,"uuid":"208690459","full_name":"unhappychoice/terminal_image","owner":"unhappychoice","description":":desktop_computer: Show high resolution images on your terminal !","archived":false,"fork":false,"pushed_at":"2024-10-22T01:19:54.000Z","size":1587,"stargazers_count":32,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-23T01:02:25.117Z","etag":null,"topics":["cli","command-line","command-line-tool","high-resolution","image","iterm2","library","libsixel","ruby","terminal"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unhappychoice.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-16T02:12:21.000Z","updated_at":"2024-10-22T01:19:51.000Z","dependencies_parsed_at":"2024-06-25T10:56:56.591Z","dependency_job_id":"3799a799-bb6d-4494-9882-158d297b63aa","html_url":"https://github.com/unhappychoice/terminal_image","commit_stats":{"total_commits":364,"total_committers":3,"mean_commits":"121.33333333333333","dds":0.3983516483516484,"last_synced_commit":"437a050ce2e772e3358df50538d91ab8d56169a6"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unhappychoice%2Fterminal_image","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unhappychoice%2Fterminal_image/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unhappychoice%2Fterminal_image/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unhappychoice%2Fterminal_image/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unhappychoice","download_url":"https://codeload.github.com/unhappychoice/terminal_image/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247635040,"owners_count":20970653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","command-line-tool","high-resolution","image","iterm2","library","libsixel","ruby","terminal"],"created_at":"2024-10-14T22:15:17.791Z","updated_at":"2025-04-07T10:28:46.101Z","avatar_url":"https://github.com/unhappychoice.png","language":"Ruby","readme":"# TerminalImage\n\n[![Gem Version](https://badge.fury.io/rb/terminal_image.svg)](https://badge.fury.io/rb/terminal_image)\n[![Code Climate](https://codeclimate.com/github/unhappychoice/terminal_image/badges/gpa.svg)](https://codeclimate.com/github/unhappychoice/terminal_image)\n[![codecov](https://codecov.io/gh/unhappychoice/terminal_image/branch/master/graph/badge.svg)](https://codecov.io/gh/unhappychoice/terminal_image)\n[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/unhappychoice/terminal_image.svg)](https://libraries.io/github/unhappychoice/terminal_image)\n![](http://ruby-gem-downloads-badge.herokuapp.com/terminal_image?type=total)\n![GitHub](https://img.shields.io/github/license/unhappychoice/terminal_image.svg)\n\nTerminalImage is a library to show images on terminals. \nCurrently, this library supports [iTerm2](https://iterm2.com/index.html) and terminals with [libsixel](https://github.com/saitoha/libsixel) installed.\n\n![](./images/example.png)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'terminal_image'\n```\n\nTerminals other than iTerm2:\n\nPlease install `libsixel`'s `img2sixel` command following https://github.com/saitoha/libsixel#install\n\n## Usage\n\n```ruby\n# Print image by File object\nTerminalImage.show(File.open('your-image-path.png'))\n\n# Print image from URL\nTerminalImage.show_url('https://raw.githubusercontent.com/unhappychoice/terminal_image/master/images/sample.png')\n\n# Get encoded string ready to be displayed \nstring = TerminalImage.encode(File.open('your-image-path.png'))\n\n# Get encoded string ready to be displayed from URL\nstring = TerminalImage.encode_url('https://raw.githubusercontent.com/unhappychoice/terminal_image/master/images/sample.png')\n```\n\n## Contributing\n\nBug 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](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the TerminalImage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/unhappychoice/terminal_image/blob/master/CODE_OF_CONDUCT.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funhappychoice%2Fterminal_image","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funhappychoice%2Fterminal_image","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funhappychoice%2Fterminal_image/lists"}