When attempting to import into a Typescript project.

import fs, {promises as fsPromises} from 'node:fs';
^^^^^^

SyntaxError: Cannot use import statement outside a module
    at Module._compile (internal/modules/cjs/loader.js:895:18)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:995:10)
    at Module.load (internal/modules/cjs/loader.js:815:32)
    at Function.Module._load (internal/modules/cjs/loader.js:727:14)
    at Module.require (internal/modules/cjs/loader.js:852:19)
    at require (internal/modules/cjs/helpers.js:74:18)

Should be easy to support this through an options object, but I didn't want to do it before anyone had a need for it. PR welcome if so.

Both term-img and jimp accept as first parameter both a buffer of a filepath, so usage of readFIle() is superfluous and also add some limits...

Will the ability to rotate or resize the image through the option be added?

For higher quality images you might want to add optional SIXEL output (supported by several terminals).

jimp-dev/jimp#166

or maybe with LinusU/cwasm-nsgif#1

Hi! I was wondering if there's a CommonJS version of this module for use in NodeJS?
All my other modules are in CommonJS and if I set "type": "module" in my package.json it will break all the rest.

Thank you.

When I run with ts-node I have next error

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /node_modules/terminal-image/index.js
require() of ES modules is not supported.
require() of /node_modules/terminal-image/index.js from /src/cli/commands/new/newCommand.ts is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /node_modules/terminal-image/package.json.

    at new NodeError (node:internal/errors:363:5)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1112:13)
    at Module.load (node:internal/modules/cjs/loader:975:32)
    at Function.Module._load (node:internal/modules/cjs/loader:816:12)
    at Module.require (node:internal/modules/cjs/loader:999:19)
    at require (node:internal/modules/cjs/helpers:93:18)
    at Object.<anonymous> (/src/cli/commands/new/newCommand.ts:10:1)
    at Module._compile (node:internal/modules/cjs/loader:1095:14)
    at Module.m._compile (/ts-node/src/index.ts:1295:23)
    at Module._extensions..js (node:internal/modules/cjs/loader:1124:10)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

const terminalImage = require('terminal-image');
const axios = require('axios');

const run = async () => {
    let image = null;
    try {
        image = await axios.get('https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png');
        console.log(image.data);
    } catch (err) {
        console.log(err.message);
    }
    
    if (image.data) {
        console.log(await terminalImage.buffer(image.data));
    }
}

run();

I would like to know what I am doing wrong.

When loading an image over HTTP, is there a way to send a custom header (like Authorization: Bearer eyJXXXXX...)?

Doing a quick test to see if I can use this with https://github.com/Automattic/cli-table ...

const terminalImage = require('terminal-image');
const Table = require('cli-table');

(async () => {
	const img = await terminalImage.file(process.argv[2], {width: 50, height: 50});

	const table = new Table({head: ['img', 'caption']});
	table.push([img, 'description #1'], [img, 'description #2']);
	console.log(table.toString());
})();

It works nicely in macOS native terminal:

But in iTerm 2 I'm getting a screen full of lines, like the table thinks the output is (much) larger than it is. Customizing row widths in cli-table doesn't seem to help. Any idea if this is something I could reasonably expect to work, or just incompatible with whatever special image rendering iTerm 2 has? Maybe related to #29? Thanks!

When trying to install this package with npm, it stops at
$ npm install --save terminal-image ⸨ ░░░░░░░░░░░░░░░░░⸩ ⠦ fetchMetadata: sill resolveWithNewModule [email protected] checking installable status and does not proceed.

Ranger file manager (linux) can show images preview (via w3m as far as I know) a lot way better than terminal-image. Is that possible to get such quality? Ranger shows in terminal exactly the source quality of an image.

Not sure why, but I get this error when I try to import the library:

internal/process/esm_loader.js:74
    internalBinding('errors').triggerUncaughtException(
                              ^

Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only file and data URLs are supported by the default ESM loader. Received protocol 'node:'
    at Loader.defaultResolve [as _resolve] (internal/modules/esm/resolve.js:750:11)
    at Loader.resolve (internal/modules/esm/loader.js:85:40)
    at Loader.getModuleJob (internal/modules/esm/loader.js:229:28)
    at ModuleWrap.<anonymous> (internal/modules/esm/module_job.js:51:40)
    at link (internal/modules/esm/module_job.js:50:36) {
  code: 'ERR_UNSUPPORTED_ESM_URL_SCHEME'
}```

How hard would it be to support rendering raw ArrayBuffer pixel data like how CanvasRenderingContext2D works in browsers? I'd also love to help with this support if I can get pointed in the right direction! :)

Are you interested to switch from Chalk to Colorette to reduce the bundle size?

https://bundlephobia.com/[email protected]

https://bundlephobia.com/[email protected]

How can I perform some task only after image gets rendered?

I find the fallback to have enough entity to work standalone. What about moving it to it's own module and use it as dependency of this one? It would also allow to make it without behaviour constrains to be the same as term-img, doing that constrains in this module instead...

Would be nice to have #7 finished, but the PR submitter is not responding.

Looking for someone to finish that PR and address the PR feedback. Preserve the existing commits and just add new ones in a new PR>

Don't see a reason why this isn't implemented

it would be useful to have an option to stop gif playback early. for example i want to stop the playback when the user types "q"

First of all thank you for your package and your work.

I use this package in a tool of mine, and for some user (few) it appears as follows. Any ideas?

I am following the docs and trying to show an image from a url online, but I must be missing something as it is not displaying. Code is below, can you see what I can do differently to fetch and display the image?

const terminalImage = require('terminal-image');
const got = require('got');

(async () => {
	const {body} = await got('https://vignette.wikia.nocookie.net/prowrestling/images/c/c5/Bret-Hart.jpg', {encoding: null});
	console.log(await terminalImage.buffer(body));
})();

Cannot install I'm getting an error by npm-

npm WARN deprecated [email protected]: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note
that the API surface has changed to use Promises in 1.x.)
npm ERR! code ENOENT
npm ERR! syscall spawn git
npm ERR! path git
npm ERR! errno -4058
npm ERR! enoent Error while executing:
npm ERR! enoent undefined ls-remote -h -t ssh://[email protected]/notmasteryet/jpgjs.git
npm ERR! enoent
npm ERR! enoent
npm ERR! enoent spawn git ENOENT
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:

Whenever I try to make it render a black and white image, it just prints a bunch of white, Any fix?
My entire code is literally just this:
const terminalImage = require('terminal-image'); (async () => { console.log(await terminalImage.file(frames/out20.png)); })();

The lib doesn't work with node out of the box. To require with commonjs we have to do some wizardry like this:

(async () => {
    const terminalImage = (await import("terminal-image")).default;
    console.log(await terminalImage.file('pikachu.png'));
})();

While requiring a commonjs lib on a ESM file is quite simple:

import someCommonJsLib from "some-commonjs-lib";

Consider reverting back to common js.

Anyway, thanks for the wonderfull library.