NAME
    App::DuplicateFilesUtils - CLI utilities related to duplicate files

VERSION
    This document describes version 0.006 of App::DuplicateFilesUtils (from
    Perl distribution App-DuplicateFilesUtils), released on 2026-06-05.

DESCRIPTION
    This distributions provides the following command-line utilities:

    *   move-duplicate-files-to

    *   show-duplicate-files

FUNCTIONS
  move_duplicate_files_to
    Usage:

     move_duplicate_files_to(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Move duplicate files (except one copy) to a directory.

    This utility will find all duplicate sets of files and move all of the
    duplicates (except one) for each set to a directory of your choosing.

    You can specify one or more "--authoritative-dir" options to tell the
    utility on which director(y|ies) should be regarded as the authoritative
    source of files. If among the duplicate set, there is at least one that
    belongs under these directories then the first one of these files will
    be regarded as the authoritative ("original") version and not moved,
    while the others will be regarded as the duplicates and will be moved.
    If none of the duplicate files belong under one of the authoritative
    directories, then a warning will be issued and the first one will be
    picked as the original anyway.

    See also: replace-duplicate-files-with-symlinks to replace the duplicate
    copies with symlinks to the "original", or
    replace-duplicate-files-with-symlinks to replace the duplicate copies
    with hardlinks to the "original".

    See also: show-duplicate-files which lets you manually select which
    copies of the duplicate sets you want to move/delete.

    This function is not exported.

    This function supports dry-run operation.

    Arguments ('*' denotes required arguments):

    *   dir* => *dirname*

        Directory to move duplicate files into.

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  replace_duplicate_files_with_symlinks
    Usage:

     replace_duplicate_files_with_symlinks(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Replace duplicate files (except one copy) with symlinks to the one copy.

    This utility will find all duplicate sets of files and replace all of
    the duplicates (except one) for each set with symlinks to the one copy.

    (CURRENTLY UNIMPLEMENTED) You can specify one or more
    "--authoritative-dir" options to tell the utility on which
    director(y|ies) should be regarded as the authoritative source of files.
    If among the duplicate set, there is at least one that belongs under
    these directories then the first one of these files will be regarded as
    the authoritative ("original") version and not moved, while the others
    will be regarded as the duplicates and will be moved. If none of the
    duplicate files belong under one of the authoritative directories, then
    a warning will be issued and the first one will be picked as the
    original anyway.

    This function is not exported.

    This function supports dry-run operation.

    Arguments ('*' denotes required arguments):

    *   dir* => *dirname*

        Directory to move duplicate files into.

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  show_duplicate_files
    Usage:

     show_duplicate_files() -> [$status_code, $reason, $payload, \%result_meta]

    Show duplicate files.

    This is actually a shortcut for:

     % uniq-files -a --show-count --show-size --report-duplicate=3 --group-by-digest -R .

    Sample output:

     % show-duplicate-files
     +------------------------------+---------+-------+
     | file                         | size    | count |
     +------------------------------+---------+-------+
     | ./tmp2/P_20161001_112707.jpg | 1430261 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(95).JPG      | 1633463 | 2     |
     |                              |         |       |
     | ./tmp2/P_20161009_081735.jpg | 1722586 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(98).JPG      | 1847543 | 3     |
     | ./tmp2/IMG_3430-(98).JPG     | 1847543 | 3     |
     |                              |         |       |
     | ./tmp/IMG_3430-(97).JPG      | 1878472 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(99).JPG      | 1960652 | 3     |
     | ./tmp2/IMG_3430-(99).JPG     | 1960652 | 3     |
     |                              |         |       |
     | ./tmp/IMG_3430-(96).JPG      | 2042952 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(92).JPG      | 2049127 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(94).JPG      | 2109852 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(91).JPG      | 2138724 | 2     |
     |                              |         |       |
     | ./tmp/IMG_3430-(93).JPG      | 2190379 | 2     |
     +------------------------------+---------+-------+

    You can then delete, move the duplicates, or replace them with symlinks
    manually, if you want. But there's also delete-duplicate-files,
    move-duplicate-files-to, replace-duplicate-files-with-symlinks,
    replace-duplicate-files-with-hardlinks.

    If you want more flexibility/customization, use uniq-files or
    Ldupe-files directly.

    This function is not exported.

    No arguments.

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-DuplicateFilesUtils>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-DuplicateFilesUtils>.

SEE ALSO
    uniq-files and dupe-files from App::UniqFiles (which in turn is from
    File::FindUniq).

    find-duplicate-filenames from App::FindUtils, which only check duplicate
    file names and not contents.

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTOR
    perlancar (on pc-home) <perlancar@gmail.com>

CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.

    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via:

     % prove -l

    If you want to build the distribution (e.g. to try to install it locally
    on your system), you can install Dist::Zilla,
    Dist::Zilla::PluginBundle::Author::PERLANCAR,
    Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
    other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
    required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE
    This software is copyright (c) 2026 by perlancar <perlancar@cpan.org>.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-DuplicateFilesUti
    ls>

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

