FD(1)                       General Commands Manual                      FD(1)



NNAAMMEE
       fd - find entries in the filesystem

SSYYNNOOPPSSIISS
       ffdd  [--HHIIEEssiiaaLLpp00hhVV]  [--dd  _d_e_p_t_h] [--tt _f_i_l_e_t_y_p_e] [--ee _e_x_t] [--EE _e_x_c_l_u_d_e] [--cc
       _w_h_e_n] [--jj _n_u_m] [--xx _c_m_d] [_p_a_t_t_e_r_n] [_p_a_t_h_._._.]

DDEESSCCRRIIPPTTIIOONN
       ffdd is a simple, fast and user-friendly alternative to ffiinndd(1).

       By default ffdd uses regular expressions for the pattern.  However,  this
       can be changed to use simple glob patterns with the '--glob' option.

OOPPTTIIOONNSS
       --HH,, ----hhiiddddeenn
              Include  hidden  files  and  directories  in  the search results
              (default: hidden files and directories are  skipped).  The  flag
              can be overridden with '--no-hidden'.

       --II,, ----nnoo--iiggnnoorree
              Show search results from files and directories that would other‐
              wise be ignored by

              · _._g_i_t_i_g_n_o_r_e

              · _._g_i_t_/_i_n_f_o_/_e_x_c_l_u_d_e

              · The global gitignore  configuration  (by  default  _$_H_O_M_E_/_._c_o_n_‐
                _f_i_g_/_g_i_t_/_i_g_n_o_r_e)

              · _._i_g_n_o_r_e

              · _._f_d_i_g_n_o_r_e

              · The global fd ignore file (usually _$_H_O_M_E_/_._c_o_n_f_i_g_/_f_d_/_i_g_n_o_r_e )

              The flag can be overridden with '--ignore'.

       --uu,, ----uunnrreessttrriicctteedd
              Alias  for '--no-ignore'. Can be repeated; '-uu' is an alias for
              '--no-ignore --hidden'.

       ----nnoo--iiggnnoorree--vvccss
              Show search results from files and directories that would other‐
              wise   be  ignored  by  gitignore  files  including  _._g_i_t_i_g_n_o_r_e,
              _._g_i_t_/_i_n_f_o_/_e_x_c_l_u_d_e,  and  the  global   gitignore   configuration
              (_c_o_r_e_._e_x_c_l_u_d_e_s_F_i_l_e  git  setting,  which defaults to _$_H_O_M_E_/_._c_o_n_‐
              _f_i_g_/_g_i_t_/_i_g_n_o_r_e).  The flag can  be  overridden  with  '--ignore-
              vcs'.

       ----nnoo--iiggnnoorree--ppaarreenntt
              Show search results from files and directories that would other‐
              wise be ignored by gitignore files in parent directories.

       --ss,, ----ccaassee--sseennssiittiivvee
              Perform a case-sensitive search. By default, fd uses case-insen‐
              sitive  searches, unless the pattern contains an uppercase char‐
              acter (smart case).

       --ii,, ----iiggnnoorree--ccaassee
              Perform a case-insensitive search. By  default,  fd  uses  case-
              insensitive  searches,  unless the pattern contains an uppercase
              character (smart case).

       --gg,, ----gglloobb
              Perform a glob-based search  instead  of  a  regular  expression
              search.   If combined with the '--full-path' option, '**' can be
              used to match multiple path components.

       ----rreeggeexx
              Perform a regular-expression based search (default). This can be
              used to override --glob.

       --FF,, ----ffiixxeedd--ssttrriinnggss
              Treat  the  pattern  as  a  literal  string instead of a regular
              expression. Note that this also performs  substring  comparison.
              If  you  want  to  match  on  an  exact filename, consider using
              '--glob'.

       --aa,, ----aabbssoolluuttee--ppaatthh
              Shows the full path starting from the root as opposed  to  rela‐
              tive paths.  The flag can be overridden with '--relative-path'.

       --ll,, ----lliisstt--ddeettaaiillss
              Use a detailed listing format like 'ls -l'. This is basically an
              alias  for  '--exec-batch  ls  -l'  with  some  additional  'ls'
              options.  This can be used to see more metadata, to show symlink
              targets and to achieve a deterministic sort order.

       --LL,, ----ffoollllooww
              By default, fd does  not  descend  into  symlinked  directories.
              Using this flag, symbolic links are also traversed. The flag can
              be overridden with '--no-follow'.

       --pp,, ----ffuullll--ppaatthh
              By default, the search pattern is only matched against the file‐
              name  (or  directory  name).  Using  this  flag,  the _p_a_t_t_e_r_n is
              matched against the full path.

       --00,, ----pprriinntt00
              Separate search results by the null character (instead  of  new‐
              lines). Useful for piping results to _x_a_r_g_s.

       ----mmaaxx--rreessuullttss ccoouunntt
              Limit  the  number of search results to 'count' and quit immedi‐
              ately.

       --11     Limit the search to a single result and quit  immediately.  This
              is an alias for '--max-results=1'.

       --qq,, ----qquuiieett
              When  the  flag  is present, the program does not print anything
              and will instead exit with a code of 0 if there is at least  one
              search  result.   Otherwise,  the  exit code will be 1.  This is
              mainly for usage in scripts and can be faster than checking  for
              output  because  the search can be stopped early after the first
              match.  ----hhaass--rreessuullttss can be used as an alias.

       ----sshhooww--eerrrroorrss
              Enable the display of filesystem errors for situations  such  as
              insufficient permissions or dead symlinks.

       ----ssttrriipp--ccwwdd--pprreeffiixx
              By  default, relative paths are prefixed with './' when the out‐
              put goes to a non interactive terminal (TTY). Use this  flag  to
              disable this behaviour.

       ----oonnee--ffiillee--ssyysstteemm,, ----mmoouunntt,, ----xxddeevv
              By  default,  fd  will  traverse  the file system tree as far as
              other options dictate. With this flag, fd ensures that  it  does
              not descend into a different file system than the one it started
              in. Comparable to the -mount or -xdev filters of find(1).

       --hh,, ----hheellpp
              Print help information.

       --VV,, ----vveerrssiioonn
              Print version information.

       --dd,, ----mmaaxx--ddeepptthh _d
              Limit directory traversal to at  most  _d  levels  of  depth.  By
              default, there is no limit on the search depth.

       ----mmiinn--ddeepptthh _d
              Only  show search results starting at the given depth. See also:
              '--max-depth' and '--exact-depth'.

       ----eexxaacctt--ddeepptthh _d
              Only show search results at the exact given depth.  This  is  an
              alias for '--min-depth <depth> --max-depth <depth>'.

       ----pprruunnee
              Do not traverse into matching directories.

       --tt,, ----ttyyppee _f_i_l_e_t_y_p_e
              Filter search by type:

              f, file
                     regular files

              d, directory
                     directories

              l, symlink
                     symbolic links

              s, socket
                     sockets

              p, pipe
                     named pipes (FIFOs)

              x, executable
                     executable (files)

              e, empty
                     empty files or directories

              This  option can be specified more than once to include multiple
              file types.  Searching for '--type  file  --type  symlink'  will
              show both regular files as well as symlinks. Note that the 'exe‐
              cutable' and 'empty'  filters  work  differently:  '--type  exe‐
              cutable'  implies  '--type  file' by default. And '--type empty'
              searches for empty files and directories, unless either  '--type
              file' or '--type directory' is specified in addition.

              Examples:
                - Only search for files:
                    fd --type file â¦
                    fd -tf â¦
                - Find both files and symlinks
                    fd --type file --type symlink â¦
                    fd -tf -tl â¦
                - Find executable files:
                    fd --type executable
                    fd -tx
                - Find empty files:
                    fd --type empty --type file
                    fd -te -tf
                - Find empty directories:
                    fd --type empty --type directory
                    fd -te -td

       --ee,, ----eexxtteennssiioonn _e_x_t
              Filter search results by file extension _e_x_t.  This option can be
              used repeatedly to allow for multiple possible file extensions.

              If you want to search for files without extension, you  can  use
              the regex '^[^.]+$' as a normal search pattern.

       --EE,, ----eexxcclluuddee _p_a_t_t_e_r_n
              Exclude  files/directories  that  match  the given glob pattern.
              This overrides any other ignore logic.   Multiple  exclude  pat‐
              terns can be specified.  Examples:
                --exclude '*.pyc'
                --exclude node_modules

       ----iiggnnoorree--ffiillee _p_a_t_h
              Add  a  custom  ignore-file in '.gitignore' format.  These files
              have a low precedence.

       --cc,, ----ccoolloorr _w_h_e_n
              Declare _w_h_e_n to colorize search results:

              auto   Colorize output when standard output is connected to ter‐
                     minal (default).

              never  Do not colorize output.

              always Always colorize output.

       --jj,, ----tthhrreeaaddss _n_u_m
              Set number of threads to use for searching & executing (default:
              number of available CPU cores).

       --SS,, ----ssiizzee _s_i_z_e
              Limit results based on  the  size  of  files  using  the  format
              _<_+_-_>_<_N_U_M_>_<_U_N_I_T_>

              '+'    file size must be greater than or equal to this

              '-'    file size must be less than or equal to this

              If  neither  '+' nor '-' is specified, file size must be exactly
              equal to this.

              'NUM'  The numeric size (e.g. 500)

              'UNIT' The units for NUM. They are not case-sensitive.   Allowed
                     unit values:

                     'b'    bytes

                     'k'    kilobytes (base ten, 10^3 = 1000 bytes)

                     'm'    megabytes

                     'g'    gigabytes

                     't'    terabytes

                     'ki'   kibibytes (base two, 2^10 = 1024 bytes)

                     'mi'   mebibytes

                     'gi'   gibibytes

                     'ti'   tebibytes

       ----cchhaannggeedd--wwiitthhiinn _d_a_t_e_|_d_u_r_a_t_i_o_n
              Filter  results based on the file modification time.  Files with
              modification times greater than the argument will  be  returned.
              The  argument  can be provided as a duration (_1_0_h_, _1_d_, _3_5_m_i_n) or
              as a specific point in time in either full RFC3339  format  with
              time  zone,  or  as  a  date  or datetime in the local time zone
              (_Y_Y_Y_Y_-_M_M_-_D_D or _Y_Y_Y_Y_-_M_M_-_D_D _H_H_:_M_M_:_S_S).  ----cchhaannggee--nneewweerr--tthhaann can be
              used as an alias.

              Examples:
                --changed-within 2weeks
                --change-newer-than "2018-10-27 10:00:00"

       ----cchhaannggeedd--bbeeffoorree _d_a_t_e_|_d_u_r_a_t_i_o_n
              Filter  results based on the file modification time.  Files with
              modification times less than the argument will be returned.  The
              argument  can be provided as a duration (_1_0_h_, _1_d_, _3_5_m_i_n) or as a
              specific point in time in either full RFC3339 format  with  time
              zone,  or as a date or datetime in the local time zone (_Y_Y_Y_Y_-_M_M_-
              _D_D or _Y_Y_Y_Y_-_M_M_-_D_D _H_H_:_M_M_:_S_S).  ----cchhaannggee--oollddeerr--tthhaann can be used  as
              an alias.

              Examples:
                --changed-before "2018-10-27 10:00:00"
                --change-older-than 2weeks

       --oo,, ----oowwnneerr _[_u_s_e_r_]_[_:_g_r_o_u_p_]
              Filter    files    by   their   user   and/or   group.   Format:
              [(user|uid)][:(group|gid)]. Either  side  is  optional.  Precede
              either side with a '!' to exclude files instead.

              Examples:
                --owner john
                --owner :students
                --owner "!john:students"

       ----bbaassee--ddiirreeccttoorryy _p_a_t_h
              Change the current working directory of fd to the provided path.
              This means that search results will be shown with respect to the
              given base path. Note that relative paths which are passed to fd
              via the positional _p_a_t_h argument  or  the  ----sseeaarrcchh--ppaatthh  option
              will also be resolved relative to this directory.

       ----ppaatthh--sseeppaarraattoorr _s_e_p_a_r_a_t_o_r
              Set  the  path  separator  to  use when printing file paths. The
              default is the OS-specific separator ('/' on Unix, '\'  on  Win‐
              dows).

       ----sseeaarrcchh--ppaatthh _s_e_a_r_c_h_-_p_a_t_h
              Provide paths to search as an alternative to the positional _p_a_t_h
              argument. Changes the usage to ´fd [FLAGS/OPTIONS] --search-path
              PATH --search-path PATH2 [PATTERN]´

       --xx,, ----eexxeecc _c_o_m_m_a_n_d
              Execute   _c_o_m_m_a_n_d  for  each  search  result  in  parallel  (use
              --threads=1 for sequential command execution).

              Note that all subsequent positional arguments are considered  to
              be arguments to the _c_o_m_m_a_n_d - not to fd.  It is therefore recom‐
              mended to place the -x/--exec option  last.  Alternatively,  you
              can  supply a ';' argument to end the argument list and continue
              with more fd options.  Most shells require ';'  to  be  escaped:
              '\;'.   This  option  can  be specified multiple times, in which
              case all commands are run for each file found, in the order they
              are  provided.  In that case, you must supply a ';' argument for
              all but the last commands.

              The following placeholders are substituted before the command is
              executed:

                     {}     path (of the current search result)

                     {/}    basename

                     {//}   parent directory

                     {.}    path without file extension

                     {/.}   basename without file extension

              If  no  placeholder  is  present, an implicit "{}" at the end is
              assumed.

              Examples:

                - find all *.zip files and unzip them:

                      fd -e zip -x unzip

                - find *.h and *.cpp files and run "clang-format  -i  .."  for
              each of them:

                      fd -e h -e cpp -x clang-format -i

                - Convert all *.jpg files to *.png files:

                      fd -e jpg -x convert {} {.}.png

       --XX,, ----eexxeecc--bbaattcchh _c_o_m_m_a_n_d
              Execute _c_o_m_m_a_n_d once, with all search results as arguments.  One
              of the following placeholders is substituted before the  command
              is executed:

                     {}     path (of all search results)

                     {/}    basename

                     {//}   parent directory

                     {.}    path without file extension

                     {/.}   basename without file extension

              If  no  placeholder  is  present, an implicit "{}" at the end is
              assumed.

              Like --exec, this can be used multiple times, in which case each
              command will be run in the order given.

              Examples:

                - Find all test_*.py files and open them in your favorite edi‐
              tor:

                      fd -g 'test_*.py' -X vim

                  Note that this executes a  single  "vim"  process  with  all
              search results as arguments.

                - Find all *.rs files and count the lines with "wc -l ...":

                      fd -e rs -X wc -l

       ----bbaattcchh--ssiizzee _s_i_z_e
              Maximum  number  of  arguments to pass to the command given with
              -X. If the number of results is greater than the given size, the
              command  given  with -X is run again with remaining arguments. A
              batch size of zero means there is no limit.

PPAATTTTEERRNN SSYYNNTTAAXX
       The regular expression syntax used by fd is documented here:

           https://docs.rs/regex/1.0.0/regex/#syntax

       The glob syntax is documented here:

           https://docs.rs/globset/#syntax

EENNVVIIRROONNMMEENNTT
       LLSS__CCOOLLOORRSS
              Determines how to colorize search results, see ddiirrccoolloorrss(1)..

       NNOO__CCOOLLOORR
              Disables colorized output.

       XXDDGG__CCOONNFFIIGG__HHOOMMEE,, HHOOMMEE
              Used to locate the global ignore  file.  If  XXDDGG__CCOONNFFIIGG__HHOOMMEE  is
              set, use _$_X_D_G___C_O_N_F_I_G___H_O_M_E_/_f_d_/_i_g_n_o_r_e.  Otherwise, use _$_H_O_M_E_/_._c_o_n_‐
              _f_i_g_/_f_d_/_i_g_n_o_r_e.

EEXXAAMMPPLLEESS
       Find files and directories that match the pattern '_n_e_e_d_l_e':
              $ fd needle

       Start a search in a given directory (_/_v_a_r_/_l_o_g):
              $ fd nginx /var/log

       Find all Python files (all files with the extension _._p_y) in the current
       directory:
              $ fd -e py

       Open all search results with vim:
              $ fd pattern -X vim

       ----bbaattcchh--ssiizzee _s_i_z_e
              Pass  at  most  _s_i_z_e arguments to each call to the command given
              with -X.


       SSEEEE AALLSSOO
              ffiinndd(1)



                                                                         FD(1)
