{"id":21644613,"url":"https://github.com/armaggheddon/terminal_viewer","last_synced_at":"2026-04-13T12:32:02.915Z","repository":{"id":251665771,"uuid":"838073172","full_name":"Armaggheddon/terminal_viewer","owner":"Armaggheddon","description":"A terminal application that brings images 🖼️ and videos 🎥 to life directly in your terminal! Display visuals in pixelated color mode, offering a unique and nostalgic experience. Perfect for developers who love working in the terminal! 🚀","archived":false,"fork":false,"pushed_at":"2024-08-13T11:00:29.000Z","size":9240,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T11:07:20.794Z","etag":null,"topics":["cli-applications","cross-platform-app","mediaviewer","opencv","python3","terminal"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Armaggheddon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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":"2024-08-04T21:26:30.000Z","updated_at":"2024-08-13T11:00:32.000Z","dependencies_parsed_at":"2024-11-25T06:31:17.754Z","dependency_job_id":null,"html_url":"https://github.com/Armaggheddon/terminal_viewer","commit_stats":null,"previous_names":["armaggheddon/terminal_viewer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Armaggheddon/terminal_viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Armaggheddon%2Fterminal_viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Armaggheddon%2Fterminal_viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Armaggheddon%2Fterminal_viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Armaggheddon%2Fterminal_viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Armaggheddon","download_url":"https://codeload.github.com/Armaggheddon/terminal_viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Armaggheddon%2Fterminal_viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31753101,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-applications","cross-platform-app","mediaviewer","opencv","python3","terminal"],"created_at":"2024-11-25T05:41:29.011Z","updated_at":"2026-04-13T12:32:02.889Z","avatar_url":"https://github.com/Armaggheddon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# terminal_viewer 🎥 \n\n\u003cdiv align=\"center\"\u003e\n\t\u003cimg src=\"./docs/terminal_viewer_anim_op.gif\"\u003e\n\u003c/div\u003e\n\n**terminal_viewer** is a simple command line application designed to display media files directly in the terminal. It leverages OpenCV for handling image files and PyAV for video files, ensuring compatibility with a wide range of media formats supported by these libraries. This tool is ideal for users who prefer working within the terminal environment and need a quick way to preview media files without leaving the command line.\n\n## Features\n- 🖼️ **Image and Video Support**: Display both images and videos in the terminal.\n- 🎨 **Grayscale Option**: View media files in grayscale with a simple flag.\n- ⚡ **Lightweight and Fast**: Optimized for quick previews and minimal resource usage.\n- 🛠️ **Customizable**: Easily specify multiple files or folders to display.\n- 💻 **Terminal-Friendly**: Ideal for users who prefer working within the terminal environment.\n\n\n## Installation\n1. Clone the repository: \n    ``` bash\n    git clone https://github.com/Armaggheddon/terminal_viewer.git\n    cd terminal_viewer\n    ```\n1. Install the required dependencies\n    ```bash\n    pip install -r requirements.txt\n    ```\n1. Build the python wheel:\n    ``` bash\n    python .\\setup.py sdist bdist_wheel\n    ```\n1. Depending on your os:\n    ``` bash\n    # for windows\n    pip install .\\dist\\terminal_viewer-0.1-py3-none-any.whl\n\n    # for MacOS/Linux\n    pip install .\\dist\\terminal_viewer-0.1.tar.gz\n    ```\n    If the tool is already installed run the above command with `--force-reinstall` option.\n1. Launch the application with:\n    ```bash\n    terminal_viewer --help\n    ```\n\n## Usage\nThe application supports the following arguments:\n- `-s`, `--source`: specifies a single media file to be opened. Multiple files can be specified using a space as a separator between paths.\n- `-f`, `--folder`: specifies a single folder that can contain 1 or more media files to be displayed. Multiple folders can be specified using a space as a separator between paths.\n- `-g`, `--grayscale`: display the media files in grayscale. By default all the media files are shown in RGB 256. \n- `-h`, `--help`: show the available commands with a brief description.\n\nOnce the application is launched the following keys can be used to perform specific actions:\n- `q`: quits the application.\n- `r`: rewinds the current video being played. Works only on videos.\n- `m`: goes to the next media if any, or terminates the application if the current media is the last one.\n- `n`: goes to the previous media if any, if the current media is the first one behaves like a rewind command. \n- `+`: goes to the next keyframe. Works only on videos.\n- `-`: goes to the previous keyframe. Works only on videos.\n- `p`: play/pause the current media. Works only on videos. \n- `t`: hides/shows an overlay with the media file name, the current position in the queue of items to be played and, if the media file is a video, the progress bar with the media duration.\n- `h`: hides/shows an onverlay with all of the above commands.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"./docs/unsupported_media.png\" alt=\"unsupported media\" width=\"100%\"/\u003e\u003cbr\u003eUnsupported media\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"./docs/img_display.png\" alt=\"display image\" width=\"100%\"/\u003e\u003cbr\u003eDisplaying an image\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr align=\"center\"\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"./docs/video_display.png\" alt=\"unsupported media\" width=\"100%\"/\u003e\u003cbr\u003eDisplaying a video\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"./docs/grayscale.png\" alt=\"display grayscale\" width=\"100%\"/\u003e\u003cbr\u003eDisplaying media with grayscale\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Examples\nThe following examples show how to use the application.\n\n- Display a single image:\n    ```bash\n    terminal_viewer -s path/to/image.jpg\n    ```\n- Display a single video:\n    ```bash\n    terminal_viewer -s path/to/video.mp4\n    ```\n- Display a single image in grayscale:\n    ```bash\n    terminal_viewer -s path/to/image.jpg -g\n    ```\n- Display all the media files in a folder:\n    ```bash\n    terminal_viewer -f path/to/folder\n    ```\n\n### Dependencies\n\n- [OpenCV](https://github.com/opencv/opencv) 📸\n- [PyAV](https://github.com/PyAV-Org/PyAV) 🎞️\n- [NumPy](https://github.com/numpy/numpy) 🔢","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmaggheddon%2Fterminal_viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farmaggheddon%2Fterminal_viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmaggheddon%2Fterminal_viewer/lists"}