fd/README.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

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-05-13 10:21:38 +02:00
*fd* is a simple, fast and user-friendly alternative to [*find*](https://www.gnu.org/software/findutils/).
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-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').
* Ignores hidden directories and files by default.
* Colorized terminal output (similar to *ls*).
* Regular expressions by default.
2017-05-12 19:21:26 +02:00
* Unicode-aware.
2017-05-13 10:21:38 +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-05-13 00:08:41 +02:00
<a href="https://asciinema.org/a/120318" target="_blank"><img src="https://asciinema.org/a/120318.png" width="600" align="center" /></a>
2017-05-09 23:35:34 +02:00
2017-05-09 23:29:14 +02:00
## Build
```bash
2017-05-12 14:16:34 +02:00
cargo build --release
2017-05-09 23:29:14 +02:00
```
2017-05-13 00:05:00 +02:00
## Install
```
cargo install
```
The release page also includes precompiled binaries for Linux.