IMMICH-ARCHIVER(1)

📦 version 0.1.9, in ubuntu stonking

💖 NAME 💖

immich-archiver — bestie, it's a lil utility that mirrors your photos off an immich server 🫶

🦋 DESCRIPTION 🦋

Okay so picture this: your Immich instance holds your whole camera roll, and you want a second copy of that timeline sitting on your actual local disk. That's literally it. That's the whole job. It mirrors an Immich instance's timeline onto local disk. No cap. 👑

✨ Usage: ✨

immich-archiver [flags]

🎀 Flags: 🎀

  • --api-key string — your Immich user API key. It'll also pick this up from the env var IMMICH_API_KEY if you'd rather not paste it in every time 💅
  • --concurrency int — how many assets get downloaded at the same time, in parallel. Default is 4 — she's multitasking 🏃‍♀️🏃‍♀️🏃‍♀️🏃‍♀️
  • --dir string — the destination root directory. This one is required, no skipping it, and it can come from the env var IMMICH_DIR instead.
  • --dry-run — lists what would be downloaded without writing anything at all. A little peek, zero commitment, we love a preview ✨
  • -h, --help — help for immich-archiver. Your safety net 🫶
  • --include-shared — also mirror the assets that have been shared with you, and it drops them into a separate folder so they don't get mixed up with your own stuff 💖
  • --path-template string — the folder structure template. It supports {year}, {month}, and {day}. Default is "{year}/{year}-{month}" 📁
  • --refresh-sidecars — rewrites the .json sidecar of assets that are already on disk. Important: the originals are not re-downloaded, this is just the sidecar getting a glow-up ♻️
  • --retries int — how many retry attempts it gets for failed downloads and requests. Default is 3. Persistence, periodt 💪
  • --shared-dir string — the destination root for shared assets. Default is <dir>/shared-with-me 🗂️
  • --shared-path-template string — the folder structure template specifically for those shared assets. Default is the same as whatever you passed to --path-template.
  • --url string — the Immich server URL. Also readable from the env var IMMICH_URL 🌐
  • -v, --verbose — logs a whole line per asset instead of showing you a progress bar. For when you need the play-by-play 🗣️
  • --version — version for immich-archiver.
ngl bestie, --dir being required is the one thing you cannot forget, she will simply not run without it 🙈

okay that's the whole page!! this is immich-archiver version 0.1.9, shipped August 2026 — go mirror that timeline, you've got this, mwah 💋🎀🌸

📦 where this page comes from