Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Command Reference

Immich-Go uses a hierarchical command structure with global options, commands, sub-commands, and specific options.

Command Structure

immich-go [global-options] command sub-command [command-options] [path]

Available Commands

Command Description Sub-commands
upload Upload photos/videos to Immich server from-folder, from-google-photos, from-icloud, from-picasa, from-immich
archive Export/archive photos to local folder structure from-folder, from-google-photos, from-icloud, from-picasa, from-immich
stack Organize related photos into stacks on server (none)
version Display version information (none)

Global Options

These options work with all commands:

Option Default Description
-h, --help - Show help information
-l, --log-file Auto-generated Write log messages to specified file
--log-level INFO Set logging level: DEBUG, INFO, WARN, ERROR
--log-type TEXT Log format: TEXT or JSON
-v, --version - Display current version

Log File Locations

OS Default Path
Linux $HOME/.cache/immich-go/immich-go_YYYY-MM-DD_HH-MI-SS.log
Windows %LocalAppData%\immich-go\immich-go_YYYY-MM-DD_HH-MI-SS.log
macOS $HOME/Library/Caches/immich-go/immich-go_YYYY-MM-DD_HH-MI-SS.log

Environment Variables

Variable Description
IMMICHGO_TEMPDIR Temporary directory for Immich-Go operations

Quick Examples

# Upload from local folder
immich-go upload from-folder --server=http://localhost:2283 --api-key=your-key /photos

# Archive from server
immich-go archive from-immich --server=http://localhost:2283 --api-key=your-key --write-to-folder=/backup

# Stack photos on server
immich-go stack --server=http://localhost:2283 --api-key=your-key --manage-burst=Stack

# Show version
immich-go version

Detailed Command Documentation