Skip to main content

Quick Start

Three steps. Should take about 2 minutes.

1. Install​

The fastest way: no clone needed:

uvx immich-memories --help

Or clone and install:

git clone https://github.com/sam-dumont/immich-video-memory-generator.git
cd immich-video-memory-generator
uv sync

See Installation for pip, Docker, and Kubernetes options.

2. Configure​

Set your Immich connection. Either environment variables:

export IMMICH_URL=https://photos.example.com
export IMMICH_API_KEY=your-api-key-here

Or create ~/.immich-memories/config.yaml:

immich:
  url: https://photos.example.com
  api_key: your-api-key-here

Get your API key from Immich: Account Settings > API Keys > New API Key.

3. Launch​

Web UI (recommended for first run):

immich-memories ui
# Opens at http://localhost:8080

CLI (for scripts and automation):

# Last 30 days, 5-minute video (duration is in seconds)
immich-memories generate --start 2024-01-01 --period 30d --duration 300

# Or just a full year
immich-memories generate --year 2024

That's it. The UI will walk you through the rest: picking people, time ranges, music, and output settings.