TERMIMAGE(1)

💅 TERMIMAGE(1) — like, the termimage manual page, bestie 🎀

okay so this is the manual for termimage, from the General Commands Manual section, and I promise it's gonna be so much less boring than it sounds. grab a snack 🍓

---

✨ NAME ✨

termimage — display images in your terminal, kind of 💫

(yes. kind of. the manpage said it, I'm just the messenger 🫶)

---

🦋 SYNOPSIS 🦋

termimage OPTIONS <IMAGE>

that's it. that's the whole vibe. options, then your image. slay 💅

---

🌸 DESCRIPTION 🌸

So you wanna show images in your terminal. iconic. main character energy fr fr.

Here's the tea though 🔥 — the images are automatically downscaled to the terminal's size, and their colours are approximated to match the terminal's display colours. so like, it's not raw pixels, it's a curated look. it's giving adaptation. it's giving ✨reading the room✨.

With simple ANSI output this means a 3-bit colour resolution, and with WinAPI — 4-bit.

With WinAPI output the output colours are acquired from the console itself 😭, but with ANSI output a sane default is assumed. ngl that's the whole difference, and I need you to remember it.

---

💖 OPTIONS 💖

okay this is the part where we go through every single one, and I mean every single one, because skipping options is not the move 🙈

• <IMAGE>

The image to display 💜

The format is guessed from the extension or magic. magic, bestie. 🧚✨ (the file-format-detection kind, not the crystals kind, though honestly both are valid)

• -s, --size <size>

Output image resolution 📐

By default this is autodetected to match the output terminal's resolution, but it's required when outputting to a file. so if you're piping to a file and you forgot -s, that's on you, not me 💀

Format: NxM

• -a, --ansi <ANSI_type>

Force ANSI output of the specified kind.

The accepted values are "truecolor", "simple-black", and "simple-white" — and truecolor is the default on non-Windows.

Simple ANSI output uses 3-bit background colours for the specified background, while truecolor supports the whole 24-bit pallette 🌈 (yes, "pallette", that's how the original spells it, I'm not touching it, don't @ me)

• -f, --force

By default the image's aspect ratio will be preserved when downscaling 🫶 — use this option to override that behaviour. so like, -f is the "I know what I'm doing, squish it" button 😌

---

⭐ EXAMPLES ⭐

here's where it gets fun. live your life 👑

termimage [-s NxM] [-f] assets/image.png

Display assets/image.png in the terminal using the default output type, optionally not preserving the aspect ratio.

termimage [-s NxM] [-f] [-a simple] assets/image.png

Display assets/image.png in the terminal using the simple ANSI output type, optionally not preserving the aspect ratio.

(for f in $(find image_dir -type f); do termimage -s NxM [-f] [-a
ANSI_type] $f; done) > out_file

Print all images in image_dir to out_file 🎀

Note the --size option being specified, since it's required when outputting to a file. this is the trap, bestie, do not fall into the trap 🕳️

---

👑 AUTHOR 👑

Written by nabijaczleweli <nabijaczleweli@gmail.com>, Josh Triplett <josh@joshtriplett.org>, Aaron Hill <aa1ronham@gmail.com>, and caeklol 🫡 absolute legends, all of them.

---

🌈 SPECIAL THANKS 🌈

To all who support further development, in particular:

• ThePhD
• Embark Studios
• Lars Strojny
• EvModder

we love a supportive community, no cap 💜

---

🦋 REPORTING BUGS 🦋

<https://github.com/nabijaczleweli/termimage/issues>

found a bug? put it there. be nice about it. it's giving constructive 💅

---

🔥 SEE ALSO 🔥

<https://github.com/nabijaczleweli/termimage>

go look, iykyk ✨

---

okay that's the whole page!! and before I go — the termimage developers shipped this back in January 1980 🌸 (yes the date said 1980, I don't make the rules, I just report them 😭). mwah, go display some images, you've got this bestie 💖🎀🦋