Clineup

Clineup (pronounced "clean up") is the fusion of "CLI" (Command-Line Interface) and "clean up."

It is a Rust-based CLI utility aimed at providing pragmatic programmable media rearrangement.

Inspired by Elodie but with some differences and extra-features :

```sh Clineup Utility tool for organizing media

USAGE: clineup [FLAGS] [OPTIONS] --destination --source

FLAGS: --calendar Specifies a calendar (.ics) to use for %event --config-file Specifies the path of the configuration file --drop-duplicates Drop duplicates depending on the strategy --dry-run Performs a dry run without actually moving or renaming any files --dry-run-number-of-files Specifies the number of files to be processed by the dry run --folder-format Specifies the folder format to create --gps-optimization Round the lat ang long to 1 decimal places. It becomes less accurate (about 1 kilometer) but can save a lot of API calls. -h, --help Prints help information --recursive Performs the organization process recursively on subdirectories -V, --version Prints version information -v Sets the log level to increase verbosity

OPTIONS: --destination Specifies the destination directory where the organized photos will be stored

    --exclude_extension <EXTENSION>            Excludes photos with the specified file extensions
    --extension <EXTENSION>                    Filters photos based on file extensions
    --filename-format <filename-format>        Specifies the filename format to create
    --log <LOG_FILE>                           Specifies a log file to record the organization process
    --nominatim-email <nominatim-email>
        Email to use for nominatim API. This is mandatory following the nominatim usage policy

    --reverse-geocoding <reverse-geocoding>    Reverse geocoding provider to use [possible values: nominatim]
    --size-greater <SIZE>
        Filters photos greater than the specified size. Use 'KB', 'MB', 'GB', 'TB' or 'PB'

    --size-lower <SIZE>
        Filters photos lower than the specified size. Use 'KB', 'MB', 'GB', 'TB' or 'PB'

    --source <SOURCE>                          Specifies the source directory or file to be organized
    --strategy <strategy>
        Specifies the organization strategy [default: copy]  [possible values: copy, symlink, move]

```

Tags

| Tag | Meaning | |--------------------|----------------------------------------| | %year | Year of the modification date | | %month | Month of the modification date | | %day | Day of the modification date | | %width | Width of the media | | %height | Height of the media | | %cameramodel | Camera model | | %camerabrand | Camera brand | | %country | Country where the photo was taken | | %state | State where the photo was taken | | %county | county where the photo was taken | | %municipality | municipality where the photo was taken | | %city | city where the photo was taken | | %event | Event to link to (need an icalendar) | | %originalfolder | Original folder where the media is | | %originalfilename | Original filename of the media |

Syntax

The syntax to respect is the following :

  1. Direct Placeholder: You can use the % symbol followed by the tag name directly, like %year or %month.

  2. Escaped Placeholder: If you want to escape the tag and prevent unintended interpretation, you can use curly braces {}. For example, {%year}_{%month} will be treated as separate placeholders %year and %month.

  3. Fallback Placeholder: You can define fallback values for a placeholder using the pipe | symbol. If the primary tag fails to be found, the library will automatically try the next fallback tag, and so on. If all fallbacks fail, the library will use the specified fallback string. For example, {%year|%customyear|Unknown year} will try %year, then %customyear, and finally, if both fail, it will use the fallback "Unknown year".

Example

{%year}/{%month|Custom month}/%camera_brand/{%city|Unknown city} could be replaced these ways :

TODO