Skip to content

Plugin Guide

github-actions[bot] edited this page Apr 8, 2026 · 4 revisions

Plugin Guide

The LrGeniusAI Lightroom Plug-in is the primary frontend for communicating with the AI backend. Through native Lua integrations and Lightroom dialogs, it provides a seamless user experience for extending your photography workflow with AI.

Main Documentation

For detailed technical usage of the plugin component, please view the plugin/README.md.

Core Workflows

The plugin handles the following core capabilities via the Library -> Plug-in Extras menu:

1. Analyze and Index

Passes the image files, metadata, and optional context directly to the backend to generate tags, structural descriptions, and embeddings. This operation is asynchronous, and progress can be monitored safely without freezing the interface.

2. Advanced Search

Invokes semantic search. Unlike keyword search, semantic search translates natural language queries (e.g. "red sports car in a dark alley") into vectors that are compared against the visual embeddings of your images. Matches are grouped into a new Lightroom Collection, sorted by relevance.

3. Image Culling

Instead of manually comparing bursts of similar photos, the culling workflow analyzes time-grouped shots for sharpness, eye contact, and expression, grading them from best to worst. The plugin will create a structured Collection Set to categorize Picks, Alternates, and Rejects automatically.

4. Metadata Import and Retrieval

  • Import: Syncs your existing Lightroom catalog metadata into the backend, improving subsequent AI tagging logic by giving the LLM existing context.
  • Retrieval: If you generate AI tags on the backend but opt not to write them into Lightroom immediately, you can fetch them back later using the Retrieval utility.

5. Error Management

Errors no longer fail silently into log files. If a batch indexing task encounters issues (like a network timeout or an API authentication failure), the plugin provides a Task Completion Dialog. This aggregates the successes and details exactly what went wrong for any omitted files, making troubleshooting immediate and straightforward. For more info, see the Troubleshooting guide.

One-Time Upgrade Path

photo_id migration is a required, one-time step for databases upgrading from older releases that utilized catalog UUIDs. This enables better cross-catalog stability.

  • To perform the migration: Open the Plug-in Manager dialog -> Backend Server -> Click Migrate existing DB IDs to photo_id.

Clone this wiki locally