Open source · TRMNL plugin tooling
TRMNL Plugin Preview
A local preview server for TRMNL plugin developers. Point it at your markup endpoint and it renders every layout variant, on both device models, right in your browser — so you see exactly how a plugin looks before deploying to a device.
No install, no build step. The workspace opens at 127.0.0.1:4568.
What it is
Local server
One command opens a browser workspace that renders your plugin markup live.
Coverage
All 4 layouts
Full, half-horizontal, half-vertical, and quadrant — for TRMNL OG and TRMNL X.
Trust
Stays local
Endpoint, token, and data never leave your machine. Open source under MIT.
The whole point
Every layout, rendered at once.
TRMNL renders plugins into four fixed layouts across two device models. Checking a change normally means pushing it and waiting on a device. This server collapses that loop — fetch, validate, and draw every variant side by side, the way TRMNL would.
Each variant also rendered for TRMNL OG and TRMNL X — in live HTML and pixel-accurate PNG.
How it works
From endpoint to preview in one step.
01
Point it at your endpoint
Pass your plugin markup URL over the CLI, or paste it into the web interface once running.
02
Run one command
npx trmnl-plugin-preview starts the server with no install and no build step to babysit.
03
See every variant at once
The workspace validates the response and renders each layout for both device models.
04
Iterate, then ship
Tweak markup, refresh, compare HTML and PNG — before it ever reaches a device.
What you get
A focused developer tool.
- Renders full, half-horizontal, half-vertical, and quadrant layouts together
- Supports both TRMNL OG and TRMNL X device models
- Live HTML preview plus pixel-accurate PNG rendering via Playwright
- Endpoint diagnostics that flag validation and response issues
- Ships with a zero-dependency example plugin to start from
- Configurable over CLI flags or the built-in web interface
At a glance
- Type
- CLI + preview server
- Stack
- Node · TS · Playwright
- License
- MIT
- Serves
- 127.0.0.1:4568