2017-05-12 11:50:03 +02:00
# fd
2017-05-12 14:16:34 +02:00
[![Build Status ](https://travis-ci.org/sharkdp/fd.svg?branch=master )](https://travis-ci.org/sharkdp/fd)
2017-06-02 20:34:02 +02:00
*fd* is a simple, fast and user-friendly alternative to
[*find* ](https://www.gnu.org/software/findutils/ ).
2017-05-13 10:21:38 +02:00
2017-06-02 20:34:02 +02:00
While it does not seek to mirror all of *find* 's powerful functionality, it provides sensible
(opinionated) defaults for [80% ](https://en.wikipedia.org/wiki/Pareto_principle ) of the use cases.
2017-05-09 23:45:02 +02:00
2017-05-12 14:16:34 +02:00
## Features
* Convenient syntax: `fd PATTERN` instead of `find -iname '*PATTERN*'` .
2017-09-09 18:29:11 +02:00
* Colorized terminal output (similar to *ls* ).
* It's *fast* (see benchmarks below).
2017-05-13 10:21:38 +02:00
* Smart case: the search is case-insensitive by default. It switches to
case-sensitive if the pattern contains an uppercase
character[\*](http://vimdoc.sourceforge.net/htmldoc/options.html#'smartcase').
2017-06-02 20:42:55 +02:00
* Ignores hidden directories and files, by default.
* Ignores patterns from your `.gitignore` , by default.
* Regular expressions.
* Unicode-awareness.
2017-06-02 20:34:02 +02:00
* The command name is *50%* shorter[\*](https://github.com/ggreer/the_silver_searcher) than
`find` :-).
2017-05-09 23:29:14 +02:00
2017-05-13 00:05:00 +02:00
## Demo
2017-05-13 00:07:32 +02:00
2017-09-09 20:39:41 +02:00
![Demo ](http://i.imgur.com/kTMFSVU.gif )
2017-05-09 23:35:34 +02:00
2017-05-14 20:18:17 +02:00
## Colorized output
2017-06-02 20:34:02 +02:00
`fd` can colorize files by extension, just like `ls` . In order for this to work, the environment
variable [`LS_COLORS` ](https://linux.die.net/man/5/dir_colors ) has to be set. Typically, the value
of this variable is set by the `dircolors` command which provides a convenient configuration format
to define colors for different file formats.
On most distributions, `LS_COLORS` should be set already. If you are looking for alternative, more
complete (and more colorful) variants, see
2017-05-14 20:18:17 +02:00
[here ](https://github.com/seebi/dircolors-solarized ) or
[here ](https://github.com/trapd00r/LS_COLORS ).
2017-05-13 10:46:22 +02:00
## Benchmark
2017-09-09 18:29:11 +02:00
Let's search my home folder for files that end in `[0-9].jpg` . It contains ~150.000
subdirectories and about a million files. For averaging and statistical analysis, I'm using
[bench ](https://github.com/Gabriel439/bench ). All benchmarks are performed for a "warm
cache". Results for a cold cache are similar.
Let's start with `find` :
2017-06-09 15:04:40 +02:00
```
2017-09-09 18:29:11 +02:00
find ~ -iregex '.*[0-9]\.jpg$'
time 6.265 s (6.127 s .. NaN s)
2017-06-09 15:04:40 +02:00
1.000 R² (1.000 R² .. 1.000 R²)
2017-09-09 18:29:11 +02:00
mean 6.162 s (6.140 s .. 6.181 s)
std dev 31.73 ms (0.0 s .. 33.48 ms)
```
`find` is much faster if it does not need to perform a regular-expression search:
```
find ~ -iname '*[0-9].jpg'
2017-05-13 10:46:22 +02:00
2017-09-09 18:29:11 +02:00
time 2.866 s (2.754 s .. 2.964 s)
2017-06-09 15:04:40 +02:00
1.000 R² (0.999 R² .. 1.000 R²)
2017-09-09 18:29:11 +02:00
mean 2.860 s (2.834 s .. 2.875 s)
std dev 23.11 ms (0.0 s .. 25.09 ms)
```
Now let's try the same for `fd` . Note that `fd` *always* performs a regular expression
search. The options `--hidden` and `--no-ignore` are needed for a fair comparison,
otherwise `fd` does not have to traverse hidden folders and ignored paths (see below):
```
fd --hidden --no-ignore '.*[0-9]\.jpg$' ~
time 892.6 ms (839.0 ms .. 915.4 ms)
0.999 R² (0.997 R² .. 1.000 R²)
mean 871.2 ms (857.9 ms .. 881.3 ms)
std dev 15.50 ms (0.0 s .. 17.49 ms)
```
For this particular example, `fd` is approximately seven times faster than `find -iregex`
and about three times faster than `find -iname` . By the way, both tools found the exact
same 14030 files :smile:.
Finally, let's run `fd` without `--hidden` and `--no-ignore` (this can lead to different
search results, of course):
```
fd '[0-9]\.jpg$' ~
time 159.5 ms (155.8 ms .. 165.3 ms)
0.999 R² (0.996 R² .. 1.000 R²)
mean 158.7 ms (156.5 ms .. 161.6 ms)
std dev 3.263 ms (2.401 ms .. 4.298 ms)
2017-05-13 10:46:22 +02:00
```
2017-06-09 15:04:40 +02:00
2017-09-09 18:29:11 +02:00
**Note**: This is *one particular* benchmark on *one particular* machine. While I have
performed quite a lot of different tests (and found consistent results), things might
be different for you! I encourage everyone to try it out on their own.
2017-05-13 10:46:22 +02:00
2017-09-09 18:29:11 +02:00
Concerning *fd* 's speed, the main credit goes to the `regex` and `ignore` crates that are also used
in [ripgrep ](https://github.com/BurntSushi/ripgrep ) (check it out!).
2017-09-09 17:07:19 +02:00
2017-05-14 20:07:59 +02:00
## Install
2017-09-09 19:34:51 +02:00
With Rust's package manager [cargo ](https://github.com/rust-lang/cargo ), you can install *fd* via:
2017-05-14 20:07:59 +02:00
```
2017-09-09 19:34:51 +02:00
cargo install fd-find
2017-05-14 20:07:59 +02:00
```
2017-06-06 20:47:11 +02:00
Note that rust version *1.16.0* or later is required.
2017-05-14 20:07:59 +02:00
The release page of this repository also includes precompiled binaries for Linux.
2017-05-13 10:46:22 +02:00
2017-09-10 09:49:53 +02:00
On **macOS** , you can use [Homebrew ](http://braumeister.org/formula/fd ):
2017-06-15 12:25:16 +02:00
```
brew install fd
```
2017-09-13 19:30:42 +02:00
On **Arch Linux** , you can install the AUR package [fd-rs ](https://aur.archlinux.org/packages/fd-rs/ ) (for the stable version) or [fd-rs-git ](https://aur.archlinux.org/packages/fd-rs-git/ ) (for the current master) via yaourt, or manually:
2017-08-01 03:44:29 +02:00
```
2017-09-13 19:30:42 +02:00
git clone https://aur.archlinux.org/fd-rs.git
cd fd-rs
2017-08-01 03:44:29 +02:00
makepkg -si
```
2017-05-14 20:07:59 +02:00
## Development
2017-05-09 23:29:14 +02:00
```bash
2017-09-09 18:56:03 +02:00
git clone https://github.com/sharkdp/fd
# Build
cd fd
cargo build
# Run unit tests
cargo test
# Run integration tests
cd tests
bash test.sh
# Install
cargo install
2017-05-09 23:29:14 +02:00
```
2017-09-09 19:32:30 +02:00
## Command-line options
```
USAGE:
fd [FLAGS/OPTIONS] [< pattern > ] [< path > ]
FLAGS:
-s, --case-sensitive Case-sensitive search (default: smart case)
-p, --full-path Search full path (default: file-/dirname only)
-H, --hidden Search hidden files and directories
-I, --no-ignore Do not respect .(git)ignore files
-L, --follow Follow symlinks
-0, --print0 Separate results by the null character
-a, --absolute-path Show absolute instead of relative paths
-n, --no-color Do not colorize output
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-d, --max-depth < depth > Set maximum search depth (default: none)
-j, --threads < threads > The number of threads used for searching
2017-09-17 09:45:54 +02:00
-t, --type < file-type > The type of file to search for [values: f, file,
d, directory, s, symlink]
2017-09-09 19:32:30 +02:00
ARGS:
< pattern > the search pattern, a regular expression (optional)
< path > the root directory for the filesystem search (optional)
```