These birds aren't your friends, pal.
  • Go 70.7%
  • Python 29.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
eddie 96c7b2a69f
All checks were successful
docs / docs (push) Successful in 18s
Update docs/index.md
2026-10-19 16:38:23 -07:00
.forgejo Support only Linux and container builds 2026-10-19 10:07:25 -07:00
docs Update docs/index.md 2026-10-19 16:38:23 -07:00
packaging/systemd Add GoReleaser release builds and Forgejo release workflow 2026-10-16 12:10:15 -07:00
.env.example birdpal: sync Bird Buddy feeder photos and videos into Immich 2026-10-16 12:10:15 -07:00
.gitignore Add documentation site for birdpal.edfig.dev 2026-10-16 22:39:01 -07:00
.goreleaser.yaml Support only Linux and container builds 2026-10-19 10:07:25 -07:00
birdbuddy.go birdpal: sync Bird Buddy feeder photos and videos into Immich 2026-10-16 12:10:15 -07:00
e2e_test.py Merge main into synclocal 2026-10-19 15:48:23 -07:00
go.mod birdpal: sync Bird Buddy feeder photos and videos into Immich 2026-10-16 12:10:15 -07:00
immich.go birdpal: sync Bird Buddy feeder photos and videos into Immich 2026-10-16 12:10:15 -07:00
LICENSE Add AGPL-3.0-or-later license 2026-10-16 12:10:15 -07:00
local.go Add --synclocal to save media into a local folder 2026-10-19 10:31:02 -07:00
main.go Merge main into synclocal 2026-10-19 15:48:23 -07:00
meta.go Write tags as standard XMP keywords too 2026-10-19 10:45:37 -07:00
mkdocs.yml Update mkdocs.yml 2026-10-19 16:36:24 -07:00
README.md Support only Linux and container builds 2026-10-19 10:07:25 -07:00

birdpal

birdpal copies the photos and videos from your Bird Buddy feeder into Immich, with the bird's name, the feeder, the place and the time on each one.

Documentation: https://birdpal.edfig.dev

Install

  • Linux (.deb, .rpm, .tar.gz): download from the releases.
  • Container: quay.io/eddiefigsystems/birdpal or docker.io/efigueroa/birdpal

Quick start

export BIRDPAL_BBEMAIL=you@example.com
export BIRDPAL_BBPASSWD='your-bird-buddy-password'
export BIRDPAL_IMMICHSERVER=https://immich.example.com
export BIRDPAL_IMMICHKEY=your-immich-api-key
birdpal --sync --update --full --tags

Then keep it in sync with the systemd timers. The Immich API key needs only a few permissions; see Usage.

Build

go build -o birdpal .
go build -o birdpal_test_bin . && python3 e2e_test.py

License

AGPL-3.0-or-later. See LICENSE.