https://github.com/williamragstad/termimgview

A terminal image viewer utility tool with lots of customization
https://github.com/williamragstad/termimgview

Last synced: 10 days ago
JSON representation

A terminal image viewer utility tool with lots of customization

• Host: GitHub
• URL: https://github.com/williamragstad/termimgview
• Owner: WilliamRagstad
• Created: 2023-11-14T22:10:16.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2023-11-19T14:29:38.000Z (12 months ago)
• Last Synced: 2024-05-01T16:06:22.027Z (6 months ago)
• Language: Rust
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Terminal Image Viewer

This is a simple image viewer for the terminal. It is written in Rust and uses `crossterm`, `image`, and `clap`.\

Inspiration and alternatives: [tiv](https://github.com/stefanhaustein/TerminalImageViewer), [timg](https://github.com/hzeller/timg), [termimage](https://github.com/nabijaczleweli/termimage), [imgcat](https://github.com/eddieantonio/imgcat), [viu](https://github.com/atanunq/viu), or [pixterm](https://github.com/eliukblau/pixterm).

## Installation

```bash

> git clone https://github.com/WilliamRagstad/termimgview.git

> cd termimgview

> cargo install --path .

```

## Usage

    

```

Usage: termimgview [OPTIONS] 

Arguments:

    Path to the image file to be displayed

Options:

  -m, --shade-method                 Shading method [default: blocks]

  -s, --scale                               The scale of the image [default: 1]

  -g, --grayscale                                  Grayscale image?

  -i, --invert                                     Invert image?

  -a, --adjust-aspect-ratio   Adjust aspect ratio [default: 0.47058824]

  -b, --brightness                     Brightness of the image [default: 1]

  -r, --hue-rotation                 Rotate the hue of the image [default: 0]

  -h, --help                                       Print help

  -V, --version                                    Print version

Shade methods:

 - ascii: ' .-:=+*#%@'

 - blocks: ' ░▒▓█'

 - custom: 'your characters here'

Example usage:

 - termimgview .\tests\1.png -s 0.15 -m " -:!|#@@@@@@@@"

 - termimgview .\tests\2.jpg -s 1 -i -m ascii

```

## Examples

| `1.png -s 0.5 -m half` | `2.jpg -s 0.5 -m ascii -i` | `3.png -s 0.5 -g` |

| --- | --- | --- |

| ![1.png](./assets/1.png) | ![1.png](./assets/2.png) | ![1.png](./assets/3.png) |

---