Skip to main content

Sync Lightroom Classic catalogs to Immich

Project description

lrimmich

PyPI

Syncs your Lightroom Classic catalog to Immich. Collections become albums, picks become favorites, ratings carry over, and color labels and keywords are written as tags.

The same photo files Lightroom reads must be mounted into Immich as an external library. lrimmich doesn't upload anything. It matches files that are already on both sides and writes metadata through the Immich API.

Install

uv tool install lrimmich

or pipx install lrimmich.

Getting started

lrimmich config init

This writes a starter config to your platform's user config directory:

  • Linux: ~/.config/lrimmich/config.toml (XDG)
  • macOS: ~/Library/Application Support/lrimmich/config.toml
  • Windows: %APPDATA%\lrimmich\config.toml

Edit it with your catalog path, Immich URL, API key, and library path (the folder Immich mounts your photos from). See sample_config.toml for all options.

lrimmich doctor

Checks that the catalog opens, the Immich API responds, and at least some files resolve. If it passes, run a dry-run first:

lrimmich sync --dry-run

Commands

lrimmich sync              # sync everything
lrimmich sync --dry-run    # see what would happen
lrimmich status            # exit 1 if there's drift
lrimmich watch             # poll for catalog changes, sync when detected
lrimmich adopt             # claim existing Immich albums by name match
lrimmich log               # show recent sync activity
lrimmich reset             # delete state DB, next sync rebuilds from scratch
lrimmich install-service   # generate launchd/systemd unit for periodic sync
lrimmich uninstall-service # remove service files
lrimmich config show       # print resolved config (secrets redacted)
lrimmich config edit       # open config in your default editor
lrimmich --version         # print version

Watch

Watches the catalog file (including WAL) for filesystem events and syncs after a debounce window:

lrimmich watch --debounce 5000

To run it as a background service:

lrimmich install-service --interval 300

How it works

Reads the .lrcat SQLite database, maps LR file paths to Immich asset IDs by scanning the external library folder tree, then diffs against what was synced last time (stored alongside the config in your platform's user state directory). Repeat runs only touch what changed.

Alternatives

How it works Uploads photos?
lrimmich CLI tool. Reads the .lrcat database directly, matches files already mounted in Immich, writes metadata only. No
immich-go CLI tool. Bulk uploads from local folders, Google Photos takeouts, iCloud exports. Handles duplicates and stacking. Yes
lrc-immich-plugin LR Classic plugin. Export and publish service that uploads rendered photos via the Immich API. Can also import from Immich. Yes
mi.Immich.Publisher LR Classic plugin. Publishes collections as albums, deduplicates across collections. Beta, not actively maintained. Yes

Contributing

Bug reports and PRs welcome. For bugs, include the output of lrimmich doctor and the command you ran. Open an issue at github.com/haavardnk/lrimmich/issues.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lrimmich-0.1.0.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lrimmich-0.1.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file lrimmich-0.1.0.tar.gz.

File metadata

  • Download URL: lrimmich-0.1.0.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lrimmich-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f78fbababa3e5caea06e614a37768d2a3c48005256368f98708db0dd30aaf97c
MD5 e2984cb126cbc0d41874812775bf9b9d
BLAKE2b-256 3ca3813b8e53a2f10d9c2b7ddd918ccc00cb7fc04c2a8d0950ffed03dea90a76

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrimmich-0.1.0.tar.gz:

Publisher: ci.yml on haavardnk/lrimmich

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lrimmich-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: lrimmich-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 32.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lrimmich-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e78ec4c35bf492a354c2b8153a0a92fb4a46605e94cb3791888d852788571e1
MD5 8ba4169fa17bcdbcd0f825f8b6a852b4
BLAKE2b-256 d7c8e9832a176041b32dbdf5de5fd80b02ea3191e412bb66d2adb1ef3a7c07b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for lrimmich-0.1.0-py3-none-any.whl:

Publisher: ci.yml on haavardnk/lrimmich

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page