Immich-Face-To-Album
The 'immich-face-to-album' tool is a CLI-based program that allows you to import a user's face from Immich into an album, in a way similar to the Google photos "auto-updating album" feature.
Installation
Built as a Python package, it can be installed using pip:
pip install immich-face-to-album
Usage
Start by grabbing both the face id and album id from Immich. You can find the face id by clicking on a face in the "Faces" tab, and the album id by clicking on an album in the "Albums" tab. The face id is the last part of the url, and the album id is the last part of the url.
To use the tool, you need your API key, Immich server url, face id and album id.
immich-face-to-album --key xxxxx --server https://your-immich-instance.com --face xxxxx --album xxxxx
Make sure to specify the protocol and port in the server url. For example, if your server is running on port 8080, you should specify the url as http://your-server-url:8080.
You can repeat the --face multiple times to add multiple faces to the same album.
On a schedule
The easiest way to keep face(s) synced with an album is to create a cron job that runs the command on a schedule.
For example, to run the command every hour, you can add the following to your crontab:
0 * * * * immich-face-to-album --key your-key --server your-server-url --face face-id --album album-id
1 maintainer
Metadata
1 maintainer
Release files for immich-face-to-album 1.0.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| immich_face_to_album-1.0.17.tar.gz | 21.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| immich_face_to_album-1.0.17-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.8 kB
Release files / immich_face_to_album-1.0.17.tar.gz
| Download URL | immich_face_to_album-1.0.17.tar.gz |
|---|---|
| Size | 21.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
867b2753bd3c6a8ea6e1c09b242beb2a704d7c6df6e564efe1e8117e3300b7a9
|
|
BLAKE2b-256 checksum How to use checksums |
1311914d0f6aab8d5cfcc7f4fdd3dfeed3c434c7bc8996a25bc9cbcd383875e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency logRelease files / immich_face_to_album-1.0.17-py3-none-any.whl
| Download URL | immich_face_to_album-1.0.17-py3-none-any.whl |
|---|---|
| Size | 8.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7d08f402b354bac7f7fd45e43410103472c12f4e2729695fe8ca287fad50e5df
|
|
BLAKE2b-256 checksum How to use checksums |
deda3268a5d7343878a2811717fab096d91b44b52a933dd739c1f1808a10ec5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 28, 2026.
Transparency log
