Skip to main content

Command Line Arguments

Input Path ( -i, --input )

Optional use for copy, archive, info verb. Must be used on address verb. File system path to read & copy photos from. If not given, the current executing folder will be used. There will be no modification on input path.

Output Path ( -o, --output )

Must be used on copy, archive, info verbs. File system path to write output. For copy, new folder hierarchy created on that location with new file names. It will create folder if not exists. For info, report csv file path to write.

Folder Process Type ( -f, --process-type )

Must be used on copy verb. You must select folder process behavior to whether use original folder hierarchy or flatten into single folder/grouped folder by Group By Folder.

OptionName
Single1
SubFoldersPreserveFolderHierarchy2
FlattenAllSubFolders3

Naming Style ( -s, --naming-style )

Must be used on copy verb. While copying to a new organized folder, you must select one of these file naming strategies for a newly copied photo file name.

OptionValue
Numeric1
Day2
DateTimeWithMinutes3
DateTimeWithSeconds4
Address5
DayAddress6
DateTimeWithMinutesAddress7
DateTimeWithSecondsAddress8
AddressDay9
AddressDateTimeWithMinutes10
AddressDateTimeWithSeconds11

Folder Append Type ( -a, --folder-append )

Optional use for copy verb. While copying to a new organized folder (you should select Folder Process Type as SubFoldersPreserveFolderHierarchy ), you may select one of these file folder naming strategies. Must used with Folder Append Location Type

OptionValue
FirstYearMonthDay1
FirstYearMonth2
FirstYear3
DayRange4
MatchingMinimumAddress5

Folder Append Location Type ( -p, --folder-append-location )

Optional use for copy verb. While copying to a new organized folder (you should select Folder Process Type as SubFoldersPreserveFolderHierarchy ), you may select one of these file folder naming strategies. Must used with Folder Append Location

OptionValue
Prefix1
Suffix2

Group By Folder ( -g, --group-by )

Optional use for copy verb. If you want to group photos by EXIF data, you may select one of these strategies.

OptionValue
YearMonthDay1
YearMonth2
Year3
Address4

Number Naming Text Style ( -n, --number-style )

Must be used on copy verb. Number naming strategy when using Naming Style as Numeric or using to numbering the possible same names.

OptionValue
AllNamesAreSameLength1
PaddingZeroCharacter2
OnlySequentialNumbers3

Is Dry Run ( -d, --dry-run )

Optional use for copy, archive verb. Simulate the same process without writing to output folder. No extra parameter needed.

Verify ( -v, --verify)

Optional use for copy verb. Verify that all photo files copied successfully by comparing file hashes. (no extra parameter needed)

Reverse Geocode Provider ( -e, --reverse-geocode )

Optional use for copy, archive, info verb. Must be used on address verb. Third-party provider to resolve photo taken address by photo's coordinates.

OptionValue
BigDataCloud1
OpenStreetMapFoundation2
GoogleMaps3
LocationIq5

Big Data Cloud API Key ( -b, --bigdatacloud-key )

Sets Big Data Cloud reverse geocode API key. Alternatively, you may use the environment variable PHOTO_CLI_BIG_DATA_CLOUD_API_KEY.

Google Maps API Key ( -k, --googlemaps-key )

Sets Google Maps reverse geocode API key. Alternatively, you may use the environment variable PHOTO_CLI_GOOGLE_MAPS_API_KEY.

Location Iq API Key ( -q, --locationiq-key )

Sets Location Iq reverse geocode API key. Alternatively, you may use the environment variable PHOTO_CLI_LOCATIONIQ_API_KEY.

BigDataCloud Admin Levels ( -u, --bigdatacloud-levels )

Must be used when BigDataCloud is selected as reverse geocode provider. Big Data Cloud admin levels are separated with space. ( To see which level correspond to which address level, you may use photo-cli address to see the full response returned from BigDataCloud. )

OpenStreetMapProperties ( -r, --openstreetmap-properties )

Must be used when any of OpenStreetMapFoundation, LocationIq is selected as reverse geocode provider. OpenStreetMap properties separated with space. ( To see which level correspond to which address level, you may use photo-cli address to see the full response returned from OpenStreetMap provider. )

Google Maps Address Types ( -m, --googlemaps-types )

Must be used when GoogleMaps selected as reverse geocode provider. Google Maps address types separated with space. ( To see which level correspond to which address level, you may use photo-cli address to see full the response returned from GoogleMaps. )

Has Paid License ( -h, --has-paid-license )

Bypass the free rate limit if you have paid license. (For LocationIq reverse geocode providers)

No Photograph Taken Date Action [for copy command ] ( -t, --no-taken-date )

Optional use for copy verb. Action to do when a photograph with a no taken date. Default is Continue.

OptionValue
Continue (default)0 (default)
PreventProcess1
DontCopyToOutput2
InSubFolder3
AppendToEndOrderByFileName4
InsertToBeginningOrderByFileName5

No Coordinate Action [for copy command ] ( -c, --no-coordinate )

Optional use for copy verb. Action to do when a photo with a no coordinate.

OptionValue
Continue0
PreventProcess1
DontCopyToOutput2
InSubFolder3

All Folders ( -a, --all-folders )

Optional use for info verb. Read & list all photos in all subfolders.

No Photograph Taken Date Action [for info command ] ( -t, --no-taken-date )

Optional use for info verb. Action to do when a photograph with a no taken date. Default is Continue.

OptionValue
Continue (default)0 (default)
PreventProcess1

No Coordinate Action [for info command ] ( -c, --no-coordinate )

Optional use for info verb. Action to do when a photo with a no coordinate.

OptionValue
Continue0
PreventProcess1

No Photograph Taken Date Action [for archive command ] ( -t, --no-taken-date )

Optional use for archive verb. Action to do when a photograph with a no taken date. Default is Continue.

OptionValue
Continue (default)0 (default)
PreventProcess1

No Coordinate Action [for archive command ] ( -c, --no-coordinate )

Optional use for archive verb. Action to do when a photo with a no coordinate.

OptionValue
Continue0
PreventProcess1