Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathaneltitane/pixtrm
Display images in terminal using base64-encoded inline image display protocol
https://github.com/nathaneltitane/pixtrm
base64 bash curl linux metadata posix rice scripting termux
Last synced: about 5 hours ago
JSON representation
Display images in terminal using base64-encoded inline image display protocol
- Host: GitHub
- URL: https://github.com/nathaneltitane/pixtrm
- Owner: nathaneltitane
- Created: 2025-01-18T03:44:29.000Z (1 day ago)
- Default Branch: main
- Last Pushed: 2025-01-18T04:11:51.000Z (1 day ago)
- Last Synced: 2025-01-18T04:33:42.550Z (1 day ago)
- Topics: base64, bash, curl, linux, metadata, posix, rice, scripting, termux
- Language: Shell
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://www.paypal.com/donate?hosted_button_id=ZW3CDCANHJCWJ)
[[ PixTrm // Project Page ]](https://github.com/nathaneltitane/pixtrm) [ Version // 01-18-2025 ]
---
### NOTICE
01-18-2025 ↴
- Initial release
---
### Welcome to PixTrm
Display images in terminal using base64-encoded inline image display protocol!
This script enables displaying images directly in the terminal using a base64-encoded inline image display protocol.
It provides various options for resizing, stretching, and parsing image files, whether local or remote. Users can adjust the dimensions of the displayed image and specify the input type, ensuring flexibility and ease of use.
---
### Usage:
bash pixtrm -i | -n | -h [Height] -w [Width] | -s | -f [File] | -u | -t [File Type] | [-b]
---
Options
-i, --inline
Display the image inline in the terminal.
-n, --name
Display the filename after parsing the image.
-h, --height [Height]
Set the image height in terminal character cells.
-w, --width [Width]
Set the image width in terminal character cells.
-s, --stretch
Stretch the image to the specified width and height.
-f, --file
Treat following arguments as local file paths.
-u, --url
Treat following arguments as remote URLs.
-t, --type [File Type]
Provide a type hint to assist with parsing or processing, especially for piped input.
-b, --block
Use the standard protocol to transfer the image as a single monolithic block or control sequence.
-h, --help
Show help and usage information.
---
### Usage Examples:
Display a local image with specific dimensions:
```
bash pixtrm -w 250px -h 250px -s image.png
```
Display an image from a pipe with percentage-based width:
```
cat image-01.png | bash pixtrm -w 75%
```
Display an image with percentage-based height:
```
cat image-02.jpg | bash pixtrm -h 30%
```
Parse and display a remote URL and a local file:
```
bash pixtrm -n -w 500px -u http://host.url/path/to/image.gif -w 80 -f image.png
```
Display images from a list of URLs:
```
cat url-list[.txt] | xargs bash pixtrm -n -w 40 -u
```
Display a JSON configuration file:
```
bash pixtrm -t application/json config.json
```
---
### Image Sizing:
If width or height are not specified, the script will automatically determine appropriate values:
Numeric (n): Specifies the number of terminal character cells.
Pixels (npx): Specifies the size in pixels.
Percentage (n%): Specifies a percentage of the terminal session's width or height.
Automatic (auto): Automatically calculates dimensions based on the image size.
---
### File Type:
The file type can be:
A MIME type (e.g., text/markdown).
A language name (e.g., Java).
A file extension (e.g., .sh).
When the filename is unavailable (e.g., piped input), the --type option helps to disambiguate the file's type. Generally, the script infers file type from the extension or content.
---
### Notes:
Ensure your terminal supports inline image display protocols.
Use appropriate dimension formats for better control over the display.
### Other Projects:
[](https://github.com/nathaneltitane/dextop)
[](https://github.com/nathaneltitane/frobulator)
[](https://github.com/nathaneltitane/l2cu)
[](https://github.com/nathaneltitane/terminal)
[](https://github.com/nathaneltitane/legolinux)
[](https://github.com/nathaneltitane/nathaneltitane)
[](https://github.com/nathaneltitane/pewpewprints)
---
[[ PixTrm // Project Page ]](https://github.com/nathaneltitane/pixtrm) [ Version // 01-18-2025 ]
### Enjoying Dextop? Buy me a coffee to show your appreciation!
[](https://www.paypal.com/donate?hosted_button_id=ZW3CDCANHJCWJ)