Skip to content

Latest commit

 

History

History
92 lines (54 loc) · 2.42 KB

termimage.md

File metadata and controls

92 lines (54 loc) · 2.42 KB

termimage(1) -- Display images in your terminal, kind of

SYNOPSIS

termimage [OPTIONS] <>

DESCRIPTION

Show images in your terminal.

The images are automatically downscaled to the terminal's size and their colours are approximated to match the terminal's display colours.

With simple ANSI output this means a 3-bit colour resolution, with WinAPI - 4-bit.

With WinAPI output the output colours are acquired from the console itself, with ANSI output a sane default is assumed.

OPTIONS

<>

Image to display.

The format is guessed from the extension or magic.

-s --size <>

Output image resolution.

By default this is autodetected to match the output terminal's resolution,
but is required when outputting to a file.

Format: NxM

-a --ansi <<ANSI_type>>

Force ANSI output of the specified kind,

The accepted values are "truecolor", "simple-black", and "simple-white",
truecolor is the default on non-Windows.

Simple ANSI output uses 3-bit background colours for the specified background,
while truecolor supports the whole 24-bit pallette.

-f --force

By default the image's aspect ratio will be preserved when downscaling,
use this option to override that behaviour.

EXAMPLES

termimage [-s NxM] [-f] assets/image.png

Display assets/image.png in the terminal using the default output type,
optionally not preserving the aspect ratio.

termimage [-s NxM] [-f] [-a simple] assets/image.png

Display assets/image.png in the terminal using the simple ANSI output type,
optionally not preserving the aspect ratio.

(for f in $(find image_dir -type f); do termimage -s NxM [-f] [-a ANSI_type] $f; done) > out_file

Print all images in image_dir to out_file.

Note the --size option being specified, since it's required when outputting to a file.

AUTHOR

Written by nabijaczleweli <[email protected]>, Josh Triplett <[email protected]>, Aaron Hill <[email protected]>, and caeklol

SPECIAL THANKS

To all who support further development, in particular:

  • ThePhD
  • Embark Studios
  • Lars Strojny
  • EvModder

REPORTING BUGS

<https://github.com/nabijaczleweli/termimage/issues>

SEE ALSO

<https://github.com/nabijaczleweli/termimage>