immich-go

command module
v0.29.4-dev-56e4e32 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2025 License: AGPL-3.0 Imports: 6 Imported by: 0

README ΒΆ

Immich-Go: Upload Your Photos to Your Immich Server

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

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

🌟 Key Features

  • Simple Installation: No NodeJS or Docker required
  • Multiple Sources: Upload from Google Photos Takeouts, iCloud, local folders, ZIP archives, and other Immich servers
  • Large Collections: Successfully handles 100,000+ photos
  • Smart Management: Duplicate detection, burst photo stacking, RAW+JPEG handling
  • Cross-Platform: Available for Windows, macOS, Linux, and FreeBSD

πŸš€ Quick Start

1. Install Immich-Go

Download the pre-built binary for your system from the GitHub releases page.

2. Basic Usage
# Upload photos from a local folder
immich-go upload from-folder --server=http://your-ip:2283 --api-key=your-api-key /path/to/your/photos

# Upload Google Photos takeout
immich-go upload from-google-photos --server=http://your-ip:2283 --api-key=your-api-key /path/to/takeout-*.zip

# Archive photos from Immich server
immich-go archive from-immich --server=http://your-ip:2283 --api-key=your-api-key --write-to-folder=/path/to/archive
3. Requirements
  • A running Immich server with API access
  • API key with appropriate permissions (see full list)

πŸ“š Documentation

Topic Description
Installation Detailed installation instructions for all platforms
Commands Complete command reference and options
Configuration Configuration options and environment variables
Examples Common use cases and practical examples
Best Practices Tips for optimal performance and reliability
Technical Details File processing, metadata handling, and advanced features

πŸ’‘ Support the Project

🀝 Contributing

Contributions are welcome! Please see our contributing guidelines for details.

πŸ“„ License

This project is licensed under the terms specified in the LICENSE file.


Need help? Check our documentation or open an issue on GitHub.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
app
Package app provides the main application logic for immich-go, including client management for connecting to Immich servers.
Package app provides the main application logic for immich-go, including client management for connecting to Immich servers.
internal
config
Package config provides configuration management for the immich-go application.
Package config provides configuration management for the immich-go application.
gen
tester/cmd command
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL