sindresorhus / term-img Goto Github PK

View Code? Open in Web Editor NEW

307.0 7.0 12.0 946 KB

Display images in iTerm

License: MIT License

JavaScript 74.80% TypeScript 25.20%

terminal-image image iterm2 cli-utility nodejs npm-package

term-img's Introduction

term-img

Display images in iTerm

You probably want the higher-level terminal-image package for displaying your images.

Even animated gifs!

Currently only supported on iTerm >=3.

Install

npm install term-img

Usage

import terminalImage from 'term-img';

function fallback() {
	// Return something else when not supported
}

console.log(terminalImage('unicorn.jpg', {fallback}));

API

terminalImage(image, options?)

Get the image as a string that you can log manually.

image

Type: string | Uint8Array

File path to an image or an image as a buffer.

options

Type: object

width

height

Type: 'auto' | string | number

The width and height are given as a number followed by a unit, or the word 'auto'.

N: N character cells.
Npx: N pixels.
N%: N percent of the session's width or height.
auto: The image's inherent size will be used to determine an appropriate dimension.

preserveAspectRatio

Type: boolean
Default: true

fallback

Type: Function
Default: () => throw new UnsupportedTerminalError()

Enables you to do something else when the terminal doesn't support images.

term-img-cli - CLI for this module
term-kitty-img - Similar package but for Kitty, Konsole, WezTerm

term-img's People

Contributors

Stargazers

Watchers

Forkers

egoist-bot manansaini jefftougas djmadeira richienb brunoss8 commonjs-bot kkpan11

term-img's Issues

Support kitty cli graphics protocol

Protocol definition: https://sw.kovidgoyal.net/kitty/graphics-protocol.html
Reference code: https://github.com/kovidgoyal/kitty/blob/main/kittens/icat/main.py

Some reading that someone with more : weechat/weechat#1430

According to the protocol document, xterm also supports this graphics protocol, although, i haven't tested it.

Update vulnerable iterm2-version dependency

The iterm2-version version 2.0.1 package depends on plist version 2.0.1 which is vulnerable to the following security issue TooTallNate/plist.js#89.

Could you update iterm2-version to the last version to avoid this issue ?

Thanks in advance !

Yann

Support tmux

It requires some wrapper escape codes to please it.

https://raw.githubusercontent.com/gnachman/iTerm2/master/tests/imgcat

Specifically:

# tmux requires unrecognized OSC sequences to be wrapped with DCS tmux;
# <sequence> ST, and for all ESCs in <sequence> to be replaced with ESC ESC. It
# only accepts ESC backslash for ST.
function print_osc() {
    if [[ $TERM == screen* ]] ; then
        printf "\033Ptmux;\033\033]"
    else
        printf "\033]"
    fi
}

# More of the tmux workaround described above.
function print_st() {
    if [[ $TERM == screen* ]] ; then
        printf "\a\033\\"
    else
        printf "\a"
    fi
}

I will get to this eventually, but I don't use tmux, so not a priority. A pull request would be welcomed :)

CHANGELOG missing

I just saw the package is updated from v2.1.0 to v3.0.0 which implies breaking changes, but I can't find any CHANGELOG to check them all out.

Would you be so kind to provide us with a decent CHANGELOG please? 🙂

Thanks for all your great work @sindresorhus! 🙂

Use `termImg.string` as the default function

For parity with https://github.com/sindresorhus/terminal-image, term-img, should only return the image as a string to be manually logged.

cc @sindresorhus

Return fallback in `string` method

When using the string method, you probably want to return whatever the fallback returns to avoid having to assigning another variable if the fallback returns a string. See https://github.com/kevva/ink-image/blob/master/index.js#L11-L19 for an example.

Deprecation warning when installing term-img in a clean project

After installing term-img in a clean project, I get the following deprecation warning:

npm WARN deprecated [email protected]: cross-spawn no longer requires a build toolchain, use it instead

This warning is coming from [email protected]'s dependency app-path dependency.

I've added a similar issue upstream, which is already fixed.

Can the iterm2-version dependency be updated please?