imgcat - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #android #linux #macos #awesome #cli #kubernetes #vue #ios #mcp

imgcat

(★ 919)

It's like cat, but for images.

File Explorer

Download Latest Version (.zip)

- - build-and-test.yml
  - compile-manpage.yml
- imgcat.1
- imgcat.1.md
- .gitignore
- color_db.py
- gen_img.py
- gen_table.py
- xterm-256color.yaml
- .gitignore
- imgcat.c
- load_image.cc
- load_image.h
- print_image.c
- print_image.h
- rgbtree.c
- rgbtree.h
- tree_256_color.h
- - 1px_256.jpg
  - 1px_256.png
  - 1px_8.png
  - 1px_grey.png
  - 1x512px_magenta.png
  - 512x512px_magenta.png
- - README.md
- run
.gitignore
.gitmodules
CImg
configure
LICENSE
Makefile
README.md
VERSION

# Installation Guide

1. Get the code

git clone https://github.com/eddieantonio/imgcat

Downloads the entire project code from GitHub to your computer.

cd imgcat

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Homebrew A package manager for macOS/Linux.
APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.

brew install eddieantonio/eddieantonio/imgcat

Installs the pre-built package via Homebrew — no source build required.

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

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt-get install libpng-dev libjpeg-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

make install

Compiles the code based on the generated build configuration to produce an executable.

make install PREFIX=/opt

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

imgcat
======

[![Build Status](https://github.com/eddieantonio/imgcat/workflows/Build%20and%20test%20imgcat/badge.svg\?branch\=master)](https://github.com/eddieantonio/imgcat/actions)

It's like `cat` but for images.

<p align="center">
  <img src="https://github.com/eddieantonio/i/raw/master/imgcat.png" alt="running `imgcat cat.jpg`" width=506 height=620>
</p>

Install
-------

On macOS:

```sh
brew install eddieantonio/eddieantonio/imgcat
```

**Important**: [See below](#note-on-iterm2s-shell-integration) if
you're using iTerm2 3.0 with shell integration installed.

For other platforms, see [Build](#build).

Usage
-----

```sh
imgcat some_image.jpg
```

See the [manpage](./docs/imgcat.1.md) for more invocations.

Note on iTerm2's shell integration
----------------------------------

If you install iTerm2's [shell integration], chances are you also
installed its additional scripts, including one called `imgcat`.
**iTerm's `imgcat` overrides this program by default**. To see if this
is happening to you, use `which` to determine where your shell is
finding imgcat:

which imgcat

If it says `imgcat: aliased to /Users/yourusername/.iterm2/imgcat`, then
you must edit your shell startup file and add `unalias imgcat` **after**
the line that sources iTerm2's script. For example:

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

[shell integration]: https://www.iterm2.com/documentation-shell-integration.html

Build
-----

### Clone

You must use `git clone --recurse-submodules` to clone this repository with its dependency, [CImg]:

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

### Requirements

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 this
command:

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

### Recommended dependencies

These dependencies are not necessary, but if `pkg-config` manages to
find a compatible version on the system, `imgcat` will link to it!

- libpng (any 1.x version supported by [CImg])
 - libjpeg (any version supported by [CImg])

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

sudo apt-get install libpng-dev libjpeg-dev

Then:

```sh
./configure
make
```

Install
-------

To install to `/usr/local`:

```sh
make install
```

To change the default prefix, simply provide `PREFIX=...`
to `make install`:

```sh
make install PREFIX=/opt
```

Acknowledgements
----------------

- Uses the [CImg], distributed under the [CeCILL-C] license.
 - 256 Color chart and data from Jason Milkin's [public domain chart][256svg].

[CImg]: https://github.com/dtschump/CImg
[CeCILL-C]: http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
[256svg]: https://gist.github.com/jasonm23/2868981

License
-------

Copyright © 2014–2023 Eddie Antonio Santos.
Distributed under the terms of the [ISC license](./LICENSE).