2017-05-12 09:50:03 +00:00
# fd
2017-05-12 12:16:34 +00:00
[![Build Status ](https://travis-ci.org/sharkdp/fd.svg?branch=master )](https://travis-ci.org/sharkdp/fd)
2017-06-02 18:34:02 +00:00
*fd* is a simple, fast and user-friendly alternative to
[*find* ](https://www.gnu.org/software/findutils/ ).
2017-05-13 08:21:38 +00:00
2017-06-02 18:34:02 +00: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 21:45:02 +00:00
2017-05-12 12:16:34 +00:00
## Features
* Convenient syntax: `fd PATTERN` instead of `find -iname '*PATTERN*'` .
2017-05-13 08:21:38 +00: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').
* Colorized terminal output (similar to *ls* ).
2017-06-02 18:42:55 +00:00
* Ignores hidden directories and files, by default.
* Ignores patterns from your `.gitignore` , by default.
* Regular expressions.
* Unicode-awareness.
2017-06-02 18:34:02 +00:00
* The command name is *50%* shorter[\*](https://github.com/ggreer/the_silver_searcher) than
`find` :-).
2017-05-09 21:29:14 +00:00
2017-05-12 22:05:00 +00:00
## Demo
2017-05-12 22:07:32 +00:00
2017-05-14 19:58:52 +00:00
![Demo ](http://i.imgur.com/iU6qkQj.gif )
2017-05-09 21:35:34 +00:00
2017-05-14 18:18:17 +00:00
## Colorized output
2017-06-02 18:34:02 +00: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 18:18:17 +00:00
[here ](https://github.com/seebi/dircolors-solarized ) or
[here ](https://github.com/trapd00r/LS_COLORS ).
2017-05-13 08:46:22 +00:00
## Benchmark
2017-06-02 20:23:27 +00:00
A search in my home folder with ~150.000 subdirectories and ~1M files. The given options for
2017-06-09 13:04:40 +00:00
`fd` are needed for a fair comparison (otherwise `fd` is even faster by a factor of 5 because it
2017-06-02 20:23:27 +00:00
does not have to search hidden and ignored paths):
2017-06-09 13:04:40 +00:00
```
benchmarking bench/fd --hidden --no-ignore --full-path '.*[0-9]\.jpg$' ~
time 2.800 s (2.722 s .. 2.895 s)
1.000 R² (1.000 R² .. 1.000 R²)
mean 2.821 s (2.810 s .. 2.831 s)
std dev 16.52 ms (0.0 s .. 17.02 ms)
variance introduced by outliers: 19% (moderately inflated)
2017-05-13 08:46:22 +00:00
2017-06-09 13:04:40 +00:00
benchmarking bench/find ~ -iregex '.*[0-9]\.jpg$'
time 5.593 s (5.412 s .. 5.798 s)
1.000 R² (0.999 R² .. 1.000 R²)
mean 5.542 s (5.502 s .. 5.567 s)
std dev 37.32 ms (0.0 s .. 42.77 ms)
variance introduced by outliers: 19% (moderately inflated)
2017-05-13 08:46:22 +00:00
```
2017-06-09 13:04:40 +00:00
(benchmarking tool: [bench ](https://github.com/Gabriel439/bench ))
Both tools found the exact same 14030 files. Note that we have used the `-iregex` option for `find`
in order for both tools to perform a regular expression search. Both tools are comparably fast if
`-iname '*[0-9].jpg'` is used for `find` .
2017-05-13 08:46:22 +00:00
2017-09-09 15:07:19 +00: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-05-14 18:07:59 +00:00
## Install
2017-06-15 10:25:16 +00:00
With Rust's package manager [cargo ](https://github.com/rust-lang/cargo ), you can clone, build and install *fd* with a single command:
2017-05-14 18:07:59 +00:00
```
cargo install --git https://github.com/sharkdp/fd
```
2017-06-06 18:47:11 +00:00
Note that rust version *1.16.0* or later is required.
2017-05-14 18:07:59 +00:00
The release page of this repository also includes precompiled binaries for Linux.
2017-05-13 08:46:22 +00:00
2017-06-15 10:25:16 +00:00
On **OS X** , you can use [homebrew ](https://brew.sh/ ):
```
brew install fd
```
2017-08-01 16:43:45 +00:00
On **Arch Linux** , you can install the AUR package [fd-rs-git ](https://aur.archlinux.org/packages/fd-rs-git/ ) via yaourt, or manually:
2017-08-01 01:44:29 +00:00
```
git clone https://aur.archlinux.org/fd-rs-git.git
cd fd-rs-git
makepkg -si
```
2017-05-14 18:07:59 +00:00
## Development
2017-05-09 21:29:14 +00:00
```bash
2017-05-12 12:16:34 +00:00
cargo build --release
2017-05-09 21:29:14 +00:00
```