Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kbrgl/fu

Unix's Find, Unleashed.
https://github.com/kbrgl/fu

cli command-line command-line-tool filesystem fs go golang regex search tool

Last synced: 27 days ago
JSON representation

Unix's Find, Unleashed.

Lists

README 

        
```

______       ____

\ \ \ \     / __/_  __

 \ \ \ \   / /_/ / / /

 / / / /  / __/ /_/ /

/_/_/_/  /_/  \__,_/



```



# Find Unleashed

Fu is an intuitive alternative to the Unix command find. It mainly searches

filenames, but some meta-information like file mode is supported as well.

It can walk directories in parallel, resulting in substantial speedups for

directories with thousands of files.



## Index

* [Installation](#installation)

    + [Platform support](#platform-support)

* [Usage](#usage)

    + [Examples](#examples)

* [TODO](#todo)

* [Contributing](#contributing)



## Installation

### Homebrew

```

brew tap kbrgl/formulas

brew install fu

```

Or, if you want the latest version from git, run `brew install` with the `--HEAD`

flag. This is equivalent to running `go get`, except you'll be able to upgrade

through Homebrew.



### go get

If you have Go installed, run

```sh

go get -u github.com/kbrgl/fu

```

If you don't, download the latest release and put it somewhere on your $PATH.



### Platform support

Unix-based systems (macOS, Linux distros, \*BSDs, etc.) are supported.

Some features (like Unix permission filters) might not work on Windows.



## Usage

```sh

usage: fu []  [...]



Flags:

  -h, --help             Show context-sensitive help (also try --help-long and --help-man).

  -f, --fuzzy            Use fuzzy search

  -r, --regexp           Use regexp-based search

  -a, --suffix           Use suffix-based search (short flag 'a' is short for 'after')

  -b, --prefix           Use prefix-based search (short flag 'b' is short for 'before')

  -s, --substring        Use substring-based search allowing the query to be at any position in the filename

  -d, --dir              Show only directories

  -m, --perm=PERM        Filter by Unix permissions

  -c, --parallel         Walk directories in parallel, may result in substantial speedups for directories with many files

  -o, --older=OLDER      Filter by age (modification time)

  -y, --younger=YOUNGER  Filter by age (modification time)

  -e, --exclude          Excludes files matching the filters

  -v, --version          Show application version.



Args:

      Search query

  []  Paths to search

```

Path is current working directory by default, and the program uses exact

filename matching by default.



### Examples

The general usage pattern of fu is:

```sh

fu [...]  [...]

```

Where the search modifiers may be any of the options specified in the usage.



The only thing that's actually necessary is the query. By default,

```

fu 

```

Will search under the current directory for files with the name .



#### Find all dotfiles in the home folder

```sh

fu -b . ~

```

#### Find all Python scripts in current dir

```sh

fu -a .py

```

#### Find files in current dir whose names start and end with 'a'

```

fu -r "^a.*a\$"

```

#### Fuzzy matching

```

fu -f pkg

```



Fuzzy search is the algorithm that Sublime Text and Atom use in their

Command Palettes. For an explanation, check out

[this Wikipedia article](https://en.wikipedia.org/wiki/Approximate_string_matching).



## TODO

- [ ] Write tests

- [ ] Beautify TTY output

- [x] Remove -c flag and automatically switch between powerwalk and filepath Walk

  functions



PRs for these would be appreciated.



## Contributing

Contributions are welcome. Just be sure to run `go fmt` and `go vet` on your

code.