<div align="center">
`bfs`
=====
<a href="https://github.com/tavianator/bfs/releases"><img src="https://img.shields.io/github/v/tag/tavianator/bfs?label=version" alt="Version" align="left"></a>
<a href="/LICENSE"><img src="https://img.shields.io/badge/license-0BSD-blue.svg" alt="License" align="left"></a>
<a href="https://github.com/tavianator/bfs/actions/workflows/ci.yml"><img src="https://img.shields.io/github/workflow/status/tavianator/bfs/CI?label=CI" alt="CI Status" align="right"></a>
<a href="https://codecov.io/gh/tavianator/bfs"><img src="https://img.shields.io/codecov/c/github/tavianator/bfs?token=PpBVuozOVC" alt="Code coverage" align="right"/></a>
***Breadth-first search for your files.***
[ **[Features](#features)** ] 
[ **[Installation](#installation)** ] 
[ **[Usage](/docs/USAGE.md)** ] 
[ **[Building](/docs/BUILDING.md)** ] 
[ **[Hacking](/docs/HACKING.md)** ] 
[ **[Changelog](/docs/CHANGELOG.md)** ]
<img src="https://tavianator.github.io/bfs/animation.svg" alt="Screenshot">
<p></p>
</div>
`bfs` is a variant of the UNIX `find` command that operates [**breadth-first**](https://en.wikipedia.org/wiki/Breadth-first_search) rather than [**depth-first**](https://en.wikipedia.org/wiki/Depth-first_search).
It is otherwise compatible with many versions of `find`, including
<div align="center">
[ **[POSIX](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/find.html)** ] 
[ **[GNU](https://www.gnu.org/software/findutils/)** ] 
[ **[FreeBSD](https://www.freebsd.org/cgi/man.cgi?find(1))** ] 
[ **[OpenBSD](https://man.openbsd.org/find.1)** ] 
[ **[NetBSD](https://man.netbsd.org/find.1)** ] 
[ **[macOS](https://ss64.com/osx/find.html)** ]
</div>
If you're not familiar with `find`, the [GNU find manual](https://www.gnu.org/software/findutils/manual/html_mono/find.html) provides a good introduction.
Features
--------
<details>
<summary>
<code>bfs</code> operates breadth-first, which typically finds the file(s) you're looking for faster.
<p></p>
</summary>
Imagine the following directory tree:
<pre>
haystack
├── deep
│ └── 1
│ └── 2
│ └── 3
│ └── 4
│ └── ...
└── shallow
└── <strong>needle</strong>
</pre>
`find` will explore the entire `deep` directory tree before it ever gets to the `shallow` one that contains what you're looking for.
<pre>
$ <strong>find</strong> haystack
haystack
haystack/deep
haystack/deep/1
haystack/deep/1/2
haystack/deep/1/2/3
haystack/deep/1/2/3/4
...
haystack/shallow
<strong>haystack/shallow/needle</strong>
</pre>
On the other hand, `bfs` lists files from shallowest to deepest, so you never have to wait for it to explore an entire unrelated subtree.
<pre>
$ <strong>bfs</strong> haystack
haystack
haystack/deep
haystack/shallow
haystack/deep/1
<strong>haystack/shallow/needle</strong>
haystack/deep/1/2
haystack/deep/1/2/3
haystack/deep/1/2/3/4
...
</pre>
</details>
<details>
<summary>
<code>bfs</code> tries to be easier to use than <code>find</code>, while remaining compatible.
<p></p>
</summary>
For example, `bfs` is less picky about where you put its arguments:
<table>
<tbody>
<tr></tr>
<tr>
<td width="506">
```console
$ bfs -L -name 'needle' haystack
haystack/needle
$ bfs haystack -L -name 'needle'
haystack/needle
$ bfs -L haystack -name 'needle'
haystack/needle
```
</td>
<td width="506">
```console
$ find -L -name 'needle' haystack
find: paths must precede expression: haystack
$ find haystack -L -name 'needle'
find: unknown predicate `-L'
$ find -L haystack -name 'needle'
haystack/needle
```
</td>
</tr>
</tbody>
</table>
</details>
<details>
<summary>
<code>bfs</code> gives helpful errors and warnings.
<p></p>
</summary>
For example, `bfs` will detect and suggest corrections for typos:
<pre>
$ bfs -nam needle
<strong>bfs: error:</strong> bfs <strong>-nam</strong> needle
<strong>bfs: error:</strong> <strong>~~~~</strong>
<strong>bfs: error:</strong> Unknown argument; did you mean <strong>-name</strong>?
</pre>
`bfs` also includes a powerful static analysis to help catch mistakes:
<pre>
$ bfs -print -name 'needle'
<strong>bfs: warning:</strong> bfs -print <strong>-name needle</strong>
<strong>bfs: warning:</strong> <strong>~~~~~~~~~~~~</strong>
<strong>bfs: warning:</strong> The result of this expression is ignored.
</pre>
</details>
<details>
<summary>
<code>bfs</code> adds some options that make common tasks easier.
<p></p>
</summary>
For example, the `-exclude` operator skips over entire subtrees whenever an expression matches.
`-exclude` is both more powerful and easier to use than the standard `-prune` action; compare
<pre>
$ bfs -name config <strong>-exclude -name .git</strong>
</pre>
to the equivalent
<pre>
$ find <strong>! \( -name .git -prune \)</strong> -name config
</pre>
As an additional shorthand, `-nohidden` skips over all hidden files and directories.
See the [usage documentation](/docs/USAGE.md#extensions) for more about the extensions provided by `bfs`.
</details>
Installation
------------
<details open>
<summary>
<code>bfs</code> may already be packaged for your operating system.
<p></p>
</summary>
<pre>
<strong><a href="https://pkgs.alpinelinux.org/packages?name=bfs">Alpine Linux</a></strong>
# apk add bfs
<strong><a href="https://aur.archlinux.org/packages/bfs">Arch Linux</a></strong>
(Available in the AUR)
<strong><a href="https://packages.debian.org/sid/bfs">Debian</a>/<a href="https://packages.ubuntu.com/kinetic/bfs">Ubuntu</a></strong>
# apt install bfs
<strong><a href="https://search.nixos.org/packages?channel=unstable&show=bfs&from=0&size=1&sort=relevance&type=packages&query=bfs">NixOS</a></strong>
# nix-env -i bfs
<strong><a href="https://voidlinux.org/packages/?arch=x86_64&q=bfs">Void Linux</a></strong>
# xbps-install -S bfs
<strong><a href="https://www.freshports.org/sysutils/bfs">FreeBSD</a></strong>
# pkg install bfs
<strong><a href="https://ports.macports.org/port/bfs/">MacPorts</a></strong>
# port install bfs
<strong><a href="https://github.com/tavianator/homebrew-tap/blob/master/Formula/bfs.rb">Homebrew</a></strong>
$ brew install tavianator/tap/bfs
</pre>
</details>
<details>
<summary>
To build <code>bfs</code> from source, you may need to install some dependencies.
<p></p>
</summary>
The only absolute requirements for building `bfs` are a C compiler, [GNU make](https://www.gnu.org/software/make/), and [Bash](https://www.gnu.org/software/bash/).
These are installed by default on many systems, and easy to install on most others.
Refer to your operating system's documentation on building software.
`bfs` also depends on some system libraries for some of its features.
Here's how to install them on some common platforms:
<pre>
<strong>Alpine Linux</strong>
# apk add acl{,-dev} attr{,-dev} libcap{,-dev} oniguruma-dev
<strong>Arch Linux</strong>
# pacman -S acl attr libcap oniguruma
<strong>Debian/Ubuntu</strong>
# apt install acl libacl1-dev attr libattr1-dev libcap2-bin libcap-dev libonig-dev
<strong>Fedora</strong>
# dnf install libacl-devel libattr-devel libcap-devel oniguruma-devel
<strong>NixOS</strong>
# nix-env -i acl attr libcap oniguruma
<strong>Void Linux</strong>
# xbps-install -S acl-{devel,progs} attr-{devel,progs} libcap-{devel,progs} oniguruma-devel
<strong>FreeBSD</strong>
# pkg install oniguruma
<strong>MacPorts</strong>
# port install oniguruma6
<strong>Homebrew</strong>
$ brew install oniguruma
</pre>
These dependencies are technically optional, though strongly recommended.
See the [build documentation](/docs/BUILDING.md#dependencies) for how to disable them.
</details>
<details>
<summary>
Once you have the dependencies, you can build <code>bfs</code>.
<p></p>
</summary>
Download one of the [releases](https://github.com/tavianator/bfs/releases) or clone the [git repo](https://github.com/tavianator/bfs).
Then run
$ make
This will build the `bfs` binary in the current directory.
Run the test suite to make sure it works correctly:
$ make check
If you're interested in speed, you may want to build the release version instead:
$ make release
Finally, if you want to install it globally, run
# make install
</details>