Repository files navigation

It's likecat but for images.

On macOS:

brew install eddieantonio/eddieantonio/imgcat

Important:See below ifyou're using iTerm2 3.0 with shell integration installed.

For other platforms, seeBuild.

imgcat some_image.jpg

See themanpage for more invocations.

If you install iTerm2'sshell integration, chances are you alsoinstalled its additional scripts, including one calledimgcat.iTerm'simgcat overrides this program by default. To see if thisis happening to you, usewhich to determine where your shell isfinding imgcat:

which imgcat

If it saysimgcat: aliased to /Users/yourusername/.iterm2/imgcat, thenyou must edit your shell startup file and addunalias imgcatafterthe line that sources iTerm2's script. For example:

test -e ${HOME}/.iterm2_shell_integration.zsh && source ${HOME}/.iterm2_shell_integration.zshunalias imgcat

You must usegit clone --recurse-submodules to clone this repository with its dependency,CImg:

git clone --recurse-submodules https://github.com/eddieantonio/imgcat.git

To build from source, you need the following:

• GNU make
• pkg-config
• ncurses with header files

On Debian/Ubuntu/Mint/etc. you can get these packages with thiscommand:

sudo apt-get install build-essential pkg-config libncurses5-dev

These dependencies are not necessary, but ifpkg-config manages tofind a compatible version on the system,imgcat will link to it!

• libpng (any 1.x version supported byCImg)
• libjpeg (any version supported byCImg)

On Debian/Ubuntu/Mint/etc. you can get these packages with thiscommand:

sudo apt-get install libpng-dev libjpeg-dev

Then:

./configuremake

To install to/usr/local:

make install

To change the default prefix, simply providePREFIX=...tomake install:

make install PREFIX=/opt

• Uses theCImg, distributed under theCeCILL-C license.
• 256 Color chart and data from Jason Milkin'spublic domain chart.

Copyright © 2014–2023 Eddie Antonio Santos.Distributed under the terms of theISC license.