https://github.com/sindresorhus/term-img-cli

Display images in iTerm
https://github.com/sindresorhus/term-img-cli

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

Last synced: 12 days ago
JSON representation

Display images in iTerm

• Host: GitHub
• URL: https://github.com/sindresorhus/term-img-cli
• Owner: sindresorhus
• License: mit
• Created: 2016-03-09T15:32:48.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-07-26T12:50:42.000Z (6 months ago)
• Last Synced: 2025-01-12T00:23:49.810Z (20 days ago)
• Topics: cli-app, image, iterm2, nodejs, npm-package, terminal-image
• Language: JavaScript
• Homepage:
• Size: 479 KB
• Stars: 82
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# term-img-cli

> Display images in iTerm

![](screenshot.jpg)

*Currently only supported on [iTerm >=3](https://www.iterm2.com/downloads.html).*

## Install

```sh

npm install --global term-img-cli

```

## Usage

```

$ term-img --help

  Usage

    $ term-img 

    $ cat  | term-img

  Options

    --width   Width to render  [N|Npx|N%]

    --height  Height to render  [N|Npx|N%]

  Examples

    $ term-img unicorn.jpg --width=200px

    $ cat unicorn.jpg | term-img --height=50%

```

## Related

- [term-img](https://github.com/sindresorhus/term-img) - API for this package

- [terminal-image-cli](https://github.com/sindresorhus/terminal-image-cli) - Like this module but works in any terminal