icloud_photos_downloader README

The project's README from github.com/icloud-photos-downloader/icloud_photos_downloader. As one markdown file: README.md.

!!!! Looking for MAINTAINER for this project !!!!

iCloud Photos Downloader Quality Checks Build and Package MIT License

See Documentation for more details. Also, check Issues

We aim to release new versions once a week (Friday), if there is something worth delivering.

iCloud Prerequisites

To make iCloud Photo Downloader work, ensure the iCloud account is configured with the following settings, otherwise Apple Servers will return an ACCESS_DENIED error:

Install and Run

There are three ways to run icloudpd:

  1. Download executable for your platform from the GitHub Release and run it
  2. Use package manager to install, update, and, in some cases, run (Docker, PyPI, AUR, npm)
  3. Build and run from the source

See Documentation for more details

Features

Experimental Mode

Some changes are added to the experimental mode before they graduate into the main package. Details

Usage

To keep your iCloud photo collection synchronized to your local system:

icloudpd --directory /data --username [email protected] --watch-with-interval 3600

[!IMPORTANT] It is icloudpd, not icloud executable

[!TIP] Synchronization logic can be adjusted with command-line parameters. Run icloudpd --help to get full list.

To independently create and authorize a session (and complete 2SA/2FA validation if needed) on your local system:

icloudpd --username [email protected] --password my_password --auth-only

[!TIP] This feature can also be used to check and verify that the session is still authenticated.

Contributing

Want to contribute to iCloud Photos Downloader? Awesome! Check out the contributing guidelines to get involved.

icloud_photos_downloader (icloud-photos-downloader/icloud_photos_downloader)

pypi
Searching Database…

What is this?icloud_photos_downloader (icloudpd) is a command-line tool that downloads all your photos and videos from iCloud to your local system.
Is the command actually called 'icloud'?No, the executable is named icloudpd, not icloud, a common mix-up the README specifically calls out.
How do I get it running?You can download a prebuilt executable for your platform from the GitHub Release, install it through a package manager (Docker, PyPI, AUR, or npm), or build and run it from source.
Do I need to change any iCloud settings before using it?Yes, you need to enable 'Access iCloud Data on the Web' and disable 'Advanced Data Protection' in your Apple ID iCloud settings, otherwise Apple's servers return an ACCESSDENIED error.
Is this project actively maintained?The README currently shows a banner saying the project is looking for a new maintainer, which suggests ongoing development may slow down.
Can I run this on a NAS, not just a laptop?Yes, it works on Linux, Windows, and macOS across laptops, desktops, and NAS devices, and an official Docker image is available.
What's the difference between Copy, Sync, and Move modes?Copy (the default) just downloads new photos from iCloud; Sync also deletes local files that were removed in iCloud via the --auto-delete option; Move downloads photos and then deletes them from iCloud using --keep-icloud-recent-days.
Does it handle Live Photos and RAW images?Yes, Live Photos are saved as separate image and video files, RAW (including RAW+JPEG) images are supported, and photos with duplicate names are automatically de-duplicated.
Can it keep watching for new photos instead of running once?Yes, the --watch-with-interval option lets icloudpd monitor iCloud continuously for changes rather than doing a single one-time download.
Can it update photo metadata on download?Yes, the --set-exif-datetime option updates EXIF metadata on downloaded photos, among other options listed in icloudpd --help.
Size
45.7 MB
Stars
12.3K
Age
10y
Commits · 90 Days