A command-line tool to download photos from iCloud
Go to file
Andrey Nikiforov 1a642941e5
Update bug-report.md
2024-11-20 09:03:49 -08:00
.devcontainer use locale and tz in --version, use --version in compat testing (#902) 2024-07-08 15:58:57 -07:00
.github Update bug-report.md 2024-11-20 09:03:49 -08:00
.vscode doc updates (#912) 2024-07-13 09:39:31 -07:00
binary_dist bump 1.24.4 2024-11-18 15:10:06 +00:00
docs bump 1.24.4 2024-11-18 15:10:06 +00:00
examples folder structure cleanup (#649) 2023-07-01 14:05:24 -07:00
jq fix npm package (#639) 2023-06-14 23:32:49 -07:00
npm separate linux glibc and musl binaries. deprecate linux 386 & arm/v6 (#919) 2024-07-22 19:20:42 -07:00
scripts remove macos 11 & 12 support from bin dist #1000 (#1003) 2024-11-18 20:43:08 -08:00
src sms mfa using str instead of int to keep leading zeros (#995) 2024-11-11 13:50:54 -08:00
tests sms mfa using str instead of int to keep leading zeros (#995) 2024-11-11 13:50:54 -08:00
.dockerignore normalize eol (#815) 2024-04-11 22:22:08 -07:00
.gitattributes normalize eol (#815) 2024-04-11 22:22:08 -07:00
.gitignore doc updates (#912) 2024-07-13 09:39:31 -07:00
CHANGELOG.md remove macos-12 #1000 (#1001) 2024-11-18 10:52:53 -08:00
CODE_OF_CONDUCT.md update documentation 2020-12-02 22:30:54 +01:00
CONTRIBUTING.md bump 1.24.4 2024-11-18 15:10:06 +00:00
Dockerfile separate linux glibc and musl binaries. deprecate linux 386 & arm/v6 (#919) 2024-07-22 19:20:42 -07:00
Dockerfile.build separate linux glibc and musl binaries. deprecate linux 386 & arm/v6 (#919) 2024-07-22 19:20:42 -07:00
Dockerfile.build-musl bump python alpine 3.18->3.19 to bump default rust 1.71 -> 1.76 to unblock watchfiles compilation (#944) 2024-08-31 21:49:42 -07:00
EXPERIMENTAL.md doc updates (#912) 2024-07-13 09:39:31 -07:00
LICENSE.md add experimental npm distribution (#635) 2023-06-10 10:40:43 -07:00
README.md bump 1.24.4 2024-11-18 15:10:06 +00:00
README_AUR.md Add README_AUR.md (#783) 2024-02-01 13:16:45 -08:00
README_DOCKER.md fix spelling 2024-06-16 13:31:08 -07:00
README_NPM.md fix spelling 2024-06-16 13:31:08 -07:00
README_PYPI.md fix spelling 2024-06-16 13:31:08 -07:00
pyproject.toml bump 1.24.4 2024-11-18 15:10:06 +00:00
requirements-pip.txt update deps (#578) 2023-02-09 22:09:52 -08:00

README.md

iCloud Photos Downloader Quality Checks Multi Platform Docker Build MIT License

  • A command-line tool to download all your iCloud photos.
  • Works on Linux, Windows, and macOS; laptop, desktop, and NAS
  • Available as an executable for direct downloading and through package managers/ecosystems (Docker, PyPI, AUR, npm)
  • Developed and maintained by volunteers (we are always looking for help).

See Documentation for more details. Also, check Issues

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

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

  • Three modes of operation:
    • Copy - download new photos from iCloud (default mode)
    • Sync - download new photos from iCloud and delete local files that were removed in iCloud (--auto-delete option)
    • Move - download new photos from iCloud and delete photos in iCloud (--delete-after-download option)
  • Support for Live Photos (image and video as separate files) and RAW images (including RAW+JPEG)
  • Automatic de-duplication of photos with the same name
  • One time download and an option to monitor for iCloud changes continuously (--watch-with-interval option)
  • Optimizations for incremental runs (--until-found and --recent options)
  • Photo metadata (EXIF) updates (--set-exif-datetime option)
  • ... and many more (use --help option to get full list)

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 my@email.address --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 my@email.address --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.