immich/docs/docs/usage/bulk-upload.md
2022-11-15 20:30:44 -06:00

2.4 KiB

sidebar_position
sidebar_position
3

Bulk Upload (Using the CLI)

You can use the CLI to upload an existing gallery to the Immich server

Immich CLI Repository

Requirements

  • Node.js 16 or above
  • Npm

Installation

npm i -g immich

Quick Start

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

immich upload --email testuser@email.com --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
--email / -e User's email
--password / -pw User's password
--server / -s Immich's server address
--directory / -d Directory to upload from
--threads / -t Number of threads to use (Default 5)
--album/ -al Create albums for assets based on the parent folder or a given name

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/immich-app/immich-cli:latest upload --email testuser@email.com --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/immich-app/immich-cli:latest"
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import

Run from source

git clone https://github.com/immich-app/CLI
npm install
npm run build
node bin/index.js upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory