IMMICH CLI

CLI utilities to help with some operations with the Immich app

Features

• Upload assets (videos/images) from a directory to IMMICH server

Supported file type

Image

• heif
• heic
• jpeg
• gif
• png

Video

• mp4
• quicktime

Getting Started

Install from NPM

1 - Install from NPM repository

npm i -g immich

2 - Run

Specify user's credential, Immich's server address and port and the directory you would like to upload videos/photos from.

immich upload --email [email protected] --password password --server http://192.168.1.216:2283/api -d your/target/directory

---

Parameters

Parameter	Description
--yes / -y	Assume yes on all interactive prompts
--delete / -da	Delete local assets after upload

Run via Docker

Be aware that as this runs inside a container, it mounts your current directory as a volume and for the -d flag you need to use the path inside the container.

docker run -it --rm -v $(pwd):/import ghcr.io/alextran1502/immich-cli:v0.5.0 upload --email [email protected] --password password --server http://192.168.1.216:2283/api -d /import

Optionally, you can create an alias:

alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/alextran1502/immich-cli:v0.5.0"  
immich upload --email [email protected] --password password --server http://192.168.1.216:2283/api -d /import

Install from source

1 - Clone Repository

git clone https://github.com/alextran1502/immich-cli

2 - Install dependencies

npm install

3 - Run

node bin/index.js upload --email [email protected] --password password --server http://192.168.1.216:2283/api -d your/target/directory