Skip to content
@usetrmnl

TRMNL

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

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

Miscellaneous

Mockups - high fidelity render templates to share your work

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

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

iPad - put your dusty old tablet to use

Raspberry Pi - output TRMNL screens directly to HDMI

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++ 632 106

  2. plugins plugins Public

    e-ink dashboard plugin logic

    HTML 161 44

  3. byos_hanami byos_hanami Public

    A TRMNL BYOS application.

    Ruby 172 32

  4. mounts mounts Public

    3D printable accessories to mount your device

    77 2

  5. trmnl-i18n trmnl-i18n Public

    web app translations

    Ruby 17 46

  6. byos_laravel byos_laravel Public

    DIY server in PHP/Laravel for self hosted screen generation.

    PHP 98 24

Repositories

Showing 10 of 32 repositories
  • trmnl-i18n Public

    web app translations

    usetrmnl/trmnl-i18n’s past year of commit activity
    Ruby 17 MIT 46 2 0 Updated Aug 31, 2025
  • trmnl-firmware Public

    TRMNL e-ink device firmware

    usetrmnl/trmnl-firmware’s past year of commit activity
    C++ 632 GPL-3.0 106 35 9 Updated Aug 31, 2025
  • byos_hanami Public

    A TRMNL BYOS application.

    usetrmnl/byos_hanami’s past year of commit activity
    Ruby 172 MIT 32 3 0 Updated Aug 31, 2025
  • api-docs Public

    powers docs.usetrmnl.com

    usetrmnl/api-docs’s past year of commit activity
    3 4 0 0 Updated Aug 30, 2025
  • .github Public
    usetrmnl/.github’s past year of commit activity
    0 0 0 0 Updated Aug 29, 2025
  • byos_laravel Public

    DIY server in PHP/Laravel for self hosted screen generation.

    usetrmnl/byos_laravel’s past year of commit activity
    PHP 98 MIT 24 2 0 Updated Aug 28, 2025
  • plugins Public

    e-ink dashboard plugin logic

    usetrmnl/plugins’s past year of commit activity
    HTML 161 44 12 (1 issue needs help) 0 Updated Aug 28, 2025
  • trmnlp Public

    a local dev server for building TRMNL plugins

    usetrmnl/trmnlp’s past year of commit activity
    JavaScript 121 MIT 15 6 0 Updated Aug 26, 2025
  • trmnl-liquid Public

    Liquid templating engine for TRMNL plugins

    usetrmnl/trmnl-liquid’s past year of commit activity
    Ruby 4 MIT 2 0 0 Updated Aug 20, 2025
  • trmnl-android Public

    Utility to display TRMNL screens on an Android device

    usetrmnl/trmnl-android’s past year of commit activity
    Kotlin 38 MIT 0 8 0 Updated Aug 15, 2025