Readme
Operating System: Unix / Linux / Mac OS X / Windows (limited support, see the FAQs)
Python >= 3.7
A terminal emulator with any of the following:
Plans to support a wider variety of terminal emulators are in motion (see the library's planned features).
The latest version can be installed from PyPI using pipx with:
pipx install termvisage
and upgraded with:
pipx upgrade termvisage
NOTE: pip can also be used but pipx is recommended.
| block | iterm2 | kitty |
|---|---|---|
 |  |  |
 |  |
|---|
Check out the Gallery for more.
With a file path:
termvisage path/to/image.png
With a URL:
termvisage https://www.example.com/image.png
With a directory, recursively (not currently supported on Windows):
termvisage -r path/to/dir/
If a single source is given and it's animated (GIF, APNG, Animated WebP), the animation is infinitely looped by default and can be stopped with Ctrl-C (SIGINT).
By default, if multiple sources or at least one directory source is given, the TUI (Terminal User Interface) is launched to navigate through the images and/or directories.
Run termvisage --help to see the basic help message or termvisage --long-help for the full help message.
See the CLI manual.
The controls are context-based and always displayed at the bottom of the screen.
Pressing the F1 key (in most contexts) brings up a help menu describing the available controls (called actions) in that context.
The TUI can be configured using a config file. See the Configuration section of the docs.
Here is a config file with Vim-style key-bindings (majorly navigation).
See the TUI manual.
If you've found any bug or want to suggest a new feature, please open a new issue with proper description, after browsing/searching through the existing issues and making sure you won't create a duplicate.
For code contributions, please read through the guidelines.
Also, check out the Planned Features section below. If you wish to work on any of the listed tasks, please click on the linked issue or go through the issues tab and join in on an ongoing discussion about the task or create a new issue if one hasn't been created yet, so that the implementation can be discussed.
Hint: You can filter issues by label or simply search using the task's name or description.
For anything other than the above (such as questions or anything that would fit under the term "discussion"), please open a new discussion instead.
Thanks! 💓
See here.
See here.
See the FAQs section of the docs.
The following projects have been (and are still) crucial to the development of this project:
The logo was composed using resource(s) from the following source(s):
Thanks to @digitallyserviced for the project name and logo concept.
Any amount will go a long way in aiding the progress and development of this project. Thank you! 💓
FAQs
Display and browse images in the terminal
We found that termvisage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.