kittyimg

README

kittyimg

kittyimg is a Go library that allows to display images in terminal emulators implementing kitty's terminal graphics protocol.

Status

A basic API (Fprint, Fprintln) allows to display an image (loaded with stdlib's image package) at the cursor position.

go get github.com/dolmen-go/kittyimg

A command-line tool (icat) is provided.

go install github.com/dolmen-go/kittyimg/cmd/icat

See also

The Go Playground has support for displaying images with its own protocol (IMAGE: prefix followed by base64 image file data).

tycat: https://git.enlightenment.org/apps/terminology.git/tree/src/bin/tycat.c Similar tool, but for the Enlightenment Terminology app (which uses a different terminal protocol).

License

Copyright 2021 Olivier Mengué

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Overview

Package kittyimg provides utilities to show image in a graphic terminal emulator supporting kitty's "terminal graphics protocol".

See https://sw.kovidgoyal.net/kitty/graphics-protocol.html.

Example

package main

import (
	"embed"
	"image"
	"os"

	// Plugin to decode GIF

	"github.com/dolmen-go/kittyimg"
	_ "image/gif"
)

//go:embed dolmen.gif
var files embed.FS

func main() {
	f, err := files.Open("dolmen.gif")
	if err != nil {
		panic(err)
	}
	defer f.Close()

	img, _, err := image.Decode(f)
	if err != nil {
		panic(err)
	}

	kittyimg.Fprintln(os.Stdout, img)
}

Index

• func Fprint(w io.Writer, img image.Image) error
• func Fprintln(w io.Writer, img image.Image) error

Examples

• Package

Functions

func Fprint

func Fprint(w io.Writer, img image.Image) error

func Fprintln

func Fprintln(w io.Writer, img image.Image) error