3 releases (stable)

new 1.1.0 Feb 22, 2025
1.0.0 Feb 20, 2025
0.1.0 Feb 13, 2025

#2 in #image-viewer

Download history 119/week @ 2025-02-11

119 downloads per month

MIT license

21KB
384 lines

pixt - Terminal Image Renderer

pixt is a command-line tool for rendering images directly in the terminal with various styles, including pixel-based, ASCII, block, and braille.

Installation

Using Cargo

cargo install pixt

Build from Source

git clone https://github.com/BiswajitThakur/pixt.git
cd pixt
cargo build --release
./target/release/pixt --help

Help

Usage: pixt [OPTIONS] [FILES]...

Arguments:
  [FILES]...  Input file paths

Options:
  -w, --width <WIDTH>    Output width in terminal characters
  -H, --height <HEIGHT>  Output height in terminal characters
  -c, --colored          Enable colored output
  -s, --style <STYLE>    Style of Output Image [default: pixel] [possible values: pixel, ascii, block, braills, dots, custom]
  -h, --help             Print help

Examples

Default with -c or --colored flag

pixt -c <path of image>

Default_-c

Default (without any flag)

pixt <path of image>

Default

pixt -c -s ascii <path of image>

ascii color image

pixt -s ascii <path of image>

ascii image

pixt -c -s custom ' `"-~:^>()*?[]{}=$#@' <path of image>

custom_color_image

pixt -s custom ' `"-~:^>()*?[]{}=$#@' <path of image>

custom image

pixt -c -s dots <path of image>

color dots image

pixt -s dots <path of image>

dots image

License

This project is licensed under the MIT License.

Contributing

Feel free to open issues or submit pull requests!

Dependencies

~6–15MB
~218K SLoC