https://github.com/danielgatis/imgcat

Display images and gifs in your terminal.
https://github.com/danielgatis/imgcat

cli command-line display go golang image image-display image-preview preview terminal terminal-emulator tui

Last synced: 4 days ago
JSON representation

Display images and gifs in your terminal.

• Host: GitHub
• URL: https://github.com/danielgatis/imgcat
• Owner: danielgatis
• License: mit
• Created: 2020-09-24T22:56:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T23:31:26.000Z (6 months ago)
• Last Synced: 2025-01-18T01:05:38.684Z (11 days ago)
• Topics: cli, command-line, display, go, golang, image, image-display, image-preview, preview, terminal, terminal-emulator, tui
• Language: Go
• Homepage:
• Size: 8.87 MB
• Stars: 237
• Watchers: 4
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Imgcat

[![Go Report Card](https://goreportcard.com/badge/github.com/danielgatis/imgcat?style=flat-square)](https://goreportcard.com/report/github.com/danielgatis/imgcat)

[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/danielgatis/imgcat/master/LICENSE)

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/danielgatis/imgcat)

[![Release](https://img.shields.io/github/release/danielgatis/imgcat.svg?style=flat-square)](https://github.com/danielgatis/imgcat/releases/latest)

Display images and gifs in your terminal emulator.



    



### Features

- Animated GIF support

- Accept media through stdin

- Transparency

### Installation

#### MacOS

```

brew install danielgatis/imgcat/imgcat

```

#### Linux

First, [install snapcraft](https://snapcraft.io/docs/installing-snapd).

```

sudo snap install imgcat

```

#### Windows

First, [install scoop](https://github.com/lukesampson/scoop#installation).

```

scoop bucket add scoop-imgcat https://github.com/danielgatis/scoop-imgcat.git

scoop install scoop-imgcat/imgcat

```

#### Download binaries

Alternatively, you can download a pre-built binary [here](https://github.com/danielgatis/imgcat/releases).

### Build from source

First, [install Go](https://golang.org/doc/install).

Next, fetch and build the binary.

```bash

go install github.com/danielgatis/imgcat@latest

```

or, if you use pre-1.17 Go version, use the `go get` command:

```bash

go get -u github.com/danielgatis/imgcat

```

### Usage

Display a remote image

```

curl -s http://input.png | imgcat

```

Display a local image

```

imgcat path/to/image.png

```

### Requirements

Your terminal emulator must be support `true color` and use a `monospaced font` that includes the lower half block unicode character (`▄ U+2584`).

### License

Copyright (c) 2020-present [Daniel Gatis](https://github.com/danielgatis)

Licensed under [MIT License](./LICENSE)

### Buy me a coffee

Liked some of my work? Buy me a coffee (or more likely a beer)