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://usetrmnl.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.usetrmnl.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

BYOS Laravel - 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

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

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.usetrmnl.com

Alternative Screens and Clients

Nook - 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 e-ink device firmware

    C++ 755 136

  2. plugins plugins Public

    e-ink dashboard plugin logic

    HTML 178 51

  3. byos_hanami byos_hanami Public

    The flagship TRMNL BYOS application.

    Ruby 284 60

  4. mounts mounts Public

    3D printable accessories to mount your device

    97 2

  5. trmnl-i18n trmnl-i18n Public

    web app translations

    Ruby 20 57

  6. byos_laravel byos_laravel Public

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

    PHP 151 35

Repositories

Showing 10 of 38 repositories
  • byos_hanami Public

    The flagship TRMNL BYOS application.

    usetrmnl/byos_hanami’s past year of commit activity
    Ruby 284 MIT 60 4 0 Updated Dec 24, 2025
  • byos_laravel Public

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

    usetrmnl/byos_laravel’s past year of commit activity
    PHP 151 MIT 35 10 0 Updated Dec 23, 2025
  • trmnl-form-builder Public

    A JS component for building custom plugin form fields.

    usetrmnl/trmnl-form-builder’s past year of commit activity
    JavaScript 1 MIT 0 0 0 Updated Dec 22, 2025
  • trmnl-firmware Public

    TRMNL e-ink device firmware

    usetrmnl/trmnl-firmware’s past year of commit activity
    C++ 755 GPL-3.0 136 28 5 Updated Dec 19, 2025
  • trmnl-picker Public
    usetrmnl/trmnl-picker’s past year of commit activity
    HTML 0 MIT 0 0 0 Updated Dec 19, 2025
  • trmnl-i18n Public

    web app translations

    usetrmnl/trmnl-i18n’s past year of commit activity
    Ruby 20 MIT 57 5 0 Updated Dec 18, 2025
  • trmnl-api Public

    A monadic TRMNL API client.

    usetrmnl/trmnl-api’s past year of commit activity
    Ruby 4 MIT 1 0 0 Updated Dec 17, 2025
  • plugins Public

    e-ink dashboard plugin logic

    usetrmnl/plugins’s past year of commit activity
    HTML 178 51 12 (1 issue needs help) 0 Updated Dec 17, 2025
  • trmnl-display Public

    Embedded e-ink friendly Linux client for displaying TRMNL screens

    usetrmnl/trmnl-display’s past year of commit activity
    Go 91 MIT 10 2 0 Updated Dec 16, 2025
  • byos_fastapi Public
    usetrmnl/byos_fastapi’s past year of commit activity
    Python 5 0 0 0 Updated Dec 16, 2025
View all repositories

Sponsoring

  • @bitbank2
GitHub Sponsor