Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spenserblack/termage

(My first real Golang project) Browse images (including animated GIFs!) in the terminal
https://github.com/spenserblack/termage

animated animated-gif animated-gifs ascii browse browse-images gif go golang image image-browser image-viewer jpeg jpg png terminal tui

Last synced: 2 months ago
JSON representation

(My first real Golang project) Browse images (including animated GIFs!) in the terminal

Host: GitHub
URL: https://github.com/spenserblack/termage
Owner: spenserblack
License: mit
Created: 2021-04-19T12:35:40.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-06-17T12:25:04.000Z (7 months ago)
Last Synced: 2024-10-13T16:47:57.774Z (3 months ago)
Topics: animated, animated-gif, animated-gifs, ascii, browse, browse-images, gif, go, golang, image, image-browser, image-viewer, jpeg, jpg, png, terminal, tui
Language: Go
Homepage:
Size: 571 KB
Stars: 4
Watchers: 1
Forks: 1
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# termage

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/spenserblack/termage)
[![CI](https://github.com/spenserblack/termage/actions/workflows/ci.yml/badge.svg)](https://github.com/spenserblack/termage/actions/workflows/ci.yml)
[![CodeQL](https://github.com/spenserblack/termage/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/spenserblack/termage/actions/workflows/github-code-scanning/codeql)
[![Go Report Card](https://goreportcard.com/badge/github.com/spenserblack/termage)](https://goreportcard.com/report/github.com/spenserblack/termage)
[![codecov](https://codecov.io/gh/spenserblack/termage/branch/master/graph/badge.svg)](https://codecov.io/gh/spenserblack/termage)

[![GitHub all releases](https://img.shields.io/github/downloads/spenserblack/termage/total)][latest-release]

Browse images in the terminal *with support for animated GIFs :tada:*

## :warning: Archival Notice

So this tool, while fun to make, was poorly written IMO. Rather than work on it, I'm going to archive it. If you stumble on this repository
and are interested in a way to render images in the terminal, there are plenty of other options. Personally, I'll be using [viu](https://github.com/atanunq/viu).

## Examples

### PNG image

![Viewing a PNG image](./_resources/viewing_png.png "PNG image")

### Animated GIF

![Viewing an animated GIF](./_resources/viewing_gif.gif "Animated GIF")

## Installation

The following commands simplify installing from the [latest release][latest-release].

### Linux/MacOS

```shell
curl https://raw.githubusercontent.com/spenserblack/termage/HEAD/install.sh | bash
```

### PowerShell

```powershell
Invoke-WebRequest "https://raw.githubusercontent.com/spenserblack/termage/HEAD/install.ps1" | Invoke-Expression
```

## Usage

### Help

```sh
termage --help
```

### Browse all images in a directory

#### Starting from first image in directory

```sh
termage path/to/dir/
```

#### Starting from a specific image

```sh
termage path/to/dir/image
```

### Browse a specific subset of images

```sh
termage path/to/image1 path/to/image2 # ...
```

## Controls

- `n`: Next image
- `N`: Previous image
- `z`: Increase zoom by 10 percentiles
- `Z`: Decrease zoom by 10 percentiles
- `f`: Fit to screen
- `h`: Scroll left one pixel
- `H`: Scroll left 10%
- `j`: Scroll down one pixel
- `J`: Scroll down 10%
- `k`: Scroll up one pixel
- `K`: Scroll up 10%
- `l`: Scroll right one pixel
- `L`: Scroll right 10%
- `Esc`: Exit application

## Supported Formats

- PNG
- JPEG
- GIF

[latest-release]: https://github.com/spenserblack/termage/releases/latest