Skip to content
@usetrmnl

TRMNL

Dedicated e-ink screen for the content you care about.
README.md

Clarity, at a glance

TRMNL is an e-ink display that connects with popular products and renders their most useful information. We believe this black & white, focused, hands-off approach is the best way to stay informed without getting distracted.

Our proprietary device is available for purchase at https://trmnl.com, however we also provide guides to build your own device, install and mod our open source firmware, and even point your own device (or ours) at your own web server for end-to-end privacy.

See the other repositories in this GitHub organization and our API docs (https://docs.trmnl.com) to get started.

Hardware

Firmware - the PlatformIO project to drive e-ink displays with ESP32

Mounts - clever 3D-printable mounting solutions, submitted by users

Bring Your Own Server (BYOS)

Terminus - our flagship self-hosted server in Ruby's Hanami framework

LaraPaper - a self-hosted server in PHP's Laravel framework

BYOS Node Lite - a lightweight self-hosted server in Node.js

BYOS Next.js - a self-hosted server in Next.js

Inker - a self-hosted server in TypeScript and React

BYOS FastAPI - a self-hosted server in Python's FastAPI framework

BYOS Django - a self-hosted server in Python's Django framework

BYOS Phoenix - a self-hosted server in Elixir's Phoenix framework

Plugin Development

Plugins - a collection of community plugins

TRMNLP - a local dev server for rapidly iterating on plugins

TRMNL::I18n - translations for the web app and custom plugins

TRMNL::Liquid - Liquid filters and tags for advanced plugin markup

TRMNL::FormBuilder - a WYSIWYG component for plugin form fields

TRMNL::Picker - JavaScript library for managing device models and palettes

TRMNL::PluginLicense - TOS for community plugin development

Miscellaneous

Mockups - high fidelity render templates to share your work

TRMNL::API - a Ruby gem for interacting with the TRMNL API

TRMNL Companion - iOS application to sync any calendar natively

Docs - the GitBook documentation at docs.trmnl.com

Alternative Screens and Clients

Nook - repurpose an old e-reader

Nook Simple Touch - repurpose an old e-reader

Kobo - repurpose an old e-reader

Amazon Kindle - repurpose an old e-reader

Android - use a tablet or phone

KOReader - repurpose dozens of e-ink devices

iPad - put your dusty old tablet to use

Raspberry Pi - output directly to HDMI or e-ink

Mozilla Firefox - see TRMNL content in new tabs

Google Chrome - see TRMNL content in new tabs

Pinned Loading

  1. trmnl-firmware trmnl-firmware Public

    TRMNL ePaper device firmware

    C++ 992 181

  2. plugins plugins Public

    e-ink dashboard plugin logic

    HTML 211 53

  3. terminus terminus Public

    The flagship TRMNL BYOS application.

    Ruby 505 90

  4. mounts mounts Public

    3D printable accessories to mount your device

    120 3

  5. trmnl-i18n trmnl-i18n Public

    Localizations for the TRMNL web application, plugins, and Recipes.

    Ruby 22 62

  6. larapaper larapaper Public

    A self-hosted, community-driven server (BYOS) with Recipe support in PHP's Laravel framework

    PHP 288 64

Repositories

Showing 10 of 47 repositories
  • terminus Public

    The flagship TRMNL BYOS application.

    usetrmnl/terminus’s past year of commit activity
    Ruby 505 MIT 90 4 1 Updated Apr 12, 2026
  • larapaper Public

    A self-hosted, community-driven server (BYOS) with Recipe support in PHP's Laravel framework

    usetrmnl/larapaper’s past year of commit activity
    PHP 288 MIT 64 16 0 Updated Apr 12, 2026
  • inker Public

    BYOS server written in TypeScript / React / Prisma

    usetrmnl/inker’s past year of commit activity
    TypeScript 53 6 3 0 Updated Apr 12, 2026
  • trmnl-nook-simple-touch Public

    TRMNL Client for Nook Simple Touch

    usetrmnl/trmnl-nook-simple-touch’s past year of commit activity
    Java 11 MIT 3 6 2 Updated Apr 11, 2026
  • trmnl-firmware Public

    TRMNL ePaper device firmware

    usetrmnl/trmnl-firmware’s past year of commit activity
    C++ 992 GPL-3.0 181 36 12 Updated Apr 10, 2026
  • trmnl-liquid Public

    Liquid templating engine for TRMNL plugins.

    usetrmnl/trmnl-liquid’s past year of commit activity
    Ruby 13 MIT 4 0 1 Updated Apr 8, 2026
  • trmnl-koreader Public

    Turn KOReader into a TRMNL display for Kindle and other devices.

    usetrmnl/trmnl-koreader’s past year of commit activity
    Lua 75 MIT 5 9 1 Updated Apr 7, 2026
  • trmnl-i18n Public

    Localizations for the TRMNL web application, plugins, and Recipes.

    usetrmnl/trmnl-i18n’s past year of commit activity
    Ruby 22 MIT 62 4 1 Updated Apr 7, 2026
  • plugins Public

    e-ink dashboard plugin logic

    usetrmnl/plugins’s past year of commit activity
    HTML 211 53 14 (1 issue needs help) 0 Updated Apr 6, 2026
  • trmnl-home-assistant Public

    Add-ons and plugins for Home Assistant designed for TRMNL e-ink displays.

    usetrmnl/trmnl-home-assistant’s past year of commit activity
    TypeScript 121 8 11 0 Updated Apr 4, 2026
View all repositories

Sponsoring

  • @bitbank2

Top languages

Loading…

Most used topics

Loading…
GitHub Sponsor