inky-bird

Turn bird observations and detections into reviewed, reusable field-journal plates for color e-paper displays

Automatically checked · GitHub checked 2026-11-13

inky-bird

Overview

Inky Bird

A field journal for the birds in your life.

The cardinal at your feeder deserves a page.

Inky brings public sightings near you, station detections, imported birding history and favorite species into a private illustrated journal. Read it on your phone, save a collection, or put an approved plate on a color e-paper frame. I built Inky to keep birding present between outings.

Browse the bird gallery · Supported sources · Start without a frame · Build a wall frame

An Eastern Bluebird field-journal plate on a color e-paper screen in a bronze portrait frame
Eastern Bluebird on the 13.3-inch e-paper build. The frame is optional.

Inky Bird Home showing an approved Northern Cardinal plate with Play and Browse controls
Open your journal
A private Garden birds collection with Northern Cardinal and American Robin plates
Keep a collection

Both screenshots are from the app on main, with public plates and a sample collection. Open either image for the full-size view.

Open video on GitHub

Watch the 28-second walkthrough · Text transcript · Still preview. Sample data, accelerated navigation, and a separate e-paper installation; browser Play does not refresh the wall.

CI Latest release License: MIT

Supported sources

Bring nearby sightings, feeder visits, station detections and years of personal birding history into one journal. Use one source or combine several.

SourceWhat you can bring into Inky
iNaturalistNearby public bird observations around your location; no provider account.
eBirdRecent public sightings around your location; personal API key.
eBird ArchiveYour own checklists, trips and life list from an export; not continuous account sync.
BirdWeatherYour station's acoustic detections; station token.
BirdNET-GoYour self-hosted station's detections over its read-only API.
BirdNET AnalyzerRecorded-audio detections from a CSV import.
Bird BuddyFeeder postcard species and optional manual sightings; account plus permission to use its private API.

Inky reads detections; it does not record sound or run the detector. Public nearby observations are not a claim that you personally saw a bird. Your imported history and collections are not published with the reusable artwork catalog.

No source is required to browse approved art, save collections or play plates. Compare setup options and limits.

Start with what you have

I want to…Start here
See the artwork, with nothing to installBrowse the public gallery.
Keep a journal on a phone, tablet, or computerRun the controller on an existing machine: Docker or NAS or native installation. Open /app and create your owner account.
Put birds on a wallUse Play in a browser, pair a read-only screen, or build the 7.3-inch or 13.3-inch e-paper frame.
Connect a station, feeder, or observation accountChoose a source. Start with one, or keep using saved collections without any sources.
Choose how I sign in and connectUse built-in username and password, or connect single sign-on (OIDC). Add encrypted HTTPS directly in Inky or through your existing reverse proxy.
Upgrade an existing installationBack up your controller, read the notes for the target release, and follow its update guide.

Browse, save collections, and play plates in the browser. With approved artwork, you need no camera, microphone, provider account, or Codex login. New setups start with generation off. Turning it on uses your own Codex account, and that provider's charges apply.

These docs describe main, which may be ahead of your install. If you run a tagged release, follow the instructions shipped with it.

One plate, several ways to see it

When a species has an approved plate, your screens reuse it. Save birds to Favorites or a named collection, then choose Play to see the full plates without changing the physical wall. The optional e-paper display downloads only approved assets and keeps the last picture if the network goes down. Home Assistant and Homepage can show selected art on your trusted network and use a separate credential for status. See screens and dashboards.

In the journal, search your birds, sort them by name or by when they were last noted, and show only favorites, birds from your history, or birds that have no plate yet.

Words Inky uses

WordMeaning
Your journalEverything you keep in Inky: your birds, their plates and your collections.
PlateOne illustrated bird, checked against references and approved before it is shown.
New plateA plate Inky made that is waiting for you to look at it.
On my frameThe birds your wall frame and Play show: birds noted recently plus the birds you added.
More platesPlates you could add to your frame.
In the worksPlates being made, and what is waiting to be made next.
Needs a handA plate that could not be finished on its own; whoever runs Inky can help it along.
NotedWhen a bird was recorded: a feeder photo, a microphone detection or a checklist. "Last noted" is the most recent.
FavoriteA bird you saved with Add to Favorites on its page.
CollectionsNamed groups of birds, such as a trip.
SourcesWhere birds come from: nearby sightings, a station, a feeder or an import.
PlayA full-screen slideshow of your plates in the browser. It does not change the wall frame.
Wall frameThe optional color e-paper display on your wall.

The shared plates are AI-generated illustrations checked against references and reviewed separately before approval. You can reuse the public catalog under the MIT license. If a species is missing, you can request it or configure your own controller to generate it with Codex. Generation can use a subscription allowance or incur API costs. See the review process and owner controls.

The birds you noted and your collections stay separate from the shared catalog. See what stays private and what leaves the controller. Keep the controller on a trusted network: owner sign-in does not protect the legacy catalog and display routes. Do not port-forward the controller to the internet. For private remote access, see the access guide.

Other bird projects

If you want a microphone-to-collage build, Teddy Warner’s AvianVisitors is a good place to start. Fugleramme and Featherframe pair station detections with historical natural-history illustrations. Inky is for keeping and revisiting birds from several sources, including trips and manual selections, as individual field-journal plates. You can start with the artwork alone.

Docs and contributions

Made by Henry Sowell. Thanks to @dwalters0 for helping close the trusted browser-client gap, and to everyone who has shared a bird, a bug, or a fix.