{"id":24366970,"url":"https://github.com/nathaneltitane/pixtrm","last_synced_at":"2026-04-13T10:32:33.536Z","repository":{"id":273019424,"uuid":"918484416","full_name":"nathaneltitane/pixtrm","owner":"nathaneltitane","description":"Display images in terminal using base64-encoded inline image display protocol","archived":false,"fork":false,"pushed_at":"2025-11-09T20:16:33.000Z","size":32,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-26T21:53:01.327Z","etag":null,"topics":["base64","bash","curl","linux","metadata","posix","rice","scripting","termux"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nathaneltitane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-18T03:44:29.000Z","updated_at":"2025-11-09T20:16:36.000Z","dependencies_parsed_at":"2025-01-18T04:33:44.951Z","dependency_job_id":"ab2d7309-d082-4ab6-8d76-6b30870a8a79","html_url":"https://github.com/nathaneltitane/pixtrm","commit_stats":null,"previous_names":["nathaneltitane/pixtrm"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nathaneltitane/pixtrm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathaneltitane%2Fpixtrm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathaneltitane%2Fpixtrm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathaneltitane%2Fpixtrm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathaneltitane%2Fpixtrm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nathaneltitane","download_url":"https://codeload.github.com/nathaneltitane/pixtrm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathaneltitane%2Fpixtrm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31749083,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["base64","bash","curl","linux","metadata","posix","rice","scripting","termux"],"created_at":"2025-01-19T01:10:53.708Z","updated_at":"2026-04-13T10:32:33.505Z","avatar_url":"https://github.com/nathaneltitane.png","language":"Shell","funding_links":["https://www.paypal.com/donate?hosted_button_id=ZW3CDCANHJCWJ"],"categories":[],"sub_categories":[],"readme":"![pixtrm](https://raw.githubusercontent.com/nathaneltitane/pixtrm/main/pixtrm.svg)\n\n[![Donate](https://img.shields.io/badge/Paypal-2f343f.svg?style=for-the-badge\u0026logo=paypal\u0026label=Donate)](https://www.paypal.com/donate?hosted_button_id=ZW3CDCANHJCWJ)\n\n[[ PixTrm // Project Page ]](https://github.com/nathaneltitane/pixtrm) [ Version // 11-07-2025 ]\n\n---\n\n### NOTICE\n\n01-18-2025 ↴\n\n- Initial release\n\n---\n\n### Welcome to PixTrm\n\nPixTrm is a Bash terminal utility that lets you display images directly in your terminal, using a base64-encoded inline image protocol.\n\nIt provides various options for parsing image files, whether local or remote:\n\nUsers can adjust the dimensions of the displayed image and specify the input type, ensuring flexibility and ease of use.\n\n### TL;DR\n\nThe script automatically installs and manages what it needs:\n\n- curl\n- frobulator (auto-downloaded to ~/.local/bin/frobulator if missing)\n\nClone the repository ↴\n\n```\ngit clone https://github.com/nathaneltitane/pixtrm.git\n```\n\nMove into the directory ↴\n\n```\ncd pixtrm\n```\n\nMake it executable ↴\n\n```\nchmod +x pixtrm\n```\n\nRun it ↴\n\n```\nbash pixtrm -w 250px -h 250px image.png\n```\n\nOr install globally ↴\n\n```\nsudo install -m 755 pixtrm /usr/local/bin/pixtrm\n```\n\nExample ↴\n\n```\nbash pixtrm -s -w 75% -h auto image.jpg\ncat photo.png | pixtrm -w 50%\n```\n\n---\n\n### Features\n\n- Display images inline in terminal using base64-encoded OSC protocol\n- Support for local files, URLs, and stdin pipelines\n- Adjustable width and height in characters, pixels, or percentages\n- Stretch or preserve aspect ratio control\n- Optional filename display after render\n- MIME-type and format hinting ('-t' / '--type') for disambiguation\n- Compatible with tmux and screen multiplexers\n- Uses [frobulator](https://github.com/nathaneltitane/frobulator) for logging, progress, and error handling\n\n---\n\n### Usage\n\n```\npixtrm [File] -i | -n | -h [Height] -w [Width] | -s | -t [File Type] | [-b]\n```\n\n### Options\n\n| Flag     | Long Option     | Description                                           |\n| -------- | --------------- | ----------------------------------------------------- |\n| `-i`     | `--inline`      | Display image inline (default)                        |\n| `-n`     | `--name`        | Display filename after image render                   |\n| `-x`     | `--width [n]`   | Set image width (in character cells, px, %, or auto)  |\n| `-y`     | `--height [n]`  | Set image height (in character cells, px, %, or auto) |\n| `-s`     | `--stretch`     | Stretch image to specified width and height           |\n| `-t`     | `--type [Type]` | Provide type hint (application/json, .sh, Python)     |\n| `-b`     | `--block`       | Send image as single block (monolithic transfer)      |\n| `-h`     | `--help`        | Show help and usage information                       |\n\nExamples:\n\nDisplay a local image with specific dimensions ↴\n\n```\npixtrm -w 250px -h 250px -s image.png\n```\n\nDisplay an image from stdin ↴\n\n```\ncat image.png | pixtrm -w 75%\n```\n\nDisplay an image from a remote URL ↴\n\n```\npixtrm -n -w 500px https://example.com/photo.jpg\n```\n\nDisplay images from a URL list ↴\n\n```\ncat url-list.txt | xargs pixtrm -n -w 40\n```\n\nDisplay a JSON configuration file ↴\n\n```\npixtrm -t application/json config.json\n```\n\n---\n\n### Image Sizing\n\nIf width or height are not specified, PixTrm automatically determines appropriate values.\n\n| Unit   | Meaning                                        |\n| ------ | ---------------------------------------------- |\n| `n`    | Character cells                                |\n| `npx`  | Pixel value                                    |\n| `n%`   | Percentage of terminal dimension               |\n| `auto` | Automatically scale to image’s intrinsic ratio |\n\n---\n\n### File Type Hints\n\nFile type hints ('--type' argument) improve handling of files or streams where the extension is unavailable.\n\nExamples ↴\n\n| Input              | Type Hint Example |\n| ------------------ | ----------------- |\n| JSON configuration | application/json  |\n| Script             | .sh               |\n| Markdown           | text/markdown     |\n| Language           | Python            |\n\n---\n\n### Protocol\n\nPixTrm implements the OSC 1337 inline image protocol:\n\n- Detects tmux or screen multiplexer and adapts control sequences.\n- Uses monolithic (--block) or multipart (200-byte) encoded chunks for reliability.\n- Encodes data via base64 before inline transmission.\n\n---\n\n### Notes\n\n- Requires a terminal that supports inline image protocols (e.g., iTerm2, Kitty, WezTerm).\n- Ideal for displaying previews, diagrams, or assets directly within the CLI.\n- Fully portable and compatible with Debian-based and Termux environments.\n\n---\n\n### Other Projects:\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/dextop?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=DEXTOP)](https://github.com/nathaneltitane/dextop)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/frobulator?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=FROBULATOR)](https://github.com/nathaneltitane/frobulator)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/l2cu?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=L²CU)](https://github.com/nathaneltitane/l2cu)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/terminal?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=TERMINAL)](https://github.com/nathaneltitane/terminal)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/legolinux?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=LEGO//LINUX)](https://github.com/nathaneltitane/legolinux)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/nathaneltitane?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=NATHANEL+TITANE)](https://github.com/nathaneltitane/nathaneltitane)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/nathaneltitane/pewpewprints?style=for-the-badge\u0026logo=gnubash\u0026logoColor=ffffff\u0026label=PEWPEWPRINTS)](https://github.com/nathaneltitane/pewpewprints)\n\n---\n\n[[ PixTrm // Project Page ]](https://github.com/nathaneltitane/pixtrm) [ Version // 11-07-2025 ]\n\n### Enjoying Dextop? Buy me a coffee to show your appreciation!\n\n[![Donate](https://img.shields.io/badge/Paypal-2f343f.svg?style=for-the-badge\u0026logo=paypal\u0026label=Donate)](https://www.paypal.com/donate?hosted_button_id=ZW3CDCANHJCWJ)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathaneltitane%2Fpixtrm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnathaneltitane%2Fpixtrm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathaneltitane%2Fpixtrm/lists"}