a9843ac60e
* Updated ExportResults docstrings so Sphinx picks them up * Updated API_README so link works in docs * Removed sweep templates
5171 lines
428 KiB
HTML
5171 lines
428 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="OSXPhotos Template System" href="template_help.html" /><link rel="prev" title="OSXPhotos Tutorial" href="tutorial.html" />
|
||
|
||
<meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
|
||
<title>OSXPhotos Command Line Interface (CLI) - osxphotos 0.62.1 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
|
||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">osxphotos 0.62.1 documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
|
||
|
||
<span class="sidebar-brand-text">osxphotos 0.62.1 documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="overview.html">OSXPhotos</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">OSXPhotos Tutorial</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">OSXPhotos Command Line Interface (CLI)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="template_help.html">OSXPhotos Template System</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="package_overview.html">OSXPhotos Python Package Overview</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="API_README.html">OSXPhotos Python API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="reference.html">OSXPhotos Python Reference</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container">
|
||
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<section id="osxphotos-command-line-interface-cli">
|
||
<h1>OSXPhotos Command Line Interface (CLI)<a class="headerlink" href="#osxphotos-command-line-interface-cli" title="Permalink to this heading">#</a></h1>
|
||
<section id="osxphotos">
|
||
<h2>osxphotos<a class="headerlink" href="#osxphotos" title="Permalink to this heading">#</a></h2>
|
||
<p>osxphotos: the multi-tool for your Photos library</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-v">
|
||
<span id="cmdoption-osxphotos-version"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-v" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Show the version and exit.</p>
|
||
</dd></dl>
|
||
|
||
<section id="osxphotos-about">
|
||
<h3>about<a class="headerlink" href="#osxphotos-about" title="Permalink to this heading">#</a></h3>
|
||
<p>Print information about osxphotos including license.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos about <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="osxphotos-add-locations">
|
||
<h3>add-locations<a class="headerlink" href="#osxphotos-add-locations" title="Permalink to this heading">#</a></h3>
|
||
<p>Add missing location data to photos in Photos.app using nearest neighbor.</p>
|
||
<p>This command will search for photos that are missing location data and look
|
||
for the nearest neighbor photo within a given window of time that contains
|
||
location information. If a photo is found within the window of time, the
|
||
location of the nearest neighbor will be used to update the location of the
|
||
photo.</p>
|
||
<p>For example, if you took pictures with your iPhone and also with a camera that
|
||
doesn’t have location information, you can use this command to add location
|
||
information to the photos taken with the camera from those taken with the
|
||
iPhone.</p>
|
||
<p>If you have many photos with missing location information but no nearest neighbor
|
||
within the window of time, you could add location information to some photos manually
|
||
then run this command again to add location information to the remaining photos.</p>
|
||
<p>You can specify a subset of photos to update using the query options. For example,
|
||
<cite>–selected</cite> to update only the selected photos, <cite>–added-after 2020-01-01</cite> to update
|
||
only photos added after Jan 1, 2020, etc.</p>
|
||
<p>Example:</p>
|
||
<p>Add location data to all photos with missing location data within a ±2 hour window:</p>
|
||
<p><cite>osxphotos add-locations –window “2 hr” –verbose</cite></p>
|
||
<p>The add-locations command assumes that photos already have the correct date and time.
|
||
If you have photos that are missing both location data and date/time information,
|
||
you can use <cite>osxphotos timewarp</cite> to add date/time information to the photos and then
|
||
use <cite>osxphotos add-locations</cite> to add location information.
|
||
See <cite>osxphotos help timewarp</cite> for more information.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos add-locations <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-w">
|
||
<span id="cmdoption-osxphotos-add-locations-window"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--window</span></span><span class="sig-prename descclassname"> <span class="pre"><window></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-w" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Window of time to search for nearest neighbor; searches +/- window of time. Default is 1 hour. Format is one of ‘HH:MM:SS’, ‘D days’, ‘H hours’ (or hr), ‘M minutes’ (or min), ‘S seconds’ (or sec), ‘S’ (where S is seconds).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Don’t actually add location, just print what would be done. Most useful with –verbose.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-V">
|
||
<span id="cmdoption-osxphotos-add-locations-v"></span><span id="cmdoption-osxphotos-add-locations-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-keyword">
|
||
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no keyword.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-person">
|
||
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre"><PERSON></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-album">
|
||
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-folder">
|
||
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre"><FOLDER></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-name">
|
||
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with filename matching FILENAME. If more than one –name options is specified, they are treated as “OR”, e.g. find photos matching any FILENAME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uuid">
|
||
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is ‘-’, read UUIDs from stdin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for TITLE in title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-title">
|
||
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no title.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESC></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for DESC in description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-description">
|
||
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no description.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-place">
|
||
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre"><PLACE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for PLACE in photo’s reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-place">
|
||
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-location">
|
||
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-label">
|
||
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre"><LABEL></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-uti">
|
||
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre"><UTI></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-i">
|
||
<span id="cmdoption-osxphotos-add-locations-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Case insensitive search for title, description, place, keyword, person, or album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-edited">
|
||
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-edited">
|
||
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-external-edit">
|
||
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-external-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos edited in external editor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-favorite">
|
||
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-favorite">
|
||
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-hidden">
|
||
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-hidden">
|
||
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared">
|
||
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared">
|
||
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-burst">
|
||
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were taken in a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-burst">
|
||
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-live">
|
||
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple live photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-live">
|
||
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple live photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-portrait">
|
||
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-portrait">
|
||
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-hdr">
|
||
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for high dynamic range (HDR) photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-hdr">
|
||
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not HDR photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-selfie">
|
||
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-selfie">
|
||
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not selfies.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-panorama">
|
||
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for panorama photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-panorama">
|
||
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not panoramas.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-raw">
|
||
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with both a jpeg and raw version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-only-movies">
|
||
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-only-movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for movies (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-only-photos">
|
||
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-only-photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for photos/images (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-from-date">
|
||
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre"><from_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-from-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-to-date">
|
||
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre"><to_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-to-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-from-time">
|
||
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre"><from_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-from-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start time of day, e.g. 12:00, or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-to-time">
|
||
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre"><to_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-to-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end time of day, e.g. 12:00 or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-year">
|
||
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre"><YEAR></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items from a specific year, e.g. –year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-before">
|
||
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-before" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library before a specific date/time, e.g. –added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-after">
|
||
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-after" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the libray after a specific date/time, e.g. –added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-added-in-last">
|
||
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME_DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-added-in-last" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like ‘12 hrs’, ‘1 day’, ‘1d’, ‘1 week’, ‘2weeks’, ‘1 month’, ‘1 year’. for example, <cite>–added-in-last 7d</cite> and <cite>–added-in-last ‘1 week’</cite> are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-comment">
|
||
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-comment">
|
||
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-has-likes">
|
||
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-has-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-no-likes">
|
||
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-no-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-is-reference">
|
||
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-is-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-reference">
|
||
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-in-album">
|
||
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in one or more albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-in-album">
|
||
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in any albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-duplicate">
|
||
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-min-size">
|
||
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-min-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size >= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-max-size">
|
||
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-max-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size <= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-missing">
|
||
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos missing from disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-missing">
|
||
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos present on disk (e.g. not missing).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-incloud">
|
||
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in iCloud (have been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-incloud">
|
||
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have not saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-not-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-not-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-regex">
|
||
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre"><REGEX</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with ‘Beach’: ‘–regex “^Beach” “{album}”’. You may specify more than one regular expression match by repeating ‘–regex’ with different arguments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-selected">
|
||
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter for photos that are currently selected in Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-exif">
|
||
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIF_TAG</span> <span class="pre">VALUE></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where EXIF_TAG exists in photo’s EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: <cite>–exif Software ‘Adobe Photoshop’ `or to find all photos shot on a Canon camera: `–exif Make Canon</cite>. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. <cite>EXIF:Make</cite> or <cite>Make</cite>. To use –exif, exiftool must be installed and in the path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-query-eval">
|
||
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre"><CRITERIA></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-query-eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: <cite>photos = [photo for photo in photos if CRITERIA]</cite> where photo represents a PhotoInfo object. For example: <cite>–query-eval photo.favorite</cite> returns all photos that have been favorited and is equivalent to –favorite. You may specify more than one CRITERIA by using –query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-query-function">
|
||
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-query-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function to filter photos. Use this in format: –query-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the –query-function option with a different value. Your query function will be called after all other query options have been evaluated. See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-add-locations-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-add-locations-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-albums">
|
||
<h3>albums<a class="headerlink" href="#osxphotos-albums" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out albums found in the Photos library.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos albums <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-library">
|
||
<span id="cmdoption-osxphotos-albums-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-albums-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-albums-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-albums-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-albums-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-albums-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-batch-edit">
|
||
<h3>batch-edit<a class="headerlink" href="#osxphotos-batch-edit" title="Permalink to this heading">#</a></h3>
|
||
<p>Batch edit photo metadata such as title, description, keywords, etc.
|
||
Operates on currently selected photos.</p>
|
||
<p>Select one or more photos in Photos then run this command to edit the metadata.</p>
|
||
<p>For example:</p>
|
||
<div class="line-block">
|
||
<div class="line">osxphotos batch-edit </div>
|
||
<div class="line">–verbose </div>
|
||
<div class="line">–title “California vacation 2023 {created.year}-{created.dd}-{created.mm} {counter:03d}” </div>
|
||
<div class="line">–description “{place.name}” </div>
|
||
<div class="line">–keyword “Family” –keyword “Travel”</div>
|
||
</div>
|
||
<p>This will set the title to “California vacation 2023 2023-02-20 001”, and so on,
|
||
the description to the reverse geolocation place name,
|
||
and add the keywords “Family” and “Travel”.</p>
|
||
<p>–title, –description, and –keyword may be any valid template string.
|
||
See <a class="reference external" href="https://rhettbull.github.io/osxphotos/template_help.html">https://rhettbull.github.io/osxphotos/template_help.html</a>
|
||
or <cite>osxphotos docs</cite> for more information on the osxphotos template system.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos batch-edit <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESCRIPTION_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add keywords to photo. May be specified multiple times.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-replace-keywords">
|
||
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-replace-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When specified with –keyword, replace existing keywords. Default is to add to existing keywords.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"> <span class="pre"><LATITUDE</span> <span class="pre">LONGITUDE></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set location of photo. Must be specified as a pair of numbers with latitude in the range -90 to 90 and longitude in the range -180 to 180.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Don’t actually change anything.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-undo">
|
||
<span class="sig-name descname"><span class="pre">--undo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-undo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Restores photo metadata to what it was prior to the last batch edit. May be combined with –dry-run.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-V">
|
||
<span id="cmdoption-osxphotos-batch-edit-v"></span><span id="cmdoption-osxphotos-batch-edit-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-batch-edit-library">
|
||
<span id="cmdoption-osxphotos-batch-edit-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-batch-edit-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-diff">
|
||
<h3>diff<a class="headerlink" href="#osxphotos-diff" title="Permalink to this heading">#</a></h3>
|
||
<p>Compare two Photos databases and print out differences</p>
|
||
<p>To use the diff command, you’ll need to install sqldiff via homebrew:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Install homebrew (<a class="reference external" href="https://brew.sh/">https://brew.sh/</a>) if not already installed</p></li>
|
||
<li><p>Install sqldiff: <cite>brew install sqldiff</cite></p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<p>When run with no arguments, compares the current Photos library to the
|
||
most recent snapshot in the the OSXPHOTOS_SNAPSHOT directory.</p>
|
||
<p>If run with the –db option, compares the library specified by –db to the
|
||
most recent snapshot in the the OSXPHOTOS_SNAPSHOT directory.</p>
|
||
<p>If run with just the DB2 argument, compares the current Photos library to
|
||
the database specified by the DB2 argument.</p>
|
||
<p>If run with both the –db option and the DB2 argument, compares the
|
||
library specified by –db to the database specified by DB2</p>
|
||
<p>See also <cite>osxphotos snap</cite></p>
|
||
<p>If the OSXPHOTOS_SNAPSHOT environment variable is not set, will use
|
||
‘/private/tmp/osxphotos_snapshots’</p>
|
||
<p>Works only on Photos library versions since Catalina (10.15) or newer.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos diff <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>DB2<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-library">
|
||
<span id="cmdoption-osxphotos-diff-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-diff-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-r">
|
||
<span id="cmdoption-osxphotos-diff-raw-output"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--raw-output</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-diff-r" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print raw output (don’t use syntax highlighting).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-s">
|
||
<span id="cmdoption-osxphotos-diff-style"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--style</span></span><span class="sig-prename descclassname"> <span class="pre"><STYLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-diff-s" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify style/theme for syntax highlighting. Theme may be any valid pygments style (<a class="reference external" href="https://pygments.org/styles/">https://pygments.org/styles/</a>). Default is ‘monokai’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-V">
|
||
<span id="cmdoption-osxphotos-diff-v"></span><span id="cmdoption-osxphotos-diff-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-diff-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-diff-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-diff-arg-DB2">
|
||
<span id="cmdoption-osxphotos-diff-arg-db2"></span><span class="sig-name descname"><span class="pre">DB2</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-diff-arg-DB2" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-docs">
|
||
<h3>docs<a class="headerlink" href="#osxphotos-docs" title="Permalink to this heading">#</a></h3>
|
||
<p>Open osxphotos documentation in your browser.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos docs <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="osxphotos-dump">
|
||
<h3>dump<a class="headerlink" href="#osxphotos-dump" title="Permalink to this heading">#</a></h3>
|
||
<p>Print list of all photos & associated info from the Photos library.</p>
|
||
<p>NOTE: dump is DEPRECATED and will be removed in a future release.
|
||
Use <cite>osxphotos query</cite> instead.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos dump <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-library">
|
||
<span id="cmdoption-osxphotos-dump-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-deleted-only">
|
||
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-deleted-only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include only photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-deleted">
|
||
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-deleted" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-f">
|
||
<span id="cmdoption-osxphotos-dump-field"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--field</span></span><span class="sig-prename descclassname"> <span class="pre"><FIELD</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-f" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Output only specified custom fields. FIELD is the name of the field and TEMPLATE is the template to use as the field value. May be repeated to output multiple fields. For example, to output photo uuid, name, and title: <cite>–field uuid “{uuid}” –field name “{original_name}” –field title “{title}”</cite>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-print">
|
||
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-dump-print" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Render TEMPLATE string for each photo queried and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. If –print TEMPLATE is provided, regular output is suppressed and only the rendered TEMPLATE values are printed. May be repeated to print multiple template strings.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-dump-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-dump-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-dump-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-exiftool">
|
||
<h3>exiftool<a class="headerlink" href="#osxphotos-exiftool" title="Permalink to this heading">#</a></h3>
|
||
<p>Run exiftool on previously exported files to update metadata.</p>
|
||
<p>If you previously exported photos with <cite>osxphotos export</cite> but did not include the
|
||
<cite>–exiftool</cite> option and you now want to update the metadata of the exported files with
|
||
exiftool, you can use this command to do so.</p>
|
||
<p>If you simply re-run the <cite>osxphotos export</cite> with <cite>–update</cite> and <cite>–exiftool</cite>, osxphotos will
|
||
re-export all photos because it will detect that the previously exported photos do not have the
|
||
exiftool metadata updates. This command will run exiftool on the previously exported photos
|
||
to update all metadata then will update the export database so that using <cite>–exiftool –update</cite>
|
||
with <cite>osxphotos export</cite> in the future will work correctly and not unnecessarily re-export photos.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos exiftool <span class="o">[</span>OPTIONS<span class="o">]</span> EXPORT_DIRECTORY
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-db-config">
|
||
<span class="sig-name descname"><span class="pre">--db-config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-db-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Load configuration options from the export database to match the last export; If any other command line options are used in conjunction with –db-config, they will override the corresponding values loaded from the export database; see also –load-config.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-load-config">
|
||
<span class="sig-name descname"><span class="pre">--load-config</span></span><span class="sig-prename descclassname"> <span class="pre"><CONFIG_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-load-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Load options from file as written with –save-config. If any other command line options are used in conjunction with –load-config, they will override the corresponding values in the config file; see also –db-config.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-save-config">
|
||
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre"><CONFIG_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-save-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Save options to file for use with –load-config. File format is TOML.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-path">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIFTOOL_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-path" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-option">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-option</span></span><span class="sig-prename descclassname"> <span class="pre"><OPTION></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-option" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 <a class="reference external" href="https://exiftool.org/exiftool_pod.html">https://exiftool.org/exiftool_pod.html</a> for full list of options. More than one option may be specified by repeating the option, e.g. –exiftool-option ‘-m’ –exiftool-option ‘-F’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-merge-keywords">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-merge-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Merge any keywords found in the original file with keywords used for ‘–exiftool’ and ‘–sidecar’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exiftool-merge-persons">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-merge-persons</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exiftool-merge-persons" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Merge any persons found in the original file with persons used for ‘–exiftool’ and ‘–sidecar’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-ignore-date-modified">
|
||
<span class="sig-name descname"><span class="pre">--ignore-date-modified</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-ignore-date-modified" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-person-keyword">
|
||
<span class="sig-name descname"><span class="pre">--person-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-person-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use person in image as keyword/tag when exporting metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-album-keyword">
|
||
<span class="sig-name descname"><span class="pre">--album-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-album-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use album name as keyword/tag when exporting metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-keyword-template">
|
||
<span class="sig-name descname"><span class="pre">--keyword-template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-keyword-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-replace-keywords">
|
||
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-replace-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-description-template">
|
||
<span class="sig-name descname"><span class="pre">--description-template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-description-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-exportdb">
|
||
<span class="sig-name descname"><span class="pre">--exportdb</span></span><span class="sig-prename descclassname"> <span class="pre"><exportdb></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-exportdb" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional path to export database (if not in the default location in the export directory).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-report">
|
||
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre"><REPORT_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-report" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Write a report of all files that were exported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Templating System), for example, –report ‘export_{today.date}.csv’ will write a CSV report file named with today’s date. See also –append.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-append">
|
||
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-append" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If used with –report, add data to existing report file instead of overwriting it. See also –report.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-V">
|
||
<span id="cmdoption-osxphotos-exiftool-v"></span><span id="cmdoption-osxphotos-exiftool-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run in dry-run mode (don’t actually update files), e.g. for use with –update-signatures.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-library">
|
||
<span id="cmdoption-osxphotos-exiftool-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exiftool-arg-EXPORT_DIRECTORY">
|
||
<span id="cmdoption-osxphotos-exiftool-arg-export-directory"></span><span class="sig-name descname"><span class="pre">EXPORT_DIRECTORY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exiftool-arg-EXPORT_DIRECTORY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-export">
|
||
<h3>export<a class="headerlink" href="#osxphotos-export" title="Permalink to this heading">#</a></h3>
|
||
<p>Export photos from the Photos database.
|
||
Export path DEST is required.</p>
|
||
<p>Optionally, query the Photos database using 1 or more search options;
|
||
if more than one different option is provided, they are treated as “AND”
|
||
(e.g. search for photos matching all options).
|
||
If the same query option is provided multiple times, they are treated as
|
||
“OR” (e.g. search for photos matching any of the options).
|
||
If no query options are provided, all photos will be exported.</p>
|
||
<p>For example, adding the query options:</p>
|
||
<p>–person “John Doe” –person “Jane Doe” –keyword “vacation”</p>
|
||
<p>will export all photos with either person of (“John Doe” OR “Jane Doe”) AND keyword of “vacation”</p>
|
||
<p>By default, all versions of all photos will be exported including edited
|
||
versions, live photo movies, burst photos, and associated raw images.
|
||
See –skip-edited, –skip-live, –skip-bursts, and –skip-raw options
|
||
to modify this behavior.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos <span class="nb">export</span> <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>... DEST
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-library">
|
||
<span id="cmdoption-osxphotos-export-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-V">
|
||
<span id="cmdoption-osxphotos-export-v"></span><span id="cmdoption-osxphotos-export-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-progress">
|
||
<span class="sig-name descname"><span class="pre">--no-progress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-progress" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not display progress bar during export.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-keyword">
|
||
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no keyword.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-person">
|
||
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre"><PERSON></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-album">
|
||
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-folder">
|
||
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre"><FOLDER></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-name">
|
||
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with filename matching FILENAME. If more than one –name options is specified, they are treated as “OR”, e.g. find photos matching any FILENAME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uuid">
|
||
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is ‘-’, read UUIDs from stdin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for TITLE in title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-title">
|
||
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no title.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESC></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for DESC in description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-description">
|
||
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no description.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-place">
|
||
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre"><PLACE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for PLACE in photo’s reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-place">
|
||
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-location">
|
||
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-label">
|
||
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre"><LABEL></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-uti">
|
||
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre"><UTI></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-i">
|
||
<span id="cmdoption-osxphotos-export-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Case insensitive search for title, description, place, keyword, person, or album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-edited">
|
||
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-edited">
|
||
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-external-edit">
|
||
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-external-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos edited in external editor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-favorite">
|
||
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-favorite">
|
||
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-hidden">
|
||
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-hidden">
|
||
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared">
|
||
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared">
|
||
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-burst">
|
||
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were taken in a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-burst">
|
||
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-live">
|
||
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple live photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-live">
|
||
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple live photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-portrait">
|
||
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-portrait">
|
||
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-hdr">
|
||
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for high dynamic range (HDR) photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-hdr">
|
||
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not HDR photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-selfie">
|
||
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-selfie">
|
||
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not selfies.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-panorama">
|
||
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for panorama photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-panorama">
|
||
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not panoramas.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-raw">
|
||
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with both a jpeg and raw version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-movies">
|
||
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for movies (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-photos">
|
||
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for photos/images (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-from-date">
|
||
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre"><from_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-from-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-to-date">
|
||
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre"><to_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-to-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-from-time">
|
||
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre"><from_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-from-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start time of day, e.g. 12:00, or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-to-time">
|
||
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre"><to_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-to-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end time of day, e.g. 12:00 or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-year">
|
||
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre"><YEAR></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items from a specific year, e.g. –year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-before">
|
||
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-before" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library before a specific date/time, e.g. –added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-after">
|
||
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-after" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the libray after a specific date/time, e.g. –added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-added-in-last">
|
||
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME_DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-added-in-last" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like ‘12 hrs’, ‘1 day’, ‘1d’, ‘1 week’, ‘2weeks’, ‘1 month’, ‘1 year’. for example, <cite>–added-in-last 7d</cite> and <cite>–added-in-last ‘1 week’</cite> are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-comment">
|
||
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-comment">
|
||
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-has-likes">
|
||
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-has-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-no-likes">
|
||
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-no-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-is-reference">
|
||
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-is-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-reference">
|
||
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-in-album">
|
||
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in one or more albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-in-album">
|
||
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in any albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-duplicate">
|
||
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-min-size">
|
||
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-min-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size >= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-max-size">
|
||
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-max-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size <= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-missing">
|
||
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos missing from disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-missing">
|
||
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos present on disk (e.g. not missing).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-incloud">
|
||
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in iCloud (have been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-incloud">
|
||
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have not saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-not-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-not-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-regex">
|
||
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre"><REGEX</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with ‘Beach’: ‘–regex “^Beach” “{album}”’. You may specify more than one regular expression match by repeating ‘–regex’ with different arguments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-selected">
|
||
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter for photos that are currently selected in Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exif">
|
||
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIF_TAG</span> <span class="pre">VALUE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where EXIF_TAG exists in photo’s EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: <cite>–exif Software ‘Adobe Photoshop’ `or to find all photos shot on a Canon camera: `–exif Make Canon</cite>. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. <cite>EXIF:Make</cite> or <cite>Make</cite>. To use –exif, exiftool must be installed and in the path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-query-eval">
|
||
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre"><CRITERIA></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-query-eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: <cite>photos = [photo for photo in photos if CRITERIA]</cite> where photo represents a PhotoInfo object. For example: <cite>–query-eval photo.favorite</cite> returns all photos that have been favorited and is equivalent to –favorite. You may specify more than one CRITERIA by using –query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-query-function">
|
||
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-query-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function to filter photos. Use this in format: –query-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the –query-function option with a different value. Your query function will be called after all other query options have been evaluated. See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-deleted-only">
|
||
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-deleted-only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include only photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-deleted">
|
||
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-deleted" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-update">
|
||
<span class="sig-name descname"><span class="pre">--update</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-update" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Only export new or updated files. See also –force-update and notes below on export and –update.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-force-update">
|
||
<span class="sig-name descname"><span class="pre">--force-update</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-force-update" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Only export new or updated files. Unlike –update, –force-update will re-export photos if their metadata has changed even if this would not otherwise trigger an export. See also –update and notes below on export and –update.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-update-errors">
|
||
<span class="sig-name descname"><span class="pre">--update-errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-update-errors" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Update files that were previously exported but produced errors during export. For example, if a file produced an error with –exiftool due to bad metadata, this option will re-export the file and attempt to write the metadata again when used with –exiftool and –update. Without –update-errors, photos that were successfully exported but generated an error or warning during export will not be re-attempted if metadata has not changed. Must be used with –update.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ignore-signature">
|
||
<span class="sig-name descname"><span class="pre">--ignore-signature</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ignore-signature" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-only-new">
|
||
<span class="sig-name descname"><span class="pre">--only-new</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-only-new" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-limit">
|
||
<span class="sig-name descname"><span class="pre">--limit</span></span><span class="sig-prename descclassname"> <span class="pre"><LIMIT></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-limit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export at most LIMIT photos. Useful for testing. May be used with –update to export incrementally.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dry run (test) the export but don’t actually export any files; most useful with –verbose.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-as-hardlink">
|
||
<span class="sig-name descname"><span class="pre">--export-as-hardlink</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-as-hardlink" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-touch-file">
|
||
<span class="sig-name descname"><span class="pre">--touch-file</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-touch-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Sets the file’s modification time to match photo date.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-overwrite">
|
||
<span class="sig-name descname"><span class="pre">--overwrite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-overwrite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-retry">
|
||
<span class="sig-name descname"><span class="pre">--retry</span></span><span class="sig-prename descclassname"> <span class="pre"><RETRY></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-retry" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Automatically retry export up to RETRY times if an error occurs during export. This may be useful with network drives that experience intermittent errors.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-by-date">
|
||
<span class="sig-name descname"><span class="pre">--export-by-date</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-by-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Automatically create output folders to organize photos by date created (e.g. DEST/2019/12/20/photoname.jpg).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-edited">
|
||
<span class="sig-name descname"><span class="pre">--skip-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not export edited version of photo if an edited version exists.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-original-if-edited">
|
||
<span class="sig-name descname"><span class="pre">--skip-original-if-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-original-if-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not export original if there is an edited version (exports only the edited version).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-bursts">
|
||
<span class="sig-name descname"><span class="pre">--skip-bursts</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-bursts" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not export all associated burst images in the library if a photo is a burst photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-live">
|
||
<span class="sig-name descname"><span class="pre">--skip-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not export the associated live video component of a live photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-raw">
|
||
<span class="sig-name descname"><span class="pre">--skip-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not export associated RAW image 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).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-uuid">
|
||
<span class="sig-name descname"><span class="pre">--skip-uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Skip photos with UUID(s) during export. May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-skip-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--skip-uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-skip-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Skip photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-current-name">
|
||
<span class="sig-name descname"><span class="pre">--current-name</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-current-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-convert-to-jpeg">
|
||
<span class="sig-name descname"><span class="pre">--convert-to-jpeg</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-convert-to-jpeg" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Convert all non-JPEG images (e.g. RAW, HEIC, PNG, etc) to JPEG upon export. Note: does not convert the RAW component of a RAW+JPEG pair as the associated JPEG image will be exported. You can use –skip-raw to skip exporting the associated RAW image of a RAW+JPEG pair. See also –jpeg-quality and –jpeg-ext. Only works if your Mac has a GPU (thus may not work on virtual machines).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-jpeg-quality">
|
||
<span class="sig-name descname"><span class="pre">--jpeg-quality</span></span><span class="sig-prename descclassname"> <span class="pre"><jpeg_quality></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-jpeg-quality" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview">
|
||
<span class="sig-name descname"><span class="pre">--preview</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export preview image generated by Photos. This is a lower-resolution image used by Photos to quickly preview the image. See also –preview-suffix and –preview-if-missing.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview-if-missing">
|
||
<span class="sig-name descname"><span class="pre">--preview-if-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview-if-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export preview image generated by Photos if the actual photo file is missing from the library. This may be helpful if photos were not copied to the Photos library and the original photo is missing. See also –preview-suffix and –preview.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-preview-suffix">
|
||
<span class="sig-name descname"><span class="pre">--preview-suffix</span></span><span class="sig-prename descclassname"> <span class="pre"><SUFFIX></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-preview-suffix" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional suffix template for naming preview photos. Default name for preview photos is in form ‘photoname_preview.ext’. For example, with ‘–preview-suffix _low_res’, the preview photo would be named ‘photoname_low_res.ext’. The default suffix is ‘_preview’. Multi-value templates (see Templating System) are not permitted with –preview-suffix. See also –preview and –preview-if-missing.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-download-missing">
|
||
<span class="sig-name descname"><span class="pre">--download-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-download-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-export-aae">
|
||
<span class="sig-name descname"><span class="pre">--export-aae</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-export-aae" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Also export an adjustments file detailing edits made to the original. The resulting file is named photoname.AAE. Note that to import these files back to Photos succesfully, you also need to export the edited photo and match the filename format Photos.app expects: –filename ‘IMG_{edited_version?E,}{id:04d}’ –edited-suffix ‘’</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar">
|
||
<span class="sig-name descname"><span class="pre">--sidecar</span></span><span class="sig-prename descclassname"> <span class="pre"><FORMAT></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) 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’. See also ‘–ignore-signature’.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>xmp | json | exiftool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar-drop-ext">
|
||
<span class="sig-name descname"><span class="pre">--sidecar-drop-ext</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar-drop-ext" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-sidecar-template">
|
||
<span class="sig-name descname"><span class="pre">--sidecar-template</span></span><span class="sig-prename descclassname"> <span class="pre"><MAKO_TEMPLATE_FILE</span> <span class="pre">SIDECAR_FILENAME_TEMPLATE</span> <span class="pre">OPTIONS></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-sidecar-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Create a custom sidecar file for each photo exported with user provided Mako template (MAKO_TEMPLATE_FILE). MAKO_TEMPLATE_FILE must be a valid Mako template (see <a class="reference external" href="https://www.makotemplates.org/">https://www.makotemplates.org/</a>). The template will passed the following variables: photo (PhotoInfo object for the photo being exported), sidecar_path (pathlib.Path object for the path to the sidecar being written), and photo_path (pathlib.Path object for the path to the exported photo. SIDECAR_FILENAME_TEMPLATE must be a valid template string (see Templating System in help) which will be rendered to generate the filename of the sidecar file. The <cite>{filepath}</cite> template variable may be used in the SIDECAR_FILENAME_TEMPLATE to refer to the filename of the photo being exported. OPTIONS is a comma-separated list of strings providing additional options to the template. Valid options are: write_skipped, strip_whitespace, strip_lines, skip_zero, catch_errors, none. write_skipped will cause the sidecar file to be written even if the photo is skipped during export. If write_skipped is not passed as an option, the sidecar file will not be written if the photo is skipped during export. strip_whitespace and strip_lines indicate whether or not to strip whitespace and blank lines, respectively, from the resulting sidecar file. skip_zero causes the sidecar file to be skipped if the rendered template is zero-length. catch_errors causes errors in the template to be caught and logged but not raised. Without catch_errors, osxphotos will abort the export if an error occurs in the template. For example, to create a sidecar file with extension .xmp using a template file named ‘sidecar.mako’ and write a sidecar for skipped photos and strip blank lines but not whitespace: <cite>–sidecar-template sidecar.mako ‘{filepath}.xmp’ write_skipped,strip_lines</cite>. To do the same but to drop the photo extension from the sidecar filename: <cite>–sidecar-template sidecar.mako ‘{filepath.parent}/{filepath.stem}.xmp’ write_skipped,strip_lines</cite>. If you are not passing any options, you must pass ‘none’ as the last argument to –sidecar-template: <cite>–sidecar-template sidecar.mako ‘{filepath}.xmp’ none</cite>. For an example Mako file see <a class="reference external" href="https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/custom_sidecar.mako">https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/custom_sidecar.mako</a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool">
|
||
<span class="sig-name descname"><span class="pre">--exiftool</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>. 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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-path">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIFTOOL_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-path" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-option">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-option</span></span><span class="sig-prename descclassname"> <span class="pre"><OPTION></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-option" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 <a class="reference external" href="https://exiftool.org/exiftool_pod.html">https://exiftool.org/exiftool_pod.html</a> for full list of options. More than one option may be specified by repeating the option, e.g. –exiftool-option ‘-m’ –exiftool-option ‘-F’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-merge-keywords">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-merge-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Merge any keywords found in the original file with keywords used for ‘–exiftool’ and ‘–sidecar’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exiftool-merge-persons">
|
||
<span class="sig-name descname"><span class="pre">--exiftool-merge-persons</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-exiftool-merge-persons" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Merge any persons found in the original file with persons used for ‘–exiftool’ and ‘–sidecar’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-favorite-rating">
|
||
<span class="sig-name descname"><span class="pre">--favorite-rating</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-favorite-rating" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –exiftool or –sidecar, set XMP:Rating=5 for photos marked as Favorite and XMP:Rating=0 for non-Favorites. If not specified, XMP:Rating is not set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ignore-date-modified">
|
||
<span class="sig-name descname"><span class="pre">--ignore-date-modified</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ignore-date-modified" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-person-keyword">
|
||
<span class="sig-name descname"><span class="pre">--person-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-person-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use person in image as keyword/tag when exporting metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-album-keyword">
|
||
<span class="sig-name descname"><span class="pre">--album-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-album-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use album name as keyword/tag when exporting metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keyword-template">
|
||
<span class="sig-name descname"><span class="pre">--keyword-template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keyword-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-replace-keywords">
|
||
<span class="sig-name descname"><span class="pre">--replace-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-replace-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-description-template">
|
||
<span class="sig-name descname"><span class="pre">--description-template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-description-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-finder-tag-template">
|
||
<span class="sig-name descname"><span class="pre">--finder-tag-template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-finder-tag-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set MacOS Finder tags to TEMPLATE. These tags can be searched in the Finder or Spotlight with ‘<a class="reference external" href="tag:tagname">tag:tagname</a>’ 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.’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-finder-tag-keywords">
|
||
<span class="sig-name descname"><span class="pre">--finder-tag-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-finder-tag-keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-xattr-template">
|
||
<span class="sig-name descname"><span class="pre">--xattr-template</span></span><span class="sig-prename descclassname"> <span class="pre"><ATTRIBUTE</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-xattr-template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set extended attribute ATTRIBUTE to TEMPLATE value. Valid attributes are: ‘authors’, ‘comment’, ‘copyright’, ‘creator’, ‘description’, ‘findercomment’, ‘headline’, ‘participants’, ‘projects’, ‘starrating’, ‘subject’, ‘title’, ‘version’. 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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-directory">
|
||
<span class="sig-name descname"><span class="pre">--directory</span></span><span class="sig-prename descclassname"> <span class="pre"><DIRECTORY></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-directory" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional template for specifying name of output directory in the form ‘{name,DEFAULT}’. See below for additional details on templating system.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-filename">
|
||
<span class="sig-name descname"><span class="pre">--filename</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-filename" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-jpeg-ext">
|
||
<span class="sig-name descname"><span class="pre">--jpeg-ext</span></span><span class="sig-prename descclassname"> <span class="pre"><EXTENSION></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-jpeg-ext" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>jpeg | jpg | JPEG | JPG</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-strip">
|
||
<span class="sig-name descname"><span class="pre">--strip</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-strip" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-edited-suffix">
|
||
<span class="sig-name descname"><span class="pre">--edited-suffix</span></span><span class="sig-prename descclassname"> <span class="pre"><SUFFIX></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-edited-suffix" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-original-suffix">
|
||
<span class="sig-name descname"><span class="pre">--original-suffix</span></span><span class="sig-prename descclassname"> <span class="pre"><SUFFIX></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-original-suffix" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-use-photos-export">
|
||
<span class="sig-name descname"><span class="pre">--use-photos-export</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-use-photos-export" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Force the use of AppleScript or PhotoKit to export even if not missing (see also ‘–download-missing’ and ‘–use-photokit’).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-use-photokit">
|
||
<span class="sig-name descname"><span class="pre">--use-photokit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-use-photokit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-report">
|
||
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre"><REPORT_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-report" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Write a report of all files that were exported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Templating System), for example, –report ‘export_{today.date}.csv’ will write a CSV report file named with today’s date. See also –append.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-append">
|
||
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-append" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If used with –report, add data to existing report file instead of overwriting it. See also –report.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-cleanup">
|
||
<span class="sig-name descname"><span class="pre">--cleanup</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-cleanup" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 <em>any</em> 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. To prevent files not generated by osxphotos from being deleted, you may specify one or more rulesin a file named <cite>.osxphotos_keep</cite> in the export directory. This file uses the same format as a .gitignore file and should contain one rule per line; lines starting with a <cite>#</cite> will be ignored. Reference <a class="reference external" href="https://git-scm.com/docs/gitignore#_pattern_format">https://git-scm.com/docs/gitignore#_pattern_format</a> for details. In addition to the standard .gitignore rules, the rules may also be the absolute path to a file or directory. For example if export destination is <cite>/Volumes/Photos</cite> and you want to keep all <cite>.txt</cite> files, in the top level of the export directory, you can specify <cite>/*.txt”</cite> in the .osxphotos_keep file. If you want to keep all <cite>.txt</cite> files in the export directory and all subdirectories, you can specify <cite>**/*.txt</cite>. If present, the .osxphotos_keep file will be read after the export is completed and any rules found in the file will be added to the list of rules to keep. See also –keep.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-keep">
|
||
<span class="sig-name descname"><span class="pre">--keep</span></span><span class="sig-prename descclassname"> <span class="pre"><KEEP_RULE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-keep" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –cleanup, prevents file or directory matching KEEP_RULE from being deleted when cleanup is run. Use this if there are files in the export directory that you don’t want to be deleted when –cleanup is run. KEEP_RULE follows the same format rules a .gitignore file. Reference <a class="reference external" href="https://git-scm.com/docs/gitignore#_pattern_format">https://git-scm.com/docs/gitignore#_pattern_format</a> for details. In addition to the standard .gitignore rules, KEEP_RULE may also be the absolute path to a file or directory. For example if export destination is <cite>/Volumes/Photos</cite> and you want to keep all <cite>.txt</cite> files, in the top level of the export directory, you can specify <cite>–keep “/*.txt”</cite>. If you want to keep all <cite>.txt</cite> files in the export directory and all subdirectories, you can specify <cite>–keep “**/*.txt”</cite>. If wild card is used, KEEP_RULE must be enclosed in quotes to prevent the shell from expanding the wildcard. –keep may be repeated to keep additional files/directories. Rules may also be included in a file named <cite>.osxphotos_keep</cite> in the export directory. If present, this file will be read after the export is completed and any rules found in the file will be added to the list of rules to keep. This file uses the same format as a .gitignore file and should contain one rule per line; lines starting with a <cite>#</cite> will be ignored.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-exported-to-album">
|
||
<span class="sig-name descname"><span class="pre">--add-exported-to-album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-exported-to-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add all exported photos to album ALBUM in Photos. Album ALBUM will be created if it doesn’t exist. All exported photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos. This feature is currently experimental. I don’t know how well it will work on large export sets.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-skipped-to-album">
|
||
<span class="sig-name descname"><span class="pre">--add-skipped-to-album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-skipped-to-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add all skipped photos to album ALBUM in Photos. Album ALBUM will be created if it doesn’t exist. All skipped photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos. This feature is currently experimental. I don’t know how well it will work on large export sets.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-add-missing-to-album">
|
||
<span class="sig-name descname"><span class="pre">--add-missing-to-album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-add-missing-to-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add all missing photos to album ALBUM in Photos. Album ALBUM will be created if it doesn’t exist. All missing photos will be added to this album. This only works if the Photos library being exported is the last-opened (default) library in Photos. This feature is currently experimental. I don’t know how well it will work on large export sets.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-command">
|
||
<span class="sig-name descname"><span class="pre">--post-command</span></span><span class="sig-prename descclassname"> <span class="pre"><CATEGORY</span> <span class="pre">COMMAND></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-command" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run COMMAND on exported files of category CATEGORY. CATEGORY can be one of: exported, new, updated, skipped, missing, exif_updated, touched, converted_to_jpeg, sidecar_json_written, sidecar_json_skipped, sidecar_exiftool_written, sidecar_exiftool_skipped, sidecar_xmp_written, sidecar_xmp_skipped, error. COMMAND is an osxphotos template string, for example: ‘–post-command exported “echo {filepath|shell_quote} >> {export_dir}/exported.txt”’, which appends the full path of all exported files to the file ‘exported.txt’. You can run more than one command by repeating the ‘–post-command’ option with different arguments. See also –post-command-error and –post-function.See Post Command below.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-command-error">
|
||
<span class="sig-name descname"><span class="pre">--post-command-error</span></span><span class="sig-prename descclassname"> <span class="pre"><ACTION></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-command-error" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify either <cite>continue</cite> or <cite>break</cite> for ACTION to control behavior when a post-command fails. If <cite>continue</cite>, osxphotos will log the error and continue processing. If <cite>break</cite>, osxphotos will stop processing any additional –post-command commands for the current photo but will continue with the export. Without –post-command-error, osxphotos will abort the export if a post-command encounters an error.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>continue | break</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-post-function">
|
||
<span class="sig-name descname"><span class="pre">--post-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-post-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function on exported files. Use this in format: –post-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. The function will be passed information about the photo that’s been exported and a list of all exported files associated with the photo. You can run more than one function by repeating the ‘–post-function’ option with different arguments. See Post Function below.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-exportdb">
|
||
<span class="sig-name descname"><span class="pre">--exportdb</span></span><span class="sig-prename descclassname"> <span class="pre"><EXPORTDB_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-exportdb" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify alternate path 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. If –exportdb is specified, it will be saved to the specified file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-ramdb">
|
||
<span class="sig-name descname"><span class="pre">--ramdb</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-ramdb" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Copy export database to memory during export; may improve performance when exporting over a network or slow disk but could result in losing update state information if the program is interrupted or crashes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-tmpdir">
|
||
<span class="sig-name descname"><span class="pre">--tmpdir</span></span><span class="sig-prename descclassname"> <span class="pre"><DIR></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-tmpdir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify alternate temporary directory. Default is system temporary directory. osxphotos needs to create a number of temporary files during export. In some cases, particularly if the Photos library is on an APFS volume that is not the system volume, osxphotos may run faster if you specify a temporary directory on the same volume as the Photos library.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-alt-copy">
|
||
<span class="sig-name descname"><span class="pre">--alt-copy</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-alt-copy" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use alternate copy method that may be more reliable for some network attached storage (NAS) devices. Use –alt-copy if you experience problems exporting to a NAS device or SMB volume. Unlike the default copy method, –alt-copy does not support copy-on-write on APFS volumes nor does it preserve filesystem metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-load-config">
|
||
<span class="sig-name descname"><span class="pre">--load-config</span></span><span class="sig-prename descclassname"> <span class="pre"><CONFIG_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-load-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-save-config">
|
||
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre"><CONFIG_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-save-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Save options to file for use with –load-config. File format is TOML. See also –config-only.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-config-only">
|
||
<span class="sig-name descname"><span class="pre">--config-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-config-only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If specified, saves the config file but does not export any files; must be used with –save-config.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-print">
|
||
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-print" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Render TEMPLATE string for each photo being exported and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. TEMPLATE will be printed after the photo is exported or skipped. May be repeated to print multiple template strings.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-export-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-export-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-arg-DEST">
|
||
<span id="cmdoption-osxphotos-export-arg-dest"></span><span class="sig-name descname"><span class="pre">DEST</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-arg-DEST" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-exportdb">
|
||
<h3>exportdb<a class="headerlink" href="#osxphotos-exportdb" title="Permalink to this heading">#</a></h3>
|
||
<p>Utilities for working with the osxphotos export database</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos exportdb <span class="o">[</span>OPTIONS<span class="o">]</span> EXPORT_DATABASE
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-version">
|
||
<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-version" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print export database version and exit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-vacuum">
|
||
<span class="sig-name descname"><span class="pre">--vacuum</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-vacuum" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run VACUUM to defragment the database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-check-signatures">
|
||
<span class="sig-name descname"><span class="pre">--check-signatures</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-check-signatures" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Check signatures for all exported photos in the database to find signatures that don’t match.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-update-signatures">
|
||
<span class="sig-name descname"><span class="pre">--update-signatures</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-update-signatures" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Update signatures for all exported photos in the database to match on-disk signatures.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-touch-file">
|
||
<span class="sig-name descname"><span class="pre">--touch-file</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-touch-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Touch files on disk to match created date in Photos library and update export database signatures</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-last-run">
|
||
<span class="sig-name descname"><span class="pre">--last-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-last-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Show last run osxphotos commands used with this database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-save-config">
|
||
<span class="sig-name descname"><span class="pre">--save-config</span></span><span class="sig-prename descclassname"> <span class="pre"><CONFIG_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-save-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Save last run configuration to TOML file for use by –load-config.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-info">
|
||
<span class="sig-name descname"><span class="pre">--info</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print information about FILE_PATH contained in the database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-errors">
|
||
<span class="sig-name descname"><span class="pre">--errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-errors" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print list of files that had warnings/errors on export (from all runs).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-last-errors">
|
||
<span class="sig-name descname"><span class="pre">--last-errors</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-last-errors" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print list of files that had warnings/errors on last export run.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-uuid-files">
|
||
<span class="sig-name descname"><span class="pre">--uuid-files</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-uuid-files" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>List exported files associated with UUID.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-uuid-info">
|
||
<span class="sig-name descname"><span class="pre">--uuid-info</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-uuid-info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print information about UUID contained in the database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-delete-uuid">
|
||
<span class="sig-name descname"><span class="pre">--delete-uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-delete-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Delete all data associated with UUID from the database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-delete-file">
|
||
<span class="sig-name descname"><span class="pre">--delete-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-delete-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Delete all data associated with FILE_PATH from the database; does not delete the actual exported file if it exists, only the data in the database.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-report">
|
||
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre"><REPORT_FILE</span> <span class="pre">RUN_ID></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-report" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Generate an export report as <cite>osxphotos export … –report REPORT_FILE</cite> would have done. This allows you to re-create an export report if you didn’t use the –report option when running <cite>osxphotos export</cite>. The extension of the report file is used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). RUN_ID may be any integer from -10 to 0 specifying which run to use. For example, <cite>–report report.csv 0</cite> will generate a CSV report for the last run and <cite>–report report.json -1</cite> will generate a JSON report for the second-to-last run (one run prior to last run). REPORT_FILE may be a template string (see Templating System), for example, –report ‘export_{today.date}.csv’ will write a CSV report file named with today’s date. See also –append.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-migrate">
|
||
<span class="sig-name descname"><span class="pre">--migrate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-migrate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Migrate (if needed) export database to current version.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-sql">
|
||
<span class="sig-name descname"><span class="pre">--sql</span></span><span class="sig-prename descclassname"> <span class="pre"><SQL_STATEMENT></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-sql" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Execute SQL_STATEMENT against export database and print results.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-migrate-photos-library">
|
||
<span class="sig-name descname"><span class="pre">--migrate-photos-library</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-migrate-photos-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Migrate the export database to use the specified Photos library. Use this if you have moved your Photos library to a new location or computer and want to keep using the same export database. This will update the UUIDs in the export database to match the new Photos library.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-export-dir">
|
||
<span class="sig-name descname"><span class="pre">--export-dir</span></span><span class="sig-prename descclassname"> <span class="pre"><export_dir></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-export-dir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional path to export directory (if not parent of export database).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-append">
|
||
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-append" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If used with –report, add data to existing report file instead of overwriting it. See also –report.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-V">
|
||
<span id="cmdoption-osxphotos-exportdb-v"></span><span id="cmdoption-osxphotos-exportdb-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run in dry-run mode (don’t actually update files); for example, use with –update-signatures or –migrate-photos-library.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-exportdb-arg-EXPORT_DATABASE">
|
||
<span id="cmdoption-osxphotos-exportdb-arg-export-database"></span><span class="sig-name descname"><span class="pre">EXPORT_DATABASE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-exportdb-arg-EXPORT_DATABASE" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-help">
|
||
<h3>help<a class="headerlink" href="#osxphotos-help" title="Permalink to this heading">#</a></h3>
|
||
<p>Print help; for help on commands: help <command>.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos <span class="nb">help</span> <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>TOPIC<span class="o">]</span> <span class="o">[</span>SUBTOPIC<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-help-arg-TOPIC">
|
||
<span id="cmdoption-osxphotos-help-arg-topic"></span><span class="sig-name descname"><span class="pre">TOPIC</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-help-arg-TOPIC" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-help-arg-SUBTOPIC">
|
||
<span id="cmdoption-osxphotos-help-arg-subtopic"></span><span class="sig-name descname"><span class="pre">SUBTOPIC</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-help-arg-SUBTOPIC" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-import">
|
||
<h3>import<a class="headerlink" href="#osxphotos-import" title="Permalink to this heading">#</a></h3>
|
||
<p>Import photos and videos into Photos. Photos will be imported into the
|
||
most recently opened Photos library.</p>
|
||
<p>Photos are imported one at a time thus the “Imports” album in Photos will show
|
||
a new import group for each photo imported. Batch import into a single import
|
||
group will be added in a future release.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos import <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>FILES<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-a">
|
||
<span id="cmdoption-osxphotos-import-album"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-a" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Import photos into album ALBUM_TEMPLATE. ALBUM_TEMPLATE is an osxphotos template string. Photos may be imported into more than one album by repeating –album. See Template System in help for additional information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-t">
|
||
<span id="cmdoption-osxphotos-import-title"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-t" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set title of imported photos to TITLE_TEMPLATE. TITLE_TEMPLATE is a an osxphotos template string. See Template System in help for additional information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-d">
|
||
<span id="cmdoption-osxphotos-import-description"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESCRIPTION_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-d" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set description of imported photos to DESCRIPTION_TEMPLATE. DESCRIPTION_TEMPLATE is a an osxphotos template string. See Template System in help for additional information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-k">
|
||
<span id="cmdoption-osxphotos-import-keyword"></span><span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD_TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-k" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set keywords of imported photos to KEYWORD_TEMPLATE. KEYWORD_TEMPLATE is a an osxphotos template string. More than one keyword may be set by repeating –keyword. See Template System in help for additional information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-m">
|
||
<span id="cmdoption-osxphotos-import-merge-keywords"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--merge-keywords</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-m" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Merge keywords created by –exiftool or –keyword with any keywords already associated with the photo. Without –merge-keywords, existing keywords will be overwritten.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-l">
|
||
<span id="cmdoption-osxphotos-import-location"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"> <span class="pre"><LATITUDE</span> <span class="pre">LONGITUDE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-l" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set location of imported photo to LATITUDE LONGITUDE. Latitude is a number in the range -90.0 to 90.0; positive latitudes are north of the equator, negative latitudes are south of the equator. Longitude is a number in the range -180.0 to 180.0; positive longitudes are east of the Prime Meridian; negative longitudes are west of the Prime Meridian.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-P">
|
||
<span id="cmdoption-osxphotos-import-p"></span><span id="cmdoption-osxphotos-import-parse-date"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parse-date</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE_PATTERN></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-P" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Parse date from filename using DATE_PATTERN. If file does not match DATE_PATTERN, the date will be set by Photos using Photo’s default behavior. DATE_PATTERN is a strptime-compatible pattern with extensions as pattern described below. If DATE_PATTERN matches time zone information, the time will be set to the local time in the timezone as the import command does not yet support setting time zone information. For example, if your photos are named ‘IMG_1234_2022_11_23_12_34_56.jpg’ where the date/time is ‘2022-11-23 12:34:56’, you could use the pattern ‘%Y_%m_%d_%H_%M_%S’ or ‘IMG_*_%Y_%m_%d_%H_%M_%S’ to further narrow the pattern to only match files with ‘<a href="#id3"><span class="problematic" id="id4">IMG_xxxx_</span></a>’ in the name.See also –check-templates.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-C">
|
||
<span id="cmdoption-osxphotos-import-c"></span><span id="cmdoption-osxphotos-import-clear-metadata"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clear-metadata</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-C" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Clear any metadata set automatically by Photos upon import. Normally, Photos will set title, description, and keywords from XMP metadata in the imported file. If you specify –clear-metadata, any metadata set by Photos will be cleared after import.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-L">
|
||
<span id="cmdoption-osxphotos-import-clear-location"></span><span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--clear-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-L" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Clear any location data automatically imported by Photos. Normally, Photos will set location of the photo to the location data found in the metadata in the imported file. If you specify –clear-location, this data will be cleared after import.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-e">
|
||
<span id="cmdoption-osxphotos-import-exiftool"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-e" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Use third party tool exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) to automatically update metadata (title, description, keywords, location) in imported photos from the imported file’s metadata. Note: importing keywords from video files is not currently supported.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-0">
|
||
<span id="cmdoption-osxphotos-import-exiftool-path"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIFTOOL_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-0" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optionally specify path to exiftool; if not provided, will look for exiftool in $PATH.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-r">
|
||
<span id="cmdoption-osxphotos-import-relative-to"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--relative-to</span></span><span class="sig-prename descclassname"> <span class="pre"><RELATIVE_TO_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-r" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If set, the ‘{filepath}’ template will be computed relative to RELATIVE_TO_PATH. For example, if path to import is ‘/Volumes/photos/import/album/img_1234.jpg’ then ‘{filepath}’ will be this same value. If you set ‘–relative-to /Volumes/photos/import’ then ‘{filepath}’ will be set to ‘album/img_1234.jpg’</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-D">
|
||
<span id="cmdoption-osxphotos-import-dup-check"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--dup-check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-D" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Check for duplicates on import.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-f">
|
||
<span id="cmdoption-osxphotos-import-split-folder"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--split-folder</span></span><span class="sig-prename descclassname"> <span class="pre"><split_folder></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-f" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Automatically create hierarchal folders for albums as needed by splitting album name into folders and album. You must specify the character used to split folders and albums. For example, ‘–split-folder “/”’ will split the album name ‘Folder/Album’ into folder ‘Folder’ and album ‘Album’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-w">
|
||
<span id="cmdoption-osxphotos-import-walk"></span><span class="sig-name descname"><span class="pre">-w</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--walk</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-w" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Recursively walk through directories.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-g">
|
||
<span id="cmdoption-osxphotos-import-glob"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--glob</span></span><span class="sig-prename descclassname"> <span class="pre"><GLOB></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-g" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Only import files matching GLOB. GLOB is a Unix shell-style glob pattern, for example: ‘–glob “<a href="#id1"><span class="problematic" id="id2">*</span></a>.jpg”’. GLOB may be repeated to import multiple patterns.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-report">
|
||
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre"><REPORT_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-report" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Write a report of all files that were imported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Template System), for example, –report ‘export_{today.date}.csv’ will write a CSV report file named with today’s date. See also –append.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-R">
|
||
<span id="cmdoption-osxphotos-import-resume"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--resume</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-R" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Resume previous import. Note: data on each imported file is kept in a database in ‘/Users/rhet/.local/share/osxphotos/osxphotos_import.db’. This data can be used to resume a previous import if there was an error or the import was cancelled.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-append">
|
||
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-append" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If used with –report, add data to existing report file instead of overwriting it. See also –report.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-V">
|
||
<span id="cmdoption-osxphotos-import-v"></span><span id="cmdoption-osxphotos-import-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-no-progress">
|
||
<span class="sig-name descname"><span class="pre">--no-progress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-no-progress" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Do not display progress bar during import.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-check-templates">
|
||
<span class="sig-name descname"><span class="pre">--check-templates</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-check-templates" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Don’t actually import anything; renders template strings and date patterns so you can verify they are correct.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-post-function">
|
||
<span class="sig-name descname"><span class="pre">--post-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-post-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run python function after importing file.Use this in format: –post-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. The function will be passed a reference to the photo object and the path to the file that was imported. You can run more than one function by repeating the ‘–post-function’ option with different arguments. See Post Function below.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-import-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-import-arg-FILES">
|
||
<span id="cmdoption-osxphotos-import-arg-files"></span><span class="sig-name descname"><span class="pre">FILES</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-import-arg-FILES" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-info">
|
||
<h3>info<a class="headerlink" href="#osxphotos-info" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out descriptive info of the Photos library database.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos info <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-library">
|
||
<span id="cmdoption-osxphotos-info-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-info-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-info-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-info-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-info-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-info-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-inspect">
|
||
<h3>inspect<a class="headerlink" href="#osxphotos-inspect" title="Permalink to this heading">#</a></h3>
|
||
<p>Interactively inspect photos selected in Photos.</p>
|
||
<p>Open Photos then run <cite>osxphotos inspect</cite> in the terminal.
|
||
As you select a photo in Photos, inspect will display metadata about the photo.
|
||
Press Ctrl+C to exit when done.
|
||
Works best with a modern terminal like iTerm2 or Kitty.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos inspect <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-t">
|
||
<span id="cmdoption-osxphotos-inspect-detect-text"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--detect-text</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-t" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Detect text in photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-T">
|
||
<span id="cmdoption-osxphotos-inspect-template"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--template</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-T" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Template string to render for each photo using template preview mode. Useful for testing templates for export; may be repeated to test multiple templates. If –template/-T is used, other inspection data will not be displayed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-inspect-library">
|
||
<span id="cmdoption-osxphotos-inspect-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-inspect-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-install">
|
||
<h3>install<a class="headerlink" href="#osxphotos-install" title="Permalink to this heading">#</a></h3>
|
||
<p>Install Python packages into the same environment as osxphotos</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos install <span class="o">[</span>OPTIONS<span class="o">]</span> PACKAGES...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-install-U">
|
||
<span id="cmdoption-osxphotos-install-u"></span><span id="cmdoption-osxphotos-install-upgrade"></span><span class="sig-name descname"><span class="pre">-U</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--upgrade</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-install-U" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Upgrade packages to latest version</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-install-arg-PACKAGES">
|
||
<span id="cmdoption-osxphotos-install-arg-packages"></span><span class="sig-name descname"><span class="pre">PACKAGES</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-install-arg-PACKAGES" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-keywords">
|
||
<h3>keywords<a class="headerlink" href="#osxphotos-keywords" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out keywords found in the Photos library.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos keywords <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-keywords-library">
|
||
<span id="cmdoption-osxphotos-keywords-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-keywords-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-keywords-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-keywords-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-keywords-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-keywords-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-keywords-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-labels">
|
||
<h3>labels<a class="headerlink" href="#osxphotos-labels" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out image classification labels found in the Photos library.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos labels <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-labels-library">
|
||
<span id="cmdoption-osxphotos-labels-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-labels-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-labels-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-labels-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-labels-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-labels-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-labels-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-list">
|
||
<h3>list<a class="headerlink" href="#osxphotos-list" title="Permalink to this heading">#</a></h3>
|
||
<p>Print list of Photos libraries found on the system.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos list <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-list-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-list-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-orphans">
|
||
<h3>orphans<a class="headerlink" href="#osxphotos-orphans" title="Permalink to this heading">#</a></h3>
|
||
<p>Find orphaned photos in a Photos library</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos orphans <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-export">
|
||
<span class="sig-name descname"><span class="pre">--export</span></span><span class="sig-prename descclassname"> <span class="pre"><EXPORT_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-export" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export orphans to directory EXPORT_PATH. If –export not specified, orphans are listed but not exported.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-library">
|
||
<span id="cmdoption-osxphotos-orphans-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-V">
|
||
<span id="cmdoption-osxphotos-orphans-v"></span><span id="cmdoption-osxphotos-orphans-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-orphans-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-orphans-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-persons">
|
||
<h3>persons<a class="headerlink" href="#osxphotos-persons" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out persons (faces) found in the Photos library.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos persons <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-persons-library">
|
||
<span id="cmdoption-osxphotos-persons-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-persons-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-persons-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-persons-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-persons-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-persons-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-persons-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-places">
|
||
<h3>places<a class="headerlink" href="#osxphotos-places" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out places found in the Photos library.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos places <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-places-library">
|
||
<span id="cmdoption-osxphotos-places-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-places-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-places-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-places-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-places-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-places-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-places-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-query">
|
||
<h3>query<a class="headerlink" href="#osxphotos-query" title="Permalink to this heading">#</a></h3>
|
||
<p>Query the Photos database using 1 or more search options;
|
||
if more than one different option is provided, they are treated as “AND”
|
||
(e.g. search for photos matching all options).
|
||
If the same query option is provided multiple times, they are treated as
|
||
“OR” (e.g. search for photos matching any of the options).</p>
|
||
<p>For example:</p>
|
||
<p>osxphotos query –person “John Doe” –person “Jane Doe” –keyword “vacation”</p>
|
||
<p>will return all photos with either person of (“John Doe” OR “Jane Doe”) AND keyword of “vacation”</p>
|
||
<p>If not query options are provided, all photos in the library will be returned.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos query <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>PHOTOS_LIBRARY<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-library">
|
||
<span id="cmdoption-osxphotos-query-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-json">
|
||
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-count">
|
||
<span class="sig-name descname"><span class="pre">--count</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-count" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print count of photos matching query and exit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-keyword">
|
||
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no keyword.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-person">
|
||
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre"><PERSON></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-album">
|
||
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-folder">
|
||
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre"><FOLDER></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-name">
|
||
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with filename matching FILENAME. If more than one –name options is specified, they are treated as “OR”, e.g. find photos matching any FILENAME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uuid">
|
||
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is ‘-’, read UUIDs from stdin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for TITLE in title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-title">
|
||
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no title.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESC></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for DESC in description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-description">
|
||
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no description.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-place">
|
||
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre"><PLACE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for PLACE in photo’s reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-place">
|
||
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-location">
|
||
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-label">
|
||
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre"><LABEL></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-uti">
|
||
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre"><UTI></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-i">
|
||
<span id="cmdoption-osxphotos-query-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Case insensitive search for title, description, place, keyword, person, or album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-edited">
|
||
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-edited">
|
||
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-external-edit">
|
||
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-external-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos edited in external editor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-favorite">
|
||
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-favorite">
|
||
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-hidden">
|
||
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-hidden">
|
||
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared">
|
||
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared">
|
||
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-burst">
|
||
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were taken in a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-burst">
|
||
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-live">
|
||
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple live photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-live">
|
||
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple live photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-portrait">
|
||
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-portrait">
|
||
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-hdr">
|
||
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for high dynamic range (HDR) photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-hdr">
|
||
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not HDR photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-selfie">
|
||
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-selfie">
|
||
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not selfies.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-panorama">
|
||
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for panorama photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-panorama">
|
||
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not panoramas.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-raw">
|
||
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with both a jpeg and raw version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-only-movies">
|
||
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-only-movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for movies (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-only-photos">
|
||
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-only-photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for photos/images (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-from-date">
|
||
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre"><from_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-from-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-to-date">
|
||
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre"><to_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-to-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-from-time">
|
||
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre"><from_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-from-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start time of day, e.g. 12:00, or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-to-time">
|
||
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre"><to_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-to-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end time of day, e.g. 12:00 or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-year">
|
||
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre"><YEAR></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items from a specific year, e.g. –year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-before">
|
||
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-before" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library before a specific date/time, e.g. –added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-after">
|
||
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-after" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the libray after a specific date/time, e.g. –added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-added-in-last">
|
||
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME_DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-added-in-last" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like ‘12 hrs’, ‘1 day’, ‘1d’, ‘1 week’, ‘2weeks’, ‘1 month’, ‘1 year’. for example, <cite>–added-in-last 7d</cite> and <cite>–added-in-last ‘1 week’</cite> are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-comment">
|
||
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-comment">
|
||
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-has-likes">
|
||
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-has-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-no-likes">
|
||
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-no-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-is-reference">
|
||
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-is-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-reference">
|
||
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-in-album">
|
||
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in one or more albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-in-album">
|
||
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in any albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-duplicate">
|
||
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-min-size">
|
||
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-min-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size >= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-max-size">
|
||
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-max-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size <= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-missing">
|
||
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos missing from disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-missing">
|
||
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos present on disk (e.g. not missing).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-incloud">
|
||
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in iCloud (have been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-incloud">
|
||
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have not saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-not-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-not-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-regex">
|
||
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre"><REGEX</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with ‘Beach’: ‘–regex “^Beach” “{album}”’. You may specify more than one regular expression match by repeating ‘–regex’ with different arguments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-selected">
|
||
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter for photos that are currently selected in Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-exif">
|
||
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIF_TAG</span> <span class="pre">VALUE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where EXIF_TAG exists in photo’s EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: <cite>–exif Software ‘Adobe Photoshop’ `or to find all photos shot on a Canon camera: `–exif Make Canon</cite>. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. <cite>EXIF:Make</cite> or <cite>Make</cite>. To use –exif, exiftool must be installed and in the path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-query-eval">
|
||
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre"><CRITERIA></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-query-eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: <cite>photos = [photo for photo in photos if CRITERIA]</cite> where photo represents a PhotoInfo object. For example: <cite>–query-eval photo.favorite</cite> returns all photos that have been favorited and is equivalent to –favorite. You may specify more than one CRITERIA by using –query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-query-function">
|
||
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-query-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function to filter photos. Use this in format: –query-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the –query-function option with a different value. Your query function will be called after all other query options have been evaluated. See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-deleted-only">
|
||
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-deleted-only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include only photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-deleted">
|
||
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-deleted" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-add-to-album">
|
||
<span class="sig-name descname"><span class="pre">--add-to-album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-add-to-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add all photos from query to album ALBUM in Photos. Album ALBUM will be created if it doesn’t exist. All photos in the query results will be added to this album. This only works if the Photos library being queried is the last-opened (default) library in Photos. This feature is currently experimental. I don’t know how well it will work on large query sets.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-quiet">
|
||
<span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-quiet" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Quiet output; doesn’t actually print query results. Useful with –print and –add-to-album if you don’t want to see the actual query results.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-f">
|
||
<span id="cmdoption-osxphotos-query-field"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--field</span></span><span class="sig-prename descclassname"> <span class="pre"><FIELD</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-f" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Output only specified custom fields. FIELD is the name of the field and TEMPLATE is the template to use as the field value. May be repeated to output multiple fields. For example, to output photo uuid, name, and title: <cite>–field uuid “{uuid}” –field name “{original_name}” –field title “{title}”</cite>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-print">
|
||
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"> <span class="pre"><TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-query-print" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Render TEMPLATE string for each photo queried and print to stdout. TEMPLATE is an osxphotos template string. This may be useful for creating custom reports, etc. Most useful with –quiet. May be repeated to print multiple template strings.</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-query-arg-PHOTOS_LIBRARY">
|
||
<span id="cmdoption-osxphotos-query-arg-photos-library"></span><span class="sig-name descname"><span class="pre">PHOTOS_LIBRARY</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-query-arg-PHOTOS_LIBRARY" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-repl">
|
||
<h3>repl<a class="headerlink" href="#osxphotos-repl" title="Permalink to this heading">#</a></h3>
|
||
<p>Run interactive osxphotos REPL shell (useful for debugging, prototyping, and inspecting your Photos library)</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos repl <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-library">
|
||
<span id="cmdoption-osxphotos-repl-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-emacs">
|
||
<span class="sig-name descname"><span class="pre">--emacs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-emacs" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Launch REPL with Emacs keybindings (default is vi bindings)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-keyword">
|
||
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no keyword.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-person">
|
||
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre"><PERSON></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-album">
|
||
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-folder">
|
||
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre"><FOLDER></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-name">
|
||
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with filename matching FILENAME. If more than one –name options is specified, they are treated as “OR”, e.g. find photos matching any FILENAME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uuid">
|
||
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is ‘-’, read UUIDs from stdin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for TITLE in title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-title">
|
||
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no title.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESC></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for DESC in description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-description">
|
||
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no description.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-place">
|
||
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre"><PLACE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for PLACE in photo’s reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-place">
|
||
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-location">
|
||
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-label">
|
||
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre"><LABEL></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-uti">
|
||
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre"><UTI></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-i">
|
||
<span id="cmdoption-osxphotos-repl-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Case insensitive search for title, description, place, keyword, person, or album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-edited">
|
||
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-edited">
|
||
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-external-edit">
|
||
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-external-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos edited in external editor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-favorite">
|
||
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-favorite">
|
||
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-hidden">
|
||
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-hidden">
|
||
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared">
|
||
<span class="sig-name descname"><span class="pre">--shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared">
|
||
<span class="sig-name descname"><span class="pre">--not-shared</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not in shared iCloud album (Photos 5+ only).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-burst">
|
||
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were taken in a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-burst">
|
||
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-live">
|
||
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple live photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-live">
|
||
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple live photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-portrait">
|
||
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-portrait">
|
||
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-hdr">
|
||
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for high dynamic range (HDR) photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-hdr">
|
||
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not HDR photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-selfie">
|
||
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-selfie">
|
||
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not selfies.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-panorama">
|
||
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for panorama photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-panorama">
|
||
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not panoramas.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-raw">
|
||
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with both a jpeg and raw version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-only-movies">
|
||
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-only-movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for movies (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-only-photos">
|
||
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-only-photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for photos/images (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-from-date">
|
||
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre"><from_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-from-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-to-date">
|
||
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre"><to_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-to-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-from-time">
|
||
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre"><from_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-from-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start time of day, e.g. 12:00, or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-to-time">
|
||
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre"><to_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-to-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end time of day, e.g. 12:00 or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-year">
|
||
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre"><YEAR></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items from a specific year, e.g. –year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-before">
|
||
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-before" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library before a specific date/time, e.g. –added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-after">
|
||
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-after" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the libray after a specific date/time, e.g. –added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-added-in-last">
|
||
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME_DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-added-in-last" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like ‘12 hrs’, ‘1 day’, ‘1d’, ‘1 week’, ‘2weeks’, ‘1 month’, ‘1 year’. for example, <cite>–added-in-last 7d</cite> and <cite>–added-in-last ‘1 week’</cite> are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-comment">
|
||
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-comment">
|
||
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-has-likes">
|
||
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-has-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-no-likes">
|
||
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-no-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-is-reference">
|
||
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-is-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-reference">
|
||
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-in-album">
|
||
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in one or more albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-in-album">
|
||
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in any albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-duplicate">
|
||
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-min-size">
|
||
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-min-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size >= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-max-size">
|
||
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-max-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size <= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-missing">
|
||
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos missing from disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-missing">
|
||
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos present on disk (e.g. not missing).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-incloud">
|
||
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in iCloud (have been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-incloud">
|
||
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have not saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-not-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-not-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-regex">
|
||
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre"><REGEX</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with ‘Beach’: ‘–regex “^Beach” “{album}”’. You may specify more than one regular expression match by repeating ‘–regex’ with different arguments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-selected">
|
||
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter for photos that are currently selected in Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-exif">
|
||
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIF_TAG</span> <span class="pre">VALUE></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where EXIF_TAG exists in photo’s EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: <cite>–exif Software ‘Adobe Photoshop’ `or to find all photos shot on a Canon camera: `–exif Make Canon</cite>. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. <cite>EXIF:Make</cite> or <cite>Make</cite>. To use –exif, exiftool must be installed and in the path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-query-eval">
|
||
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre"><CRITERIA></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-query-eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: <cite>photos = [photo for photo in photos if CRITERIA]</cite> where photo represents a PhotoInfo object. For example: <cite>–query-eval photo.favorite</cite> returns all photos that have been favorited and is equivalent to –favorite. You may specify more than one CRITERIA by using –query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-query-function">
|
||
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-repl-query-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function to filter photos. Use this in format: –query-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the –query-function option with a different value. Your query function will be called after all other query options have been evaluated. See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-deleted-only">
|
||
<span class="sig-name descname"><span class="pre">--deleted-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-deleted-only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include only photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-repl-deleted">
|
||
<span class="sig-name descname"><span class="pre">--deleted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-repl-deleted" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include photos from the ‘Recently Deleted’ folder.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-run">
|
||
<h3>run<a class="headerlink" href="#osxphotos-run" title="Permalink to this heading">#</a></h3>
|
||
<p>Run a python file using same environment as osxphotos.
|
||
Any args are made available to the python file.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos run <span class="o">[</span>OPTIONS<span class="o">]</span> PYTHON_FILE ARGS
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-h">
|
||
<span id="cmdoption-osxphotos-run-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-h" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Show this message and exit</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-arg-PYTHON_FILE">
|
||
<span id="cmdoption-osxphotos-run-arg-python-file"></span><span class="sig-name descname"><span class="pre">PYTHON_FILE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-arg-PYTHON_FILE" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-arg-ARGS">
|
||
<span id="cmdoption-osxphotos-run-arg-args"></span><span class="sig-name descname"><span class="pre">ARGS</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-arg-ARGS" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-show">
|
||
<h3>show<a class="headerlink" href="#osxphotos-show" title="Permalink to this heading">#</a></h3>
|
||
<p>Show photo, album, or folder in Photos from UUID_OR_NAME</p>
|
||
<p>Examples:</p>
|
||
<p>osxphotos show 12345678-1234-1234-1234-123456789012</p>
|
||
<p>osxphotos show “My Album”</p>
|
||
<p>osxphotos show “My Folder”</p>
|
||
<p>osxphotos show IMG_1234.JPG</p>
|
||
<p>show can also be used to show a photo exported with <cite>osxphotos export</cite>:</p>
|
||
<p>osxphotos show /path/to/exported/photo.jpg</p>
|
||
<p>In this case, the UUID_OR_NAME is the path to the exported photo and osxphotos
|
||
will attempt to find the export database to match the photo to the original in
|
||
Photos. If your export database is not in the default location in the root of the
|
||
export directory, this will not work.</p>
|
||
<p>Notes:</p>
|
||
<p>This command requires Photos library version 5 or higher.
|
||
Currently this command cannot be used to show subfolders in Photos.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos show <span class="o">[</span>OPTIONS<span class="o">]</span> UUID_OR_NAME
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-show-library">
|
||
<span id="cmdoption-osxphotos-show-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-show-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-show-arg-UUID_OR_NAME">
|
||
<span id="cmdoption-osxphotos-show-arg-uuid-or-name"></span><span class="sig-name descname"><span class="pre">UUID_OR_NAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-show-arg-UUID_OR_NAME" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-snap">
|
||
<h3>snap<a class="headerlink" href="#osxphotos-snap" title="Permalink to this heading">#</a></h3>
|
||
<p>Create snapshot of Photos database to use with diff command</p>
|
||
<p>Snapshots only the database files, not the entire library. If OSXPHOTOS_SNAPSHOT
|
||
environment variable is defined, will use that as snapshot directory, otherwise
|
||
uses ‘/private/tmp/osxphotos_snapshots’</p>
|
||
<p>Works only on Photos library versions since Catalina (10.15) or newer.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos snap <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-snap-library">
|
||
<span id="cmdoption-osxphotos-snap-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-snap-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-sync">
|
||
<h3>sync<a class="headerlink" href="#osxphotos-sync" title="Permalink to this heading">#</a></h3>
|
||
<p>Sync metadata and albums between Photos libraries.</p>
|
||
<p>Use sync to update metadata in a local Photos library to match
|
||
metadata in another Photos library. The sync command works by
|
||
finding identical photos in the local library and the import source
|
||
and then updating the metadata in the local library to match the
|
||
metadata in the import source. Photos are considered identical if
|
||
their original filename and fingerprint match.</p>
|
||
<p>The import source can be a Photos library or a metadata export file
|
||
created with the –export option.</p>
|
||
<p>The sync command can be useful if you have imported the same photos to
|
||
multiple Photos libraries and want to keep the metadata in all libraries
|
||
in sync.</p>
|
||
<p>Metadata can be overwritten (–set) or merged (–merge) with the metadata
|
||
in the import source. You may specify specific metadata to sync or sync
|
||
all metadata. See –set and –merge for more details.</p>
|
||
<p>The sync command can be used to sync metadata between an iPhone or iPad
|
||
and a Mac, for example, in the case where you do not use iCloud but
|
||
manually import photos from your iPhone or iPad to your Mac. To do this,
|
||
you’ll first need to copy the Photos database from the iPhone or iPad to
|
||
your Mac. This can be done by connecting your iPhone or iPad to your Mac
|
||
using a USB cable and then copying the Photos database from the iPhone
|
||
using a third-party tool such as iMazing (<a class="reference external" href="https://imazing.com/">https://imazing.com/</a>). You can
|
||
then use the sync command and set the import source to the Photos database
|
||
you copied from the iPhone or iPad.</p>
|
||
<p>The sync command can also be used to sync metadata between users using
|
||
iCloud Shared Photo Library. NOTE: This use case has not yet been
|
||
tested. If you use iCloud Shared Photo Library and would like to help
|
||
test this use case, please connect with me on GitHub:
|
||
<a class="reference external" href="https://github.com/RhetTbull/osxphotos/issues/887">https://github.com/RhetTbull/osxphotos/issues/887</a></p>
|
||
<p>You can run the –export and –import commands together. In this case,
|
||
the import will be run first and then the export will be run.</p>
|
||
<p>For example, if you want to sync two Photos libraries between users or
|
||
two different computers, you can export the metadata to a shared folder.</p>
|
||
<p>On the first computer, run:</p>
|
||
<p>osxphotos sync –export /path/to/export/folder/computer1.db –merge all –import /path/to/export/folder/computer2.db</p>
|
||
<p>On the second computer, run:</p>
|
||
<p>osxphotos sync –export /path/to/export/folder/computer2.db –merge all –import /path/to/export/folder/computer1.db</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos sync <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-e">
|
||
<span id="cmdoption-osxphotos-sync-export"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--export</span></span><span class="sig-prename descclassname"> <span class="pre"><EXPORT_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-e" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export metadata to file EXPORT_FILE for later use with –import. The export file will be a SQLite database; it is recommended to use the .db extension though this is not required.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-i">
|
||
<span id="cmdoption-osxphotos-sync-import"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--import</span></span><span class="sig-prename descclassname"> <span class="pre"><IMPORT_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Import metadata from file IMPORT_PATH. IMPORT_PATH can a Photos library, a Photos database, or a metadata export file created with –export.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-s">
|
||
<span id="cmdoption-osxphotos-sync-set"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--set</span></span><span class="sig-prename descclassname"> <span class="pre"><METADATA></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-s" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –import, set metadata in local Photos library to match import data. Multiple metadata properties can be specified by repeating the –set option or by using a comma-separated list. METADATA can be one of: all, keywords, albums, title, description, favorite. For example, to set keywords and favorite, use <cite>–set keywords –set favorite</cite> or <cite>–set keywords,favorite</cite>. If <cite>–set all</cite> is specified, all metadata will be set. Note that using –set overwrites any existing metadata in the local Photos library. For example, if a photo is marked as favorite in the local library but not in the import source, –set favorite will clear the favorite status in the local library. The exception to this is that <cite>–set album</cite> will not remove the photo from any existing albums in the local library but will add the photo to any new albums specified in the import source.See also –merge.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-m">
|
||
<span id="cmdoption-osxphotos-sync-merge"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--merge</span></span><span class="sig-prename descclassname"> <span class="pre"><METADATA></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-m" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –import, merge metadata in local Photos library with import data. Multiple metadata properties can be specified by repeating the –merge option or by using a comma-separated list. METADATA can be one of: all, keywords, albums, title, description, favorite. For example, to merge keywords and favorite, use <cite>–merge keywords –merge favorite</cite> or <cite>–merge keywords,favorite</cite>. If <cite>–merge all</cite> is specified, all metadata will be merged. Note that using –merge does not overwrite any existing metadata in the local Photos library. For example, if a photo is marked as favorite in the local library but not in the import source, –merge favorite will not change the favorite status in the local library. See also –set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-U">
|
||
<span id="cmdoption-osxphotos-sync-u"></span><span id="cmdoption-osxphotos-sync-unmatched"></span><span class="sig-name descname"><span class="pre">-U</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--unmatched</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-U" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –import, print out a list of photos in the import source that were not matched against the local library. Also prints out a list of photos in the local library that were not matched against the import source.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-R">
|
||
<span id="cmdoption-osxphotos-sync-r"></span><span id="cmdoption-osxphotos-sync-report"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre"><REPORT_FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-R" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Write a report of all photos that were processed with –import. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a an osxphotos template string, for example, –report ‘update_{today.date}.csv’ will write a CSV report file named with today’s date. See also –append.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-A">
|
||
<span id="cmdoption-osxphotos-sync-a"></span><span id="cmdoption-osxphotos-sync-append"></span><span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-A" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>If used with –report, add data to existing report file instead of overwriting it. See also –report.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-dry-run">
|
||
<span class="sig-name descname"><span class="pre">--dry-run</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-dry-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Dry run; when used with –import, don’t actually update metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-V">
|
||
<span id="cmdoption-osxphotos-sync-v"></span><span id="cmdoption-osxphotos-sync-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-keyword">
|
||
<span class="sig-name descname"><span class="pre">--keyword</span></span><span class="sig-prename descclassname"> <span class="pre"><KEYWORD></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with keyword KEYWORD. If more than one keyword, treated as “OR”, e.g. find photos matching any keyword</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-keyword">
|
||
<span class="sig-name descname"><span class="pre">--no-keyword</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no keyword.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-person">
|
||
<span class="sig-name descname"><span class="pre">--person</span></span><span class="sig-prename descclassname"> <span class="pre"><PERSON></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with person PERSON. If more than one person, treated as “OR”, e.g. find photos matching any person</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-album">
|
||
<span class="sig-name descname"><span class="pre">--album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos in album ALBUM. If more than one album, treated as “OR”, e.g. find photos matching any album</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-folder">
|
||
<span class="sig-name descname"><span class="pre">--folder</span></span><span class="sig-prename descclassname"> <span class="pre"><FOLDER></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-name">
|
||
<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre"><FILENAME></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with filename matching FILENAME. If more than one –name options is specified, they are treated as “OR”, e.g. find photos matching any FILENAME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uuid">
|
||
<span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre"><UUID></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s). May be repeated to include multiple UUIDs.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uuid-from-file">
|
||
<span class="sig-name descname"><span class="pre">--uuid-from-file</span></span><span class="sig-prename descclassname"> <span class="pre"><FILE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uuid-from-file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with UUID(s) loaded from FILE. Format is a single UUID per line. Lines preceded with # are ignored. If FILE is ‘-’, read UUIDs from stdin.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-title">
|
||
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre"><TITLE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for TITLE in title of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-title">
|
||
<span class="sig-name descname"><span class="pre">--no-title</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no title.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-description">
|
||
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><DESC></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for DESC in description of photo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-description">
|
||
<span class="sig-name descname"><span class="pre">--no-description</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no description.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-place">
|
||
<span class="sig-name descname"><span class="pre">--place</span></span><span class="sig-prename descclassname"> <span class="pre"><PLACE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for PLACE in photo’s reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-place">
|
||
<span class="sig-name descname"><span class="pre">--no-place</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated place name info (no reverse geolocation info)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-location">
|
||
<span class="sig-name descname"><span class="pre">--location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with associated location info (e.g. GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-location">
|
||
<span class="sig-name descname"><span class="pre">--no-location</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no associated location info (e.g. no GPS coordinates)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-label">
|
||
<span class="sig-name descname"><span class="pre">--label</span></span><span class="sig-prename descclassname"> <span class="pre"><LABEL></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-uti">
|
||
<span class="sig-name descname"><span class="pre">--uti</span></span><span class="sig-prename descclassname"> <span class="pre"><UTI></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos whose uniform type identifier (UTI) matches UTI</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-0">
|
||
<span id="cmdoption-osxphotos-sync-ignore-case"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--ignore-case</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-0" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Case insensitive search for title, description, place, keyword, person, or album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-edited">
|
||
<span class="sig-name descname"><span class="pre">--edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-edited">
|
||
<span class="sig-name descname"><span class="pre">--not-edited</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been edited.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-external-edit">
|
||
<span class="sig-name descname"><span class="pre">--external-edit</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-external-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos edited in external editor.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-favorite">
|
||
<span class="sig-name descname"><span class="pre">--favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-favorite">
|
||
<span class="sig-name descname"><span class="pre">--not-favorite</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked favorite.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-hidden">
|
||
<span class="sig-name descname"><span class="pre">--hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-hidden">
|
||
<span class="sig-name descname"><span class="pre">--not-hidden</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos not marked hidden.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-burst">
|
||
<span class="sig-name descname"><span class="pre">--burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were taken in a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-burst">
|
||
<span class="sig-name descname"><span class="pre">--not-burst</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a burst.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-live">
|
||
<span class="sig-name descname"><span class="pre">--live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple live photos</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-live">
|
||
<span class="sig-name descname"><span class="pre">--not-live</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple live photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-portrait">
|
||
<span class="sig-name descname"><span class="pre">--portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-portrait">
|
||
<span class="sig-name descname"><span class="pre">--not-portrait</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not Apple portrait mode photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-screenshot">
|
||
<span class="sig-name descname"><span class="pre">--not-screenshot</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not screenshot photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-slow-mo">
|
||
<span class="sig-name descname"><span class="pre">--not-slow-mo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-slow-mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not slow motion videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-time-lapse">
|
||
<span class="sig-name descname"><span class="pre">--not-time-lapse</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-time-lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not time lapse videos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-hdr">
|
||
<span class="sig-name descname"><span class="pre">--hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for high dynamic range (HDR) photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-hdr">
|
||
<span class="sig-name descname"><span class="pre">--not-hdr</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not HDR photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-selfie">
|
||
<span class="sig-name descname"><span class="pre">--selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for selfies (photos taken with front-facing cameras).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-selfie">
|
||
<span class="sig-name descname"><span class="pre">--not-selfie</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not selfies.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-panorama">
|
||
<span class="sig-name descname"><span class="pre">--panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for panorama photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-panorama">
|
||
<span class="sig-name descname"><span class="pre">--not-panorama</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not panoramas.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-raw">
|
||
<span class="sig-name descname"><span class="pre">--has-raw</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with both a jpeg and raw version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-only-movies">
|
||
<span class="sig-name descname"><span class="pre">--only-movies</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-only-movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for movies (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-only-photos">
|
||
<span class="sig-name descname"><span class="pre">--only-photos</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-only-photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search only for photos/images (default searches both images and movies).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-from-date">
|
||
<span class="sig-name descname"><span class="pre">--from-date</span></span><span class="sig-prename descclassname"> <span class="pre"><from_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-from-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-to-date">
|
||
<span class="sig-name descname"><span class="pre">--to-date</span></span><span class="sig-prename descclassname"> <span class="pre"><to_date></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-to-date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-from-time">
|
||
<span class="sig-name descname"><span class="pre">--from-time</span></span><span class="sig-prename descclassname"> <span class="pre"><from_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-from-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item start time of day, e.g. 12:00, or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-to-time">
|
||
<span class="sig-name descname"><span class="pre">--to-time</span></span><span class="sig-prename descclassname"> <span class="pre"><to_time></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-to-time" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search by item end time of day, e.g. 12:00 or 12:00:00.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-year">
|
||
<span class="sig-name descname"><span class="pre">--year</span></span><span class="sig-prename descclassname"> <span class="pre"><YEAR></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items from a specific year, e.g. –year 2022 to find all photos from the year 2022. May be repeated to search multiple years.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-before">
|
||
<span class="sig-name descname"><span class="pre">--added-before</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-before" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library before a specific date/time, e.g. –added-before e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-after">
|
||
<span class="sig-name descname"><span class="pre">--added-after</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-after" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the libray after a specific date/time, e.g. –added-after e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-added-in-last">
|
||
<span class="sig-name descname"><span class="pre">--added-in-last</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME_DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-added-in-last" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for items added to the library in the last TIME_DELTA, where TIME_DELTA is a string like ‘12 hrs’, ‘1 day’, ‘1d’, ‘1 week’, ‘2weeks’, ‘1 month’, ‘1 year’. for example, <cite>–added-in-last 7d</cite> and <cite>–added-in-last ‘1 week’</cite> are equivalent. months are assumed to be 30 days and years are assumed to be 365 days. Common English abbreviations are accepted, e.g. d, day, days or m, min, minutes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-comment">
|
||
<span class="sig-name descname"><span class="pre">--has-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-comment">
|
||
<span class="sig-name descname"><span class="pre">--no-comment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no comments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-has-likes">
|
||
<span class="sig-name descname"><span class="pre">--has-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-has-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-no-likes">
|
||
<span class="sig-name descname"><span class="pre">--no-likes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-no-likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with no likes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-is-reference">
|
||
<span class="sig-name descname"><span class="pre">--is-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-is-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that were imported as referenced files (not copied into Photos library).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-reference">
|
||
<span class="sig-name descname"><span class="pre">--not-reference</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not references, that is, they were copied into the Photos library and are managed by Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-in-album">
|
||
<span class="sig-name descname"><span class="pre">--in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in one or more albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-in-album">
|
||
<span class="sig-name descname"><span class="pre">--not-in-album</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-in-album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in any albums.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-duplicate">
|
||
<span class="sig-name descname"><span class="pre">--duplicate</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with possible duplicates. osxphotos will compare signatures of photos, evaluating date created, size, height, width, and edited status to find <em>possible</em> duplicates. This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple times or duplicated within Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-min-size">
|
||
<span class="sig-name descname"><span class="pre">--min-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-min-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size >= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-max-size">
|
||
<span class="sig-name descname"><span class="pre">--max-size</span></span><span class="sig-prename descclassname"> <span class="pre"><SIZE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-max-size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos with size <= SIZE bytes. The size evaluated is the photo’s original size (when imported to Photos). Size may be specified as integer bytes or using SI or NIST units. For example, the following are all valid and equivalent sizes: ‘1048576’ ‘1.048576MB’, ‘1 MiB’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-missing">
|
||
<span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos missing from disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-missing">
|
||
<span class="sig-name descname"><span class="pre">--not-missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos present on disk (e.g. not missing).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-cloudasset">
|
||
<span class="sig-name descname"><span class="pre">--not-cloudasset</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of an iCloud library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-incloud">
|
||
<span class="sig-name descname"><span class="pre">--incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are in iCloud (have been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-incloud">
|
||
<span class="sig-name descname"><span class="pre">--not-incloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not in iCloud (have not been synched)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-syndicated">
|
||
<span class="sig-name descname"><span class="pre">--not-syndicated</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-syndicated" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that have not been shared via syndication (‘Shared with You’ album via Messages, etc.)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-saved-to-library">
|
||
<span class="sig-name descname"><span class="pre">--not-saved-to-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-saved-to-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for syndicated photos that have not saved to the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-shared-moment">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-moment</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-shared-moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared moment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-not-shared-library">
|
||
<span class="sig-name descname"><span class="pre">--not-shared-library</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-not-shared-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos that are not part of a shared library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-regex">
|
||
<span class="sig-name descname"><span class="pre">--regex</span></span><span class="sig-prename descclassname"> <span class="pre"><REGEX</span> <span class="pre">TEMPLATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where TEMPLATE matches regular expression REGEX. For example, to find photos in an album that begins with ‘Beach’: ‘–regex “^Beach” “{album}”’. You may specify more than one regular expression match by repeating ‘–regex’ with different arguments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-selected">
|
||
<span class="sig-name descname"><span class="pre">--selected</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-sync-selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter for photos that are currently selected in Photos.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-exif">
|
||
<span class="sig-name descname"><span class="pre">--exif</span></span><span class="sig-prename descclassname"> <span class="pre"><EXIF_TAG</span> <span class="pre">VALUE></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Search for photos where EXIF_TAG exists in photo’s EXIF data and contains VALUE. For example, to find photos created by Adobe Photoshop: <cite>–exif Software ‘Adobe Photoshop’ `or to find all photos shot on a Canon camera: `–exif Make Canon</cite>. EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. <cite>EXIF:Make</cite> or <cite>Make</cite>. To use –exif, exiftool must be installed and in the path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-query-eval">
|
||
<span class="sig-name descname"><span class="pre">--query-eval</span></span><span class="sig-prename descclassname"> <span class="pre"><CRITERIA></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-query-eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Evaluate CRITERIA to filter photos. CRITERIA will be evaluated in context of the following python list comprehension: <cite>photos = [photo for photo in photos if CRITERIA]</cite> where photo represents a PhotoInfo object. For example: <cite>–query-eval photo.favorite</cite> returns all photos that have been favorited and is equivalent to –favorite. You may specify more than one CRITERIA by using –query-eval multiple times. CRITERIA must be a valid python expression. See <a class="reference external" href="https://rhettbull.github.io/osxphotos/">https://rhettbull.github.io/osxphotos/</a> for additional documentation on the PhotoInfo class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-query-function">
|
||
<span class="sig-name descname"><span class="pre">--query-function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-query-function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run function to filter photos. Use this in format: –query-function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. You may use more than one function by repeating the –query-function option with a different value. Your query function will be called after all other query options have been evaluated. See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-library">
|
||
<span id="cmdoption-osxphotos-sync-db"></span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--db</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-library" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify path to Photos library. If not 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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-sync-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-sync-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-theme">
|
||
<h3>theme<a class="headerlink" href="#osxphotos-theme" title="Permalink to this heading">#</a></h3>
|
||
<p>Manage osxphotos color themes.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos theme <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-default">
|
||
<span class="sig-name descname"><span class="pre">--default</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-theme-default" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Show default theme.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-list">
|
||
<span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-theme-list" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>List all themes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-config">
|
||
<span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print configuration for THEME (or default theme if not specified).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-preview">
|
||
<span class="sig-name descname"><span class="pre">--preview</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-preview" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Preview THEME (or default theme if not specified).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-edit">
|
||
<span class="sig-name descname"><span class="pre">--edit</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Edit THEME (or default theme if not specified).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-clone">
|
||
<span class="sig-name descname"><span class="pre">--clone</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME</span> <span class="pre">NEW_THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-clone" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Clone THEME to NEW_THEME.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-theme-delete">
|
||
<span class="sig-name descname"><span class="pre">--delete</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-theme-delete" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Delete THEME.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-timewarp">
|
||
<h3>timewarp<a class="headerlink" href="#osxphotos-timewarp" title="Permalink to this heading">#</a></h3>
|
||
<p>Adjust date/time/timezone of photos in Apple Photos.</p>
|
||
<p>Changes will be applied to all photos currently selected in Photos.
|
||
timewarp cannot operate on photos selected in a Smart Album;
|
||
select photos in a regular album or in the ‘All Photos’ view.
|
||
See Timewarp Overview below for additional information.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos timewarp <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-d">
|
||
<span id="cmdoption-osxphotos-timewarp-date"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--date</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-d" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set date for selected photos. Format is ‘YYYY-MM-DD’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-D">
|
||
<span id="cmdoption-osxphotos-timewarp-date-delta"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--date-delta</span></span><span class="sig-prename descclassname"> <span class="pre"><DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-D" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Adjust date for selected photos by DELTA. Format is one of: ‘±D days’, ‘±W weeks’, ‘±D’ where D is days</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-t">
|
||
<span id="cmdoption-osxphotos-timewarp-time"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time</span></span><span class="sig-prename descclassname"> <span class="pre"><TIME></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-t" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set time for selected photos. Format is one of ‘HH:MM:SS’, ‘HH:MM:SS.fff’, ‘HH:MM’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-T">
|
||
<span id="cmdoption-osxphotos-timewarp-time-delta"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-delta</span></span><span class="sig-prename descclassname"> <span class="pre"><DELTA></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-T" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Adjust time for selected photos by DELTA time. Format is one of ‘±HH:MM:SS’, ‘±H hours’ (or hr), ‘±M minutes’ (or min), ‘±S seconds’ (or sec), ‘±S’ (where S is seconds)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-z">
|
||
<span id="cmdoption-osxphotos-timewarp-timezone"></span><span class="sig-name descname"><span class="pre">-z</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timezone</span></span><span class="sig-prename descclassname"> <span class="pre"><TIMEZONE></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-z" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set timezone for selected photos as offset from UTC. Format is one of ‘±HH:MM’, ‘±H:MM’, or ‘±HHMM’. The actual time of the photo is not adjusted which means, somewhat counterintuitively, that the time in the new timezone will be different. For example, if photo has time of 12:00 and timezone of GMT+01:00 and new timezone is specified as ‘–timezone +02:00’ (one hour ahead of current GMT+01:00 timezone), the photo’s new time will be 13:00 GMT+02:00, which is equivalent to the old time of 12:00+01:00. This is the same behavior exhibited by Photos when manually adjusting timezone in the Get Info window. See also –match-time.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-date-added">
|
||
<span class="sig-name descname"><span class="pre">--date-added</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-date-added" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set date/time added for selected photos. This changes the date added or imported date in Photos but does not change the date/time/timezone of the photo itself. This is useful for removing photos from the Recents album, for example if you have imported old scanned photos. Format is ‘YYYY-MM-DD’ or ‘YYYY-MM-DD HH:MM:SS’. If time is not included, midnight is assumed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-date-added-from-photo">
|
||
<span class="sig-name descname"><span class="pre">--date-added-from-photo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-date-added-from-photo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set date/time added for selected photos to the date/time the photo was taken. This changes the date added or imported date in Photos but does not change the date/time/timezone of the photo itself.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-i">
|
||
<span id="cmdoption-osxphotos-timewarp-inspect"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--inspect</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-i" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print out the date/time/timezone for each selected photo without changing any information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-c">
|
||
<span id="cmdoption-osxphotos-timewarp-compare-exif"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--compare-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-c" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Compare the EXIF date/time/timezone for each selected photo to the same data in Photos. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). See also –add-to-album.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-p">
|
||
<span id="cmdoption-osxphotos-timewarp-push-exif"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--push-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-p" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Push date/time and timezone for selected photos from Photos to the EXIF metadata in the original file in the Photos library. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). Using this option modifies the <em>original</em> file of the image in your Photos library. –push-exif will be executed after any other updates are performed on the photo. See also –pull-exif.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-P">
|
||
<span id="cmdoption-osxphotos-timewarp-pull-exif"></span><span class="sig-name descname"><span class="pre">-P</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--pull-exif</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-P" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Pull date/time and timezone for selected photos from EXIF metadata in the original file into Photos and update the associated data in Photos to match the EXIF data. –pull-exif will be executed before any other updates are performed on the photo. It is possible for images to have missing EXIF data, for example the date/time could be set but there might be no timezone set in the EXIF metadata. Missing data will be handled thusly: if date/time/timezone are all present in the EXIF data, the photo’s date/time/timezone will be updated. If timezone is missing but date/time is present, only the photo’s date/time will be updated. If date/time is missing but the timezone is present, only the photo’s timezone will be updated unless –use-file-time is set in which case, the photo’s file modification date/time will be used in place of EXIF date/time. If the date is present but the time is missing, the time will be set to 00:00:00. Requires the third-party exiftool utility be installed (see <a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>). See also –push-exif.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-M">
|
||
<span id="cmdoption-osxphotos-timewarp-m"></span><span id="cmdoption-osxphotos-timewarp-parse-date"></span><span class="sig-name descname"><span class="pre">-M</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--parse-date</span></span><span class="sig-prename descclassname"> <span class="pre"><DATE_PATTERN></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-M" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Parse date from filename using DATE_PATTERN and set photo’s date to match. If file does not match DATE_PATTERN, the date will not be changed. DATE_PATTERN is a strptime-compatible pattern with extensions as pattern described below. If DATE_PATTERN matches time zone information, the photo’s timezone will be set to match. For example, if your photos are named ‘IMG_1234_2022_11_23_12_34_56.jpg’ where the date/time is ‘2022-11-23 12:34:56’, you could use the pattern ‘%Y_%m_%d_%H_%M_%S’ or ‘IMG_*_%Y_%m_%d_%H_%M_%S’ to further narrow the pattern to only match files with ‘<a href="#id5"><span class="problematic" id="id6">IMG_xxxx_</span></a>’ in the name.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-F">
|
||
<span id="cmdoption-osxphotos-timewarp-f"></span><span id="cmdoption-osxphotos-timewarp-function"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--function</span></span><span class="sig-prename descclassname"> <span class="pre"><filename.py::function></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-F" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run python function to determine the date/time/timezone to apply to a photo. Use this in format: –function filename.py::function where filename.py is a python file you’ve created and function is the name of the function in the python file you want to call. The function will be passed information about the photo being processed and is expected to return a naive datetime.datetime object with time in local time and UTC timezone offset in seconds. See example function at https://github.com/RhetTbull/osxphotos/blob/master/examples/timewarp_function_example.py</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-0">
|
||
<span id="cmdoption-osxphotos-timewarp-match-time"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--match-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-0" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –timezone, adjusts the photo time so that the timestamp in the new timezone matches the timestamp in the old timezone. For example, if photo has time of 12:00 and timezone of GMT+01:00 and new timezone is specified as ‘–timezone +02:00’ (one hour ahead of current GMT+01:00 timezone), the photo’s new time will be 12:00 GMT+02:00. That is, the timezone will have changed but the timestamp of the photo will match the previous timestamp. Use –match-time when the camera’s time was correct for the time the photo was taken but the timezone was missing or wrong and you want to adjust the timezone while preserving the photo’s time. See also –timezone.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-1">
|
||
<span id="cmdoption-osxphotos-timewarp-use-file-time"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--use-file-time</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-1" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –pull-exif, the file modification date/time will be used if date/time is missing from the EXIF data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-a">
|
||
<span id="cmdoption-osxphotos-timewarp-add-to-album"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--add-to-album</span></span><span class="sig-prename descclassname"> <span class="pre"><ALBUM></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-a" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>When used with –compare-exif, adds any photos with date/time/timezone differences between Photos/EXIF to album ALBUM. If ALBUM does not exist, it will be created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-V">
|
||
<span id="cmdoption-osxphotos-timewarp-v"></span><span id="cmdoption-osxphotos-timewarp-verbose"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-V" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Print verbose output; may be specified multiple times for more verbose output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-timestamp">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-timestamp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-L">
|
||
<span id="cmdoption-osxphotos-timewarp-l"></span><span id="cmdoption-osxphotos-timewarp-library"></span><span class="sig-name descname"><span class="pre">-L</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--library</span></span><span class="sig-prename descclassname"> <span class="pre"><PHOTOS_LIBRARY_PATH></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-L" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Path to Photos library (e.g. ‘~/Pictures/PhotosLibrary.photoslibrary’). This is not likely needed as osxphotos will usually be able to locate the path to the open Photos library. Use –library only if you get an error that the Photos library cannot be located.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-e">
|
||
<span id="cmdoption-osxphotos-timewarp-exiftool-path"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exiftool-path</span></span><span class="sig-prename descclassname"> <span class="pre"><exiftool_path></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-e" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional path to exiftool executable (will look in $PATH if not specified) for those options which require exiftool.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-2">
|
||
<span class="sig-name descname"><span class="pre">--timestamp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-2" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Add time stamp to verbose output</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-theme">
|
||
<span class="sig-name descname"><span class="pre">--theme</span></span><span class="sig-prename descclassname"> <span class="pre"><THEME></span></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-theme" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Specify the color theme to use for output. Valid themes are ‘dark’, ‘light’, ‘mono’, and ‘plain’. Defaults to ‘dark’ or ‘light’ depending on system dark mode setting.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Options<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dark | light | mono | plain</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-plain">
|
||
<span class="sig-name descname"><span class="pre">--plain</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-plain" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Plain text mode. Do not use rich output.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-timewarp-force">
|
||
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-timewarp-force" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Bypass confirmation prompt. Use with caution.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-tutorial">
|
||
<h3>tutorial<a class="headerlink" href="#osxphotos-tutorial" title="Permalink to this heading">#</a></h3>
|
||
<p>Display osxphotos tutorial.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos tutorial <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>WIDTH<span class="o">]</span>...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-tutorial-arg-WIDTH">
|
||
<span id="cmdoption-osxphotos-tutorial-arg-width"></span><span class="sig-name descname"><span class="pre">WIDTH</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-tutorial-arg-WIDTH" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Optional argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-uninstall">
|
||
<h3>uninstall<a class="headerlink" href="#osxphotos-uninstall" title="Permalink to this heading">#</a></h3>
|
||
<p>Uninstall Python packages from the osxphotos environment</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos uninstall <span class="o">[</span>OPTIONS<span class="o">]</span> PACKAGES...
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-uninstall-y">
|
||
<span id="cmdoption-osxphotos-uninstall-yes"></span><span class="sig-name descname"><span class="pre">-y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--yes</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uninstall-y" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Don’t ask for confirmation</p>
|
||
</dd></dl>
|
||
|
||
<p class="rubric">Arguments</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-uninstall-arg-PACKAGES">
|
||
<span id="cmdoption-osxphotos-uninstall-arg-packages"></span><span class="sig-name descname"><span class="pre">PACKAGES</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uninstall-arg-PACKAGES" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Required argument(s)</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-uuid">
|
||
<h3>uuid<a class="headerlink" href="#osxphotos-uuid" title="Permalink to this heading">#</a></h3>
|
||
<p>Print out unique IDs (UUID) of photos selected in Photos</p>
|
||
<p>Prints outs UUIDs in form suitable for –uuid-from-file and –skip-uuid-from-file</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos uuid <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-uuid-f">
|
||
<span id="cmdoption-osxphotos-uuid-filename"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--filename</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-uuid-f" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Include filename of selected photos in output</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="osxphotos-version">
|
||
<h3>version<a class="headerlink" href="#osxphotos-version" title="Permalink to this heading">#</a></h3>
|
||
<p>Check for new version of osxphotos.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos version <span class="o">[</span>OPTIONS<span class="o">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<p class="rubric">Options</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-osxphotos-version-run">
|
||
<span class="sig-name descname"><span class="pre">--run</span></span><span class="sig-prename descclassname"> <span class="pre"><COMMAND></span></span><a class="headerlink" href="#cmdoption-osxphotos-version-run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run COMMAND if there is a new version of osxphotos available.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Usage: python -m osxphotos [OPTIONS] COMMAND [ARGS]...
|
||
|
||
osxphotos: the multi-tool for your Photos library
|
||
|
||
Options:
|
||
-v, --version Show the version and exit.
|
||
-h, --help Show this message and exit.
|
||
|
||
Commands:
|
||
about Print information about osxphotos including license.
|
||
add-locations Add missing location data to photos in Photos.app using...
|
||
albums Print out albums found in the Photos library.
|
||
batch-edit Batch edit photo metadata such as title, description,...
|
||
diff Compare two Photos databases and print out differences
|
||
docs Open osxphotos documentation in your browser.
|
||
dump Print list of all photos & associated info from the...
|
||
exiftool Run exiftool on previously exported files to update...
|
||
export Export photos from the Photos database.
|
||
exportdb Utilities for working with the osxphotos export database
|
||
help Print help; for help on commands: help <command>.
|
||
import Import photos and videos into Photos.
|
||
info Print out descriptive info of the Photos library database.
|
||
inspect Interactively inspect photos selected in Photos.
|
||
install Install Python packages into the same environment as...
|
||
keywords Print out keywords found in the Photos library.
|
||
labels Print out image classification labels found in the...
|
||
list Print list of Photos libraries found on the system.
|
||
orphans Find orphaned photos in a Photos library
|
||
persons Print out persons (faces) found in the Photos library.
|
||
places Print out places found in the Photos library.
|
||
query Query the Photos database using 1 or more search...
|
||
repl Run interactive osxphotos REPL shell (useful for...
|
||
run Run a python file using same environment as osxphotos.
|
||
show Show photo, album, or folder in Photos from UUID_OR_NAME
|
||
snap Create snapshot of Photos database to use with diff command
|
||
sync Sync metadata and albums between Photos libraries.
|
||
theme Manage osxphotos color themes.
|
||
timewarp Adjust date/time/timezone of photos in Apple Photos.
|
||
tutorial Display osxphotos tutorial.
|
||
uninstall Uninstall Python packages from the osxphotos environment
|
||
uuid Print out unique IDs (UUID) of photos selected in Photos
|
||
version Check for new version of osxphotos.
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="template_help.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">OSXPhotos Template System</div>
|
||
</div>
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="tutorial.html">
|
||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">OSXPhotos Tutorial</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2021, Rhet Turnbull
|
||
</div>
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
<div class="icons">
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">OSXPhotos Command Line Interface (CLI)</a><ul>
|
||
<li><a class="reference internal" href="#osxphotos">osxphotos</a><ul>
|
||
<li><a class="reference internal" href="#osxphotos-about">about</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-add-locations">add-locations</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-albums">albums</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-batch-edit">batch-edit</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-diff">diff</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-docs">docs</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-dump">dump</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-exiftool">exiftool</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-export">export</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-exportdb">exportdb</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-help">help</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-import">import</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-info">info</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-inspect">inspect</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-install">install</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-keywords">keywords</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-labels">labels</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-list">list</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-orphans">orphans</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-persons">persons</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-places">places</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-query">query</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-repl">repl</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-run">run</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-show">show</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-snap">snap</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-sync">sync</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-theme">theme</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-timewarp">timewarp</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-tutorial">tutorial</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-uninstall">uninstall</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-uuid">uuid</a></li>
|
||
<li><a class="reference internal" href="#osxphotos-version">version</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/scripts/furo.js"></script>
|
||
<script src="_static/clipboard.min.js"></script>
|
||
<script src="_static/copybutton.js"></script>
|
||
</body>
|
||
</html> |