Immich-Go is an open-source tool designed to streamline uploading large photo collections to your self-hosted Immich server.

• Effortlessly Upload Large Google Photos Takeouts: Immich-Go excels at handling the massive archives you download from Google Photos using Google Takeout. It efficiently processes these archives while preserving valuable metadata like GPS location, date taken, and album information.
• Flexible Uploads: Immich-Go isn't limited to Google Photos. You can upload photos directly from your computer folders, folders tree and ZIP archives.
• Simple Installation: Immich-Go doesn't require NodeJS or Docker for installation. This makes it easy to get started, even for those less familiar with technical environments.
• Prioritize Quality: Immich-Go discards any lower-resolution versions that might be included in Google Photos Takeout, ensuring you have the best possible copies on your Immich server.
• Stack burst and raw/jpg photos: Group together related photos in Immich.

• Taking Out Your Photos:

  • Choose the ZIP format when creating your takeout for easier import.
  • Select the largest file size available (50GB) to minimize the number of archive parts.
  • Download all parts on your computer

• Importing Your Photos:

  • If your takeout is in ZIP format, you can import it directly without needing to unzip the files first.
  • It's important to import all the parts of the takeout together, since some data might be spread across multiple files.
    Use /path/to/you/files/takeout-*.zip as file name.
  • For .tgz files (compressed tar archives), you'll need to decompress all the files into a single folder before importing. When using the import tool, don't forget the -google-photos option.
  • You can remove any unwanted files or folders from your takeout before importing. Immich-go might warn you about missing JSON files, but it should still import your photos successfully.
  • Restarting an interrupted import won't cause any problems and it will resume the work where it was left.

For insights into the reasoning behind this alternative to immich-cli, please read the motivation here.

⚠️ This an early version, not yet extensively tested
⚠️ Keep a backup copy of your files for safety

The immich-go is a command line tool that must be run from a terminal window.
The immich-go program uses the Immich API. Hence it need the server address and a valid API key.

immich-go -server URL -key KEY -general_options COMMAND -command_options... {files}

Boolean options have a default value indicated below. Mentioning any option on the common line changes the option to TRUE. To force an option to FALSE, use the following syntax: -option=FALSE.

Example: Immich-go check the server's SSL certificate. you can disable this behavior by turning on the skip-verify-ssl option. Just add -skip-verify-ssl. -skip-verify-ssl is equivalent to -skip-verify-ssl=TRUE. To turn off the feature (which is the default behavior), use -skip-verify-ssl=FALSE

Use this command for uploading photos and videos from a local directory, a zipped folder or all zip files that google photo takeout procedure has generated.

Fine-tune import based on specific dates:

Specialized options for Google Photos management:

Read here to understand how Google Photos takeout isn't easy to handle.

Currently the bursts following this schema are detected:

• xxxxx_BURSTnnn.*
• xxxxx_BURSTnnn_COVER.*
• xxxxx.RAW-01.COVER.jpg and xxxxx.RAW-02.ORIGINAL.dng
• xxxxx.RAW-01.MP.COVER.jpg and xxxxx.RAW-02.ORIGINAL.dng
• xxxxxIMG_xxxxx_BURSTyyyymmddhhmmss.jpg and xxxxxIMG_xxxxx_BURSTyyyymmddhhmmss_COVER.jpg (Huawei Nexus 6P)
• yyyymmdd_hhmmss_xxx.jpg (Samsung)

All images must be taken during the same minute. The COVER image will be the parent image of the stack

Both images should been taken in the same minute. The JPG image will be the cover.

Please open an issue to cover more possibilities.

To illustrate, here's a command importing photos from a Google Photos takeout archive captured between June 1st and June 30th, 2019, while auto-generating albums:

./immich-go -server=http://mynas:2283 -key=zzV6k65KGLNB9mpGeri9n8Jk1VaNGHSCdoH1dY8jQ upload
-create-albums -google-photos -date=2019-06 ~/Download/takeout-*.zip             

Use this command for analyzing the content of your immich server to find any files that share the same file name, the date of capture, but having different size. Before deleting the inferior copies, the system get all albums they belong to, and add the superior copy to them.

This command examine the immich server content, remove less quality images, and preserve albums.

./immich-go -server=http://mynas:2283 -key=zzV6k65KGLNB9mpGeri9n8Jk1VaNGHSCdoH1dY8jQ duplicate -yes

The possibility to stack images has been introduced with immich version 1.83. Let use it to group burst and jpg/raw images together.

This command introduce command line tools to manipulate your immich server

This command deletes albums that match with the given pattern

-yes Assume Yes to all questions (default: FALSE).

./immich-go -server=http://mynas:2283 -key=zzV6k65KGLNB9mpGeri9n8Jk1VaNGHSCdoH1dY8jQ tool album delete \d{4}-\d{2}-\d{2}

This command deletes all albums created with de pattern YYYY-MM-DD

Installing immich-go is a straightforward process. Visit the latest release page and select the binary file compatible with your system:

• Darwin arm-64, x86-64
• Linux arm-64, armv6-64, x86-64
• Windows arm-64, x86-64
• Freebsd arm-64, x86-64

Download the archive corresponding to your OS/Architecture on your machine, and decompress it.

Open a command windows, go to the directory where immich-go resides, and type the command immich-go with mandatory parameters and command.

⚠️ Please note that the linux x86-64 version is the only one tested.

For a source-based installation, ensure you have the necessary Go language development tools (https://go.dev/doc/install) in place. Download the source files or clone the repository.

immich-go is packaged with nix and distributed via nixpkgs. You can try immich-go without installing it with:

nix-shell -I "nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-unstable-small.tar.gz" -p immich-go
# Or with flakes enabled
nix run "github:nixos/nixpkgs?ref=nixos-unstable-small#immich-go" -- -help

Or you can add immich-go to your configuration.nix in the environment.systemPackages section.

Kudos to the Immich team for they stunning project!🤩

This program use following 3rd party libraries:

• github.com/rwcarlsen/goexif to get date of capture from JPEG files
• github.com/ttacon/chalk for having logs nicely colored
• github.com/thlib/go-timezone-local for its windows timezone management

A big thank you to the project contributors:

• rodneyosodo gitub CI, go linter, and advices
• sigmahour SSL management
• mrwulf Partner sharing album