diff --git a/README.md b/README.md
index 80356fbd..9c26bde2 100644
--- a/README.md
+++ b/README.md
@@ -183,41 +183,52 @@ Options:
use in the following order: 1. last opened
library, 2. system library, 3.
~/Pictures/Photos Library.photoslibrary
+
-V, --verbose Print verbose output.
--keyword KEYWORD Search for photos with keyword KEYWORD. If
more than one keyword, treated as "OR", e.g.
find photos matching any keyword
+
--person PERSON Search for photos with person PERSON. If more
than one person, treated as "OR", e.g. find
photos matching any person
+
--album ALBUM Search for photos in album ALBUM. If more than
one album, treated as "OR", e.g. find photos
matching any album
+
--folder FOLDER Search for photos in an album in folder
FOLDER. If more than one folder, treated as
"OR", e.g. find photos in any FOLDER. Only
searches top level folders (e.g. does not look
at subfolders)
+
--uuid UUID Search for photos with UUID(s).
--uuid-from-file FILE Search for photos with UUID(s) loaded from
FILE. Format is a single UUID per line. Lines
preceded with # are ignored.
+
--title TITLE Search for TITLE in title of photo.
--no-title Search for photos with no title.
--description DESC Search for DESC in description of photo.
--no-description Search for photos with no description.
--place PLACE Search for PLACE in photo's reverse
geolocation info
+
--no-place Search for photos with no associated place
name info (no reverse geolocation info)
+
--label LABEL Search for photos with image classification
label LABEL (Photos 5 only). If more than one
label, treated as "OR", e.g. find photos
matching any label
+
--uti UTI Search for photos whose uniform type
identifier (UTI) matches UTI
+
-i, --ignore-case Case insensitive search for title,
description, place, keyword, person, or album.
+
--edited Search for photos that have been edited.
--external-edit Search for photos edited in external editor.
--favorite Search for photos marked favorite.
@@ -226,47 +237,61 @@ Options:
--not-hidden Search for photos not marked hidden.
--shared Search for photos in shared iCloud album
(Photos 5 only).
+
--not-shared Search for photos not in shared iCloud album
(Photos 5 only).
+
--burst Search for photos that were taken in a burst.
--not-burst Search for photos that are not part of a
burst.
+
--live Search for Apple live photos
--not-live Search for photos that are not Apple live
photos.
+
--portrait Search for Apple portrait mode photos.
--not-portrait Search for photos that are not Apple portrait
mode photos.
+
--screenshot Search for screenshot photos.
--not-screenshot Search for photos that are not screenshot
photos.
+
--slow-mo Search for slow motion videos.
--not-slow-mo Search for photos that are not slow motion
videos.
+
--time-lapse Search for time lapse videos.
--not-time-lapse Search for photos that are not time lapse
videos.
+
--hdr Search for high dynamic range (HDR) photos.
--not-hdr Search for photos that are not HDR photos.
--selfie Search for selfies (photos taken with front-
facing cameras).
+
--not-selfie Search for photos that are not selfies.
--panorama Search for panorama photos.
--not-panorama Search for photos that are not panoramas.
--has-raw Search for photos with both a jpeg and raw
version
+
--only-movies Search only for movies (default searches both
images and movies).
+
--only-photos Search only for photos/images (default
searches both images and movies).
+
--from-date DATETIME Search by start item date, e.g.
2000-01-12T12:00:00,
2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO
8601).
+
--to-date DATETIME Search by end item date, e.g.
2000-01-12T12:00:00,
2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO
8601).
+
--has-comment Search for photos that have comments.
--no-comment Search for photos with no comments.
--has-likes Search for photos that have likes.
@@ -274,17 +299,23 @@ Options:
--is-reference Search for photos that were imported as
referenced files (not copied into Photos
library).
+
--in-album Search for photos that are in one or more
albums.
+
--not-in-album Search for photos that are not in any albums.
--missing Export only photos missing from the Photos
library; must be used with --download-missing.
+
--deleted Include photos from the 'Recently Deleted'
folder.
+
--deleted-only Include only photos from the 'Recently
Deleted' folder.
+
--update Only export new or updated files. See notes
below on export and --update.
+
--ignore-signature When used with '--update', ignores file
signature when updating files. This is useful
if you have processed or edited exported
@@ -303,12 +334,15 @@ Options:
not; 3) if a sidecar does not exist for the
photo, a sidecar will be written whether or
not the photo file was written or updated.
+
--only-new If used with --update, ignores any previously
exported files, even if missing from the
export folder and only exports new files that
haven't previously been exported.
+
--dry-run Dry run (test) the export but don't actually
export any files; most useful with --verbose.
+
--export-as-hardlink Hardlink files instead of copying them. Cannot
be used with --exiftool which creates copies
of the files with embedded EXIF data. Note: on
@@ -316,41 +350,53 @@ Options:
giving many of the same advantages as
hardlinks without having to use --export-as-
hardlink.
+
--touch-file Sets the file's modification time to match
photo date.
+
--overwrite Overwrite existing files. Default behavior is
to add (1), (2), etc to filename if file
already exists. Use this with caution as it
may create name collisions on export. (e.g. if
two files happen to have the same name)
+
--export-by-date Automatically create output folders to
organize photos by date created (e.g.
DEST/2019/12/20/photoname.jpg).
+
--skip-edited Do not export edited version of photo if an
edited version exists.
+
--skip-original-if-edited Do not export original if there is an edited
version (exports only the edited version).
+
--skip-bursts Do not export all associated burst images in
the library if a photo is a burst photo.
+
--skip-live Do not export the associated live video
component of a live photo.
+
--skip-raw Do not export associated raw images of a
RAW+JPEG pair. Note: this does not skip raw
photos if the raw photo does not have an
associated jpeg image (e.g. the raw file was
imported to Photos without a jpeg preview).
+
--current-name Use photo's current filename instead of
original filename for export. Note: Starting
with Photos 5, all photos are renamed upon
import. By default, photos are exported with
the the original name they had before import.
+
--convert-to-jpeg Convert all non-jpeg images (e.g. raw, HEIC,
PNG, etc) to JPEG upon export. Only works if
your Mac has a GPU.
+
--jpeg-quality FLOAT RANGE Value in range 0.0 to 1.0 to use with
--convert-to-jpeg. A value of 1.0 specifies
best quality, a value of 0.0 specifies maximum
compression. Defaults to 1.0
+
--download-missing Attempt to download missing photos from
iCloud. The current implementation uses
Applescript to interact with Photos to export
@@ -363,6 +409,7 @@ Options:
export all burst images; only the primary
photo will be exported--associated burst
images will be skipped.
+
--sidecar FORMAT Create sidecar for each photo exported; valid
FORMAT values: xmp, json, exiftool; --sidecar
xmp: create XMP sidecar used by Digikam, Adobe
@@ -389,6 +436,7 @@ Options:
tags exported in the JSON and exiftool
sidecar, see '--exiftool'. See also '--ignore-
signature'.
+
--sidecar-drop-ext Drop the photo's extension when naming sidecar
files. By default, sidecar files are named in
format 'photo_filename.photo_ext.sidecar_ext',
@@ -400,6 +448,7 @@ Options:
of different types but the same name in the
output directory, e.g. 'IMG_1234.JPG' and
'IMG_1234.MOV'.
+
--exiftool Use exiftool to write metadata directly to
exported photos. To use this option, exiftool
must be installed and in the path. exiftool
@@ -421,8 +470,10 @@ Options:
QuickTime:ModifyDate (see also --ignore-date-
modified); QuickTime:GPSCoordinates;
UserData:GPSCoordinates.
+
--exiftool-path EXIFTOOL_PATH Optionally specify path to exiftool; if not
provided, will look for exiftool in $PATH.
+
--exiftool-option OPTION Optional flag/option to pass to exiftool when
using --exiftool. For example, --exiftool-
option '-m' to ignore minor warnings. Specify
@@ -432,21 +483,27 @@ Options:
full list of options. More than one option may
be specified by repeating the option, e.g.
--exiftool-option '-m' --exiftool-option '-F'.
+
--exiftool-merge-keywords Merge any keywords found in the original file
with keywords used for '--exiftool' and '--
sidecar'.
+
--exiftool-merge-persons Merge any persons found in the original file
with persons used for '--exiftool' and '--
sidecar'.
+
--ignore-date-modified If used with --exiftool or --sidecar, will
ignore the photo modification date and set
EXIF:ModifyDate to EXIF:DateTimeOriginal; this
is consistent with how Photos handles the
EXIF:ModifyDate tag.
+
--person-keyword Use person in image as keyword/tag when
exporting metadata.
+
--album-keyword Use album name as keyword/tag when exporting
metadata.
+
--keyword-template TEMPLATE For use with --exiftool, --sidecar; specify a
template string to use as keyword in the form
'{name,DEFAULT}' This is the same format as
@@ -459,6 +516,7 @@ Options:
"{folder_album}" --keyword-template
"{created.year}". See '--replace-keywords' and
Templating System below.
+
--replace-keywords Replace keywords with any values specified
with --keyword-template. By default,
--keyword-template will add keywords to any
@@ -467,6 +525,7 @@ Options:
from --keyword-template will replace any
existing keywords instead of adding additional
keywords.
+
--description-template TEMPLATE
For use with --exiftool, --sidecar; specify a
template string to use as description in the
@@ -477,6 +536,7 @@ Options:
--description-template "{descr} exported with
osxphotos on {today.date}" See Templating
System below.
+
--finder-tag-template TEMPLATE Set MacOS Finder tags to TEMPLATE. These tags
can be searched in the Finder or Spotlight
with 'tag:tagname' format. For example, '--
@@ -485,11 +545,13 @@ Options:
TEMPLATE values by using '--finder-tag-
template' multiple times. See also '--finder-
tag-keywords and Extended Attributes below.'.
+
--finder-tag-keywords Set MacOS Finder tags to keywords; any
keywords specified via '--keyword-template', '
--person-keyword', etc. will also be used as
Finder tags. See also '--finder-tag-template
and Extended Attributes below.'.
+
--xattr-template ATTRIBUTE TEMPLATE
Set extended attribute ATTRIBUTE to TEMPLATE
value. Valid attributes are: 'authors',
@@ -500,16 +562,19 @@ Options:
findercomment "{title}; {descr}" See Extended
Attributes below for additional details on
this option.
+
--directory DIRECTORY Optional template for specifying name of
output directory in the form '{name,DEFAULT}'.
See below for additional details on templating
system.
+
--filename FILENAME Optional template for specifying name of
output file in the form '{name,DEFAULT}'. File
extension will be added automatically--do not
include an extension in the FILENAME template.
See below for additional details on templating
system.
+
--jpeg-ext EXTENSION Specify file extension for JPEG files. Photos
uses .jpeg for edited images but many images
are imported with .jpg or .JPG which can
@@ -519,12 +584,14 @@ Options:
exported JPEG images. Valid values are jpeg,
jpg, JPEG, JPG; e.g. '--jpeg-ext jpg' to use
'.jpg' for all JPEGs.
+
--strip Optionally strip leading and trailing
whitespace from any rendered templates. For
example, if --filename template is "{title,}
{original_name}" and image has no title,
resulting file would have a leading space but
if used with --strip, this will be removed.
+
--edited-suffix SUFFIX Optional suffix template for naming edited
photos. Default name for edited photos is in
form 'photoname_edited.ext'. For example, with
@@ -534,6 +601,7 @@ Options:
suffix is '_edited'. Multi-value templates
(see Templating System) are not permitted with
--edited-suffix.
+
--original-suffix SUFFIX Optional suffix template for naming original
photos. Default name for original photos is
in form 'filename.ext'. For example, with '--
@@ -542,9 +610,11 @@ Options:
default suffix is '' (no suffix). Multi-value
templates (see Templating System) are not
permitted with --original-suffix.
+
--use-photos-export Force the use of AppleScript or PhotoKit to
export even if not missing (see also '--
download-missing' and '--use-photokit').
+
--use-photokit Use with '--download-missing' or '--use-
photos-export' to use direct Photos interface
instead of AppleScript to export. Highly
@@ -552,14 +622,23 @@ Options:
iTerm2 (use with Terminal.app). This is faster
and more reliable than the default AppleScript
interface.
+
--report Options Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary Options Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary Arguments Options Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary Arguments
@@ -74,20 +74,20 @@
--db <Photos database path>¶--db <Photos database path>¶
--db <Photos database path>¶--db <Photos database path>¶
--db <Photos database path>¶--db <Photos database path>¶
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
-V, --verbose¶-V, --verbose¶
Print verbose output.
--keyword <KEYWORD>¶--keyword <KEYWORD>¶
Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword
--person <PERSON>¶--person <PERSON>¶
Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person
--album <ALBUM>¶--album <ALBUM>¶
Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album
--folder <FOLDER>¶--folder <FOLDER>¶
Search for photos in an album in folder FOLDER. If more than one folder, treated as “OR”, e.g. find photos in any FOLDER. Only searches top level folders (e.g. does not look at subfolders)
--uuid <UUID>¶--uuid <UUID>¶
Search for photos with UUID(s).
--uuid-from-file <FILE>¶Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceeded with # are ignored.
+--uuid-from-file <FILE>¶
+Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored.
--title <TITLE>¶--title <TITLE>¶
Search for TITLE in title of photo.
--no-title¶--no-title¶
Search for photos with no title.
--description <DESC>¶--description <DESC>¶
Search for DESC in description of photo.
--no-description¶--no-description¶
Search for photos with no description.
--place <PLACE>¶--place <PLACE>¶
Search for PLACE in photo’s reverse geolocation info
--no-place¶--no-place¶
Search for photos with no associated place name info (no reverse geolocation info)
--label <LABEL>¶--label <LABEL>¶
Search for photos with image classification label LABEL (Photos 5 only). If more than one label, treated as “OR”, e.g. find photos matching any label
--uti <UTI>¶--uti <UTI>¶
Search for photos whose uniform type identifier (UTI) matches UTI
-i, --ignore-case¶-i, --ignore-case¶
Case insensitive search for title, description, place, keyword, person, or album.
--edited¶--edited¶
Search for photos that have been edited.
--external-edit¶--external-edit¶
Search for photos edited in external editor.
--favorite¶--favorite¶
Search for photos marked favorite.
--not-favorite¶--not-favorite¶
Search for photos not marked favorite.
--hidden¶
Search for photos marked hidden.
--not-hidden¶
Search for photos not marked hidden.
--shared¶
Search for photos in shared iCloud album (Photos 5 only).
--not-shared¶
Search for photos not in shared iCloud album (Photos 5 only).
--burst¶--burst¶
Search for photos that were taken in a burst.
--not-burst¶--not-burst¶
Search for photos that are not part of a burst.
--live¶--live¶
Search for Apple live photos
--not-live¶--not-live¶
Search for photos that are not Apple live photos.
--portrait¶--portrait¶
Search for Apple portrait mode photos.
--not-portrait¶--not-portrait¶
Search for photos that are not Apple portrait mode photos.
--screenshot¶--screenshot¶
Search for screenshot photos.
--not-screenshot¶--not-screenshot¶
Search for photos that are not screenshot photos.
--slow-mo¶--slow-mo¶
Search for slow motion videos.
--not-slow-mo¶--not-slow-mo¶
Search for photos that are not slow motion videos.
--time-lapse¶--time-lapse¶
Search for time lapse videos.
--not-time-lapse¶--not-time-lapse¶
Search for photos that are not time lapse videos.
--hdr¶--hdr¶
Search for high dynamic range (HDR) photos.
--not-hdr¶--not-hdr¶
Search for photos that are not HDR photos.
--selfie¶--selfie¶
Search for selfies (photos taken with front-facing cameras).
--not-selfie¶--not-selfie¶
Search for photos that are not selfies.
--panorama¶--panorama¶
Search for panorama photos.
--not-panorama¶--not-panorama¶
Search for photos that are not panoramas.
--has-raw¶--has-raw¶
Search for photos with both a jpeg and raw version
--only-movies¶--only-movies¶
Search only for movies (default searches both images and movies).
--only-photos¶--only-photos¶
Search only for photos/images (default searches both images and movies).
--from-date <from_date>¶--from-date <from_date>¶
Search by start item date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601).
--to-date <to_date>¶--to-date <to_date>¶
Search by end item date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601).
--has-comment¶--has-comment¶
Search for photos that have comments.
--no-comment¶--no-comment¶
Search for photos with no comments.
--has-likes¶--has-likes¶
Search for photos that have likes.
--no-likes¶--no-likes¶
Search for photos with no likes.
--is-reference¶--is-reference¶
Search for photos that were imported as referenced files (not copied into Photos library).
--in-album¶--in-album¶
Search for photos that are in one or more albums.
--not-in-album¶--not-in-album¶
Search for photos that are not in any albums.
--missing¶--missing¶
Export only photos missing from the Photos library; must be used with –download-missing.
--deleted¶--deleted¶
Include photos from the ‘Recently Deleted’ folder.
--deleted-only¶--deleted-only¶
Include only photos from the ‘Recently Deleted’ folder.
--update¶--update¶
Only export new or updated files. See notes below on export and –update.
--ignore-signature¶When used with –update, ignores file signature when updating files. This is useful if you have processed or edited exported photos changing the file signature (size & modification date). In this case, –update would normally re-export the processed files but with –ignore-signature, files which exist in the export directory will not be re-exported.
+--ignore-signature¶
+When used with ‘–update’, ignores file signature when updating files. This is useful if you have processed or edited exported photos changing the file signature (size & modification date). In this case, ‘–update’ would normally re-export the processed files but with ‘–ignore-signature’, files which exist in the export directory will not be re-exported. If used with ‘–sidecar’, ‘–ignore-signature’ has the following behavior: 1) if the metadata (in Photos) that went into the sidecar did not change, the sidecar will not be updated; 2) if the metadata (in Photos) that went into the sidecar did change, a new sidecar is written but a new image file is not; 3) if a sidecar does not exist for the photo, a sidecar will be written whether or not the photo file was written or updated.
--only-new¶--only-new¶
If used with –update, ignores any previously exported files, even if missing from the export folder and only exports new files that haven’t previously been exported.
--dry-run¶--dry-run¶
Dry run (test) the export but don’t actually export any files; most useful with –verbose.
--export-as-hardlink¶--export-as-hardlink¶
Hardlink files instead of copying them. Cannot be used with –exiftool which creates copies of the files with embedded EXIF data. Note: on APFS volumes, files are cloned when exporting giving many of the same advantages as hardlinks without having to use –export-as-hardlink.
--touch-file¶--touch-file¶
Sets the file’s modification time to match photo date.
--overwrite¶--overwrite¶
Overwrite existing files. Default behavior is to add (1), (2), etc to filename if file already exists. Use this with caution as it may create name collisions on export. (e.g. if two files happen to have the same name)
--export-by-date¶--export-by-date¶
Automatically create output folders to organize photos by date created (e.g. DEST/2019/12/20/photoname.jpg).
--skip-edited¶--skip-edited¶
Do not export edited version of photo if an edited version exists.
--skip-original-if-edited¶--skip-original-if-edited¶
Do not export original if there is an edited version (exports only the edited version).
--skip-bursts¶--skip-bursts¶
Do not export all associated burst images in the library if a photo is a burst photo.
--skip-live¶--skip-live¶
Do not export the associated live video component of a live photo.
--skip-raw¶--skip-raw¶
Do not export associated raw images of a RAW+JPEG pair. Note: this does not skip raw photos if the raw photo does not have an associated jpeg image (e.g. the raw file was imported to Photos without a jpeg preview).
--current-name¶--current-name¶
Use photo’s current filename instead of original filename for export. Note: Starting with Photos 5, all photos are renamed upon import. By default, photos are exported with the the original name they had before import.
--convert-to-jpeg¶--convert-to-jpeg¶
Convert all non-jpeg images (e.g. raw, HEIC, PNG, etc) to JPEG upon export. Only works if your Mac has a GPU.
--jpeg-quality <jpeg_quality>¶--jpeg-quality <jpeg_quality>¶
Value in range 0.0 to 1.0 to use with –convert-to-jpeg. A value of 1.0 specifies best quality, a value of 0.0 specifies maximum compression. Defaults to 1.0
--download-missing¶--download-missing¶
Attempt to download missing photos from iCloud. The current implementation uses Applescript to interact with Photos to export the photo which will force Photos to download from iCloud if the photo does not exist on disk. This will be slow and will require internet connection. This obviously only works if the Photos library is synched to iCloud. Note: –download-missing does not currently export all burst images; only the primary photo will be exported–associated burst images will be skipped.
--sidecar <FORMAT>¶--sidecar <FORMAT>¶
Create sidecar for each photo exported; valid FORMAT values: xmp, json, exiftool; –sidecar xmp: create XMP sidecar used by Digikam, Adobe Lightroom, etc. The sidecar file is named in format photoname.ext.xmp The XMP sidecar exports the following tags: Description, Title, Keywords/Tags, Subject (set to Keywords + PersonInImage), PersonInImage, CreateDate, ModifyDate, GPSLongitude, Face Regions (Metadata Working Group and Microsoft Photo). –sidecar json: create JSON sidecar useable by exiftool (https://exiftool.org/) The sidecar file can be used to apply metadata to the file with exiftool, for example: “exiftool -j=photoname.jpg.json photoname.jpg” The sidecar file is named in format photoname.ext.json; format includes tag groups (equivalent to running ‘exiftool -G -j’). -–sidecar exiftool: create JSON sidecar compatible with output of ‘exiftool -j’. Unlike ‘–sidecar json’, ‘–sidecar exiftool’ does not export tag groups. Sidecar filename is in format photoname.ext.json; For a list of tags exported in the JSON and exiftool sidecar, see ‘–exiftool’.
+–sidecar exiftool: create JSON sidecar compatible with output of ‘exiftool -j’. Unlike ‘–sidecar json’, ‘–sidecar exiftool’ does not export tag groups. Sidecar filename is in format photoname.ext.json; For a list of tags exported in the JSON and exiftool sidecar, see ‘–exiftool’. See also ‘–ignore-signature’.xmp|json|exiftool
+xmp | json | exiftool
--sidecar-drop-ext¶--sidecar-drop-ext¶
Drop the photo’s extension when naming sidecar files. By default, sidecar files are named in format ‘photo_filename.photo_ext.sidecar_ext’, e.g. ‘IMG_1234.JPG.xmp’. Use ‘–sidecar-drop-ext’ to ignore the photo extension. Resulting sidecar files will have name in format ‘IMG_1234.xmp’. Warning: this may result in sidecar filename collisions if there are files of different types but the same name in the output directory, e.g. ‘IMG_1234.JPG’ and ‘IMG_1234.MOV’.
--exiftool¶--exiftool¶
Use exiftool to write metadata directly to exported photos. To use this option, exiftool must be installed and in the path. exiftool may be installed from https://exiftool.org/. Cannot be used with –export-as-hardlink. Writes the following metadata: EXIF:ImageDescription, XMP:Description (see also –description-template); XMP:Title; XMP:TagsList, IPTC:Keywords, XMP:Subject (see also –keyword-template, –person-keyword, –album-keyword); XMP:PersonInImage; EXIF:GPSLatitudeRef; EXIF:GPSLongitudeRef; EXIF:GPSLatitude; EXIF:GPSLongitude; EXIF:GPSPosition; EXIF:DateTimeOriginal; EXIF:OffsetTimeOriginal; EXIF:ModifyDate (see –ignore-date-modified); IPTC:DateCreated; IPTC:TimeCreated; (video files only): QuickTime:CreationDate; QuickTime:CreateDate; QuickTime:ModifyDate (see also –ignore-date-modified); QuickTime:GPSCoordinates; UserData:GPSCoordinates.
--exiftool-path <EXIFTOOL_PATH>¶--exiftool-path <EXIFTOOL_PATH>¶
Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.
--exiftool-option <OPTION>¶--exiftool-option <OPTION>¶
Optional flag/option to pass to exiftool when using –exiftool. For example, –exiftool-option ‘-m’ to ignore minor warnings. Specify these as you would on the exiftool command line. See exiftool docs at https://exiftool.org/exiftool_pod.html for full list of options. More than one option may be specified by repeating the option, e.g. –exiftool-option ‘-m’ –exiftool-option ‘-F’.
--exiftool-merge-keywords¶--exiftool-merge-keywords¶
Merge any keywords found in the original file with keywords used for ‘–exiftool’ and ‘–sidecar’.
--exiftool-merge-persons¶--exiftool-merge-persons¶
Merge any persons found in the original file with persons used for ‘–exiftool’ and ‘–sidecar’.
--ignore-date-modified¶--ignore-date-modified¶
If used with –exiftool or –sidecar, will ignore the photo modification date and set EXIF:ModifyDate to EXIF:DateTimeOriginal; this is consistent with how Photos handles the EXIF:ModifyDate tag.
--person-keyword¶--person-keyword¶
Use person in image as keyword/tag when exporting metadata.
--album-keyword¶--album-keyword¶
Use album name as keyword/tag when exporting metadata.
--keyword-template <TEMPLATE>¶For use with –exiftool, –sidecar; specify a template string to use as keyword in the form ‘{name,DEFAULT}’ This is the same format as –directory. For example, if you wanted to add the full path to the folder and album photo is contained in as a keyword when exporting you could specify –keyword-template “{folder_album}” You may specify more than one template, for example –keyword-template “{folder_album}” –keyword-template “{created.year}” See Templating System below.
+--keyword-template <TEMPLATE>¶
+For use with –exiftool, –sidecar; specify a template string to use as keyword in the form ‘{name,DEFAULT}’ This is the same format as –directory. For example, if you wanted to add the full path to the folder and album photo is contained in as a keyword when exporting you could specify –keyword-template “{folder_album}” You may specify more than one template, for example –keyword-template “{folder_album}” –keyword-template “{created.year}”. See ‘–replace-keywords’ and Templating System below.
+--replace-keywords¶Replace keywords with any values specified with –keyword-template. By default, –keyword-template will add keywords to any keywords already associated with the photo. If –replace-keywords is specified, values from –keyword-template will replace any existing keywords instead of adding additional keywords.
--description-template <TEMPLATE>¶--description-template <TEMPLATE>¶
For use with –exiftool, –sidecar; specify a template string to use as description in the form ‘{name,DEFAULT}’ This is the same format as –directory. For example, if you wanted to append ‘exported with osxphotos on [today’s date]’ to the description, you could specify –description-template “{descr} exported with osxphotos on {today.date}” See Templating System below.
--finder-tag-template <TEMPLATE>¶--finder-tag-template <TEMPLATE>¶
Set MacOS Finder tags to TEMPLATE. These tags can be searched in the Finder or Spotlight with ‘tag:tagname’ format. For example, ‘–finder-tag-template “{label}”’ to set Finder tags to photo labels. You may specify multiple TEMPLATE values by using ‘–finder-tag-template’ multiple times. See also ‘–finder-tag-keywords and Extended Attributes below.’.
--finder-tag-keywords¶--finder-tag-keywords¶
Set MacOS Finder tags to keywords; any keywords specified via ‘–keyword-template’, ‘–person-keyword’, etc. will also be used as Finder tags. See also ‘–finder-tag-template and Extended Attributes below.’.
--xattr-template <ATTRIBUTE TEMPLATE>¶--xattr-template <ATTRIBUTE TEMPLATE>¶
Set extended attribute ATTRIBUTE to TEMPLATE value. Valid attributes are: ‘authors’, ‘comment’, ‘copyright’, ‘description’, ‘findercomment’, ‘headline’, ‘keywords’. For example, to set Finder comment to the photo’s title and description: ‘–xattr-template findercomment “{title}; {descr}” See Extended Attributes below for additional details on this option.
--directory <DIRECTORY>¶--directory <DIRECTORY>¶
Optional template for specifying name of output directory in the form ‘{name,DEFAULT}’. See below for additional details on templating system.
--filename <FILENAME>¶--filename <FILENAME>¶
Optional template for specifying name of output file in the form ‘{name,DEFAULT}’. File extension will be added automatically–do not include an extension in the FILENAME template. See below for additional details on templating system.
--jpeg-ext <EXTENSION>¶--jpeg-ext <EXTENSION>¶
Specify file extension for JPEG files. Photos uses .jpeg for edited images but many images are imported with .jpg or .JPG which can result in multiple different extensions used for JPEG files upon export. Use –jpeg-ext to specify a single extension to use for all exported JPEG images. Valid values are jpeg, jpg, JPEG, JPG; e.g. ‘–jpeg-ext jpg’ to use ‘.jpg’ for all JPEGs.
jpeg|jpg|JPEG|JPG
+jpeg | jpg | JPEG | JPG
--strip¶--strip¶
Optionally strip leading and trailing whitespace from any rendered templates. For example, if –filename template is “{title,} {original_name}” and image has no title, resulting file would have a leading space but if used with –strip, this will be removed.
--edited-suffix <SUFFIX>¶--edited-suffix <SUFFIX>¶
Optional suffix template for naming edited photos. Default name for edited photos is in form ‘photoname_edited.ext’. For example, with ‘–edited-suffix _bearbeiten’, the edited photo would be named ‘photoname_bearbeiten.ext’. The default suffix is ‘_edited’. Multi-value templates (see Templating System) are not permitted with –edited-suffix.
--original-suffix <SUFFIX>¶--original-suffix <SUFFIX>¶
Optional suffix template for naming original photos. Default name for original photos is in form ‘filename.ext’. For example, with ‘–original-suffix _original’, the original photo would be named ‘filename_original.ext’. The default suffix is ‘’ (no suffix). Multi-value templates (see Templating System) are not permitted with –original-suffix.
--use-photos-export¶--use-photos-export¶
Force the use of AppleScript or PhotoKit to export even if not missing (see also ‘–download-missing’ and ‘–use-photokit’).
--use-photokit¶--use-photokit¶
Use with ‘–download-missing’ or ‘–use-photos-export’ to use direct Photos interface instead of AppleScript to export. Highly experimental alpha feature; does not work with iTerm2 (use with Terminal.app). This is faster and more reliable than the default AppleScript interface.
--report <path to export report>¶--report <path to export report>¶
Write a CSV formatted report of all files that were exported.
--cleanup¶Cleanup export directory by deleting any files which were not included in this export set. For example, photos which had previously been exported and were subsequently deleted in Photos.
+--cleanup¶
+Cleanup export directory by deleting any files which were not included in this export set. For example, photos which had previously been exported and were subsequently deleted in Photos. WARNING: –cleanup will delete any files in the export directory that were not exported by osxphotos, for example, your own scripts or other files. Be sure this is what you intend before using –cleanup. Use –dry-run with –cleanup first if you’re not certain.
--exportdb <EXPORTDB_FILE>¶--exportdb <EXPORTDB_FILE>¶
Specify alternate name for database file which stores state information for export and –update. If –exportdb is not specified, export database will be saved to ‘.osxphotos_export.db’ in the export directory. Must be specified as filename only, not a path, as export database will be saved in export directory.
--load-config <config file path>¶--load-config <config file path>¶
Load options from file as written with –save-config. This allows you to save a complex export command to file for later reuse. For example: ‘osxphotos export <lots of options here> –save-config osxphotos.toml’ then ‘osxphotos export /path/to/export –load-config osxphotos.toml’. If any other command line options are used in conjunction with –load-config, they will override the corresponding values in the config file.
--save-config <config file path>¶--save-config <config file path>¶
Save options to file for use with –load-config. File format is TOML.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
DEST¶DEST¶
Required argument
Arguments
TOPIC¶TOPIC¶
Optional argument
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
Options
--json¶--json¶
Print output in JSON format.
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
Options
--db <Photos database path>¶--db <Photos database path>¶
Specify Photos database path. Path to Photos library/database can be specified using either –db or directly as PHOTOS_LIBRARY positional argument. If neither –db or PHOTOS_LIBRARY provided, will attempt to find the library to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary
--json¶--json¶
Print output in JSON format.
--keyword <KEYWORD>¶--keyword <KEYWORD>¶
Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword
--person <PERSON>¶--person <PERSON>¶
Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person
--album <ALBUM>¶--album <ALBUM>¶
Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album
--folder <FOLDER>¶--folder <FOLDER>¶
Search for photos in an album in folder FOLDER. If more than one folder, treated as “OR”, e.g. find photos in any FOLDER. Only searches top level folders (e.g. does not look at subfolders)
--uuid <UUID>¶--uuid <UUID>¶
Search for photos with UUID(s).
--uuid-from-file <FILE>¶Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceeded with # are ignored.
+--uuid-from-file <FILE>¶
+Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored.
--title <TITLE>¶--title <TITLE>¶
Search for TITLE in title of photo.
--no-title¶--no-title¶
Search for photos with no title.
--description <DESC>¶--description <DESC>¶
Search for DESC in description of photo.
--no-description¶--no-description¶
Search for photos with no description.
--place <PLACE>¶--place <PLACE>¶
Search for PLACE in photo’s reverse geolocation info
--no-place¶--no-place¶
Search for photos with no associated place name info (no reverse geolocation info)
--label <LABEL>¶--label <LABEL>¶
Search for photos with image classification label LABEL (Photos 5 only). If more than one label, treated as “OR”, e.g. find photos matching any label
--uti <UTI>¶--uti <UTI>¶
Search for photos whose uniform type identifier (UTI) matches UTI
-i, --ignore-case¶-i, --ignore-case¶
Case insensitive search for title, description, place, keyword, person, or album.
--edited¶--edited¶
Search for photos that have been edited.
--external-edit¶--external-edit¶
Search for photos edited in external editor.
--favorite¶--favorite¶
Search for photos marked favorite.
--not-favorite¶--not-favorite¶
Search for photos not marked favorite.
--hidden¶
Search for photos marked hidden.
--not-hidden¶
Search for photos not marked hidden.
--shared¶
Search for photos in shared iCloud album (Photos 5 only).
--not-shared¶
Search for photos not in shared iCloud album (Photos 5 only).
--burst¶--burst¶
Search for photos that were taken in a burst.
--not-burst¶--not-burst¶
Search for photos that are not part of a burst.
--live¶--live¶
Search for Apple live photos
--not-live¶--not-live¶
Search for photos that are not Apple live photos.
--portrait¶--portrait¶
Search for Apple portrait mode photos.
--not-portrait¶--not-portrait¶
Search for photos that are not Apple portrait mode photos.
--screenshot¶--screenshot¶
Search for screenshot photos.
--not-screenshot¶--not-screenshot¶
Search for photos that are not screenshot photos.
--slow-mo¶--slow-mo¶
Search for slow motion videos.
--not-slow-mo¶--not-slow-mo¶
Search for photos that are not slow motion videos.
--time-lapse¶--time-lapse¶
Search for time lapse videos.
--not-time-lapse¶--not-time-lapse¶
Search for photos that are not time lapse videos.
--hdr¶--hdr¶
Search for high dynamic range (HDR) photos.
--not-hdr¶--not-hdr¶
Search for photos that are not HDR photos.
--selfie¶--selfie¶
Search for selfies (photos taken with front-facing cameras).
--not-selfie¶--not-selfie¶
Search for photos that are not selfies.
--panorama¶--panorama¶
Search for panorama photos.
--not-panorama¶--not-panorama¶
Search for photos that are not panoramas.
--has-raw¶--has-raw¶
Search for photos with both a jpeg and raw version
--only-movies¶--only-movies¶
Search only for movies (default searches both images and movies).
--only-photos¶--only-photos¶
Search only for photos/images (default searches both images and movies).
--from-date <from_date>¶--from-date <from_date>¶
Search by start item date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601).
--to-date <to_date>¶--to-date <to_date>¶
Search by end item date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601).
--has-comment¶--has-comment¶
Search for photos that have comments.
--no-comment¶--no-comment¶
Search for photos with no comments.
--has-likes¶--has-likes¶
Search for photos that have likes.
--no-likes¶--no-likes¶
Search for photos with no likes.
--is-reference¶--is-reference¶
Search for photos that were imported as referenced files (not copied into Photos library).
--in-album¶--in-album¶
Search for photos that are in one or more albums.
--not-in-album¶--not-in-album¶
Search for photos that are not in any albums.
--deleted¶--deleted¶
Include photos from the ‘Recently Deleted’ folder.
--deleted-only¶--deleted-only¶
Include only photos from the ‘Recently Deleted’ folder.
--missing¶--missing¶
Search for photos missing from disk.
--not-missing¶--not-missing¶
Search for photos present on disk (e.g. not missing).
--cloudasset¶--cloudasset¶
Search for photos that are part of an iCloud library
--not-cloudasset¶--not-cloudasset¶
Search for photos that are not part of an iCloud library
--incloud¶--incloud¶
Search for photos that are in iCloud (have been synched)
--not-incloud¶--not-incloud¶
Search for photos that are not in iCloud (have not been synched)
Arguments
PHOTOS_LIBRARY¶PHOTOS_LIBRARY¶
Optional argument(s)
|
Sphinx 3.4.3
+ Powered by Sphinx 3.5.2
& Alabaster 0.7.12
|
diff --git a/docs/modules.html b/docs/modules.html
index 557e7110..21579826 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -5,7 +5,7 @@
- |