FAQ 5.40 How do I traverse a directory tree?

Do you have a question? Post it now! No Registration Necessary.  Now with pictures!

This is an excerpt from the latest version perlfaq5.pod, which
comes with the standard Perl distribution. These postings aim to
reduce the number of repeated questions as well as allow the community
to review and update the answers. The latest version of the complete
perlfaq is at http://faq.perl.org .


5.40: How do I traverse a directory tree?

    (contributed by brian d foy)

    The "File::Find" module, which comes with Perl, does all of the hard
    work to traverse a directory structure. It comes with Perl. You simply
    call the "find" subroutine with a callback subroutine and the
    directories you want to traverse:

            use File::Find;

            find( \&wanted, @directories );

            sub wanted {
                    # full path in $File::Find::name
                    # just filename in $_
                    ... do whatever you want to do ...

    The "File::Find::Closures", which you can download from CPAN, provides
    many ready-to-use subroutines that you can use with "File::Find".

    The "File::Finder", which you can download from CPAN, can help you
    create the callback subroutine using something closer to the syntax of
    the "find" command-line utility:

            use File::Find;
            use File::Finder;

            my $deep_dirs =

            find( $deep_dirs->as_options, @places );

    The "File::Find::Rule" module, which you can download from CPAN, has a
    similar interface, but does the traversal for you too:

            use File::Find::Rule;

            my @files = File::Find::Rule->file()
                                                             ->name( '*.pm' )
                                                             ->in( @INC );


The perlfaq-workers, a group of volunteers, maintain the perlfaq. They
are not necessarily experts in every domain where Perl might show up,
so please include as much information as possible and relevant in any
corrections. The perlfaq-workers also don't have access to every
operating system or platform, so please include relevant details for
corrections to examples that do not work on particular platforms.
Working code is greatly appreciated.

If you'd like to help maintain the perlfaq, see the details in

Site Timeline