Skip to content

File search util for command line, used similarly to online search engines. With highlights and formatting.

License

Notifications You must be signed in to change notification settings

alex-vt/FindFile

Repository files navigation

FindFile

File search util for command line, used similarly to online search engines

Example

Features

  • Search query structure: include words and -exclude -these -ones
  • Included words are highlighted in results
  • Including words in sequence by default, and optionally in any order
  • Results are numbered. Pass numbers of results to select them
  • Can quote paths, or containing folder paths, for using as args
  • Can open all or selected results, or their containing folders
  • Shows size of found folders
  • Hidden files and build folders are excluded by default
  • Can show equivalent find command
  • Less visually important text is grayed out

Usage

Reference

    Searches files containing given path parts, in ~ by default.
    Excludes results containing any of path parts with leading dashes.
    Shows results in a numbered list of full paths.
    Can select results by given numbers. Mind that results may change.
    * Asterisks around path parts are optional, are used automatically.
    Directories to search in, excluded parts and result numbers are optional.
    Default directory can be set in FF_DEFAULT_DIR environment variable.
    Use args separately, like -p -i -n (-pin is treated as excluded path part).
Usage:
    ff <include>
    ff <dir> <dir> <include> <include> -<exclude> -<exclude> -<result_number>
Sort args (one at a time):
    -n (-N): sort by  name           a to Z        (Z to a)
    -s (-S): sort by  size           small to big  (big to small)
    -m (-M): sort by  modified time  new to old    (old to new, default)
Filter args:
    -a: include all hidden files, hidden and build directories
    -r: include reordered path parts to search, not only in given order
    -d: search  directories instead of files, will not go into the found ones
Select args (one at a time):
    -q (-Q): select quoted unformatted result file (containing directory) path
    -o (-O): select quoted and open each listed file (containing directory)
Info args:
    -i: info  about modified times and sizes for results
    -f (-F):  show as  file:// links  for paths that need escaping  (always)
    -p: print underlying find command
    -h: help  information

Installation

Linux, option 1: install to /bin

git clone https://github.com/alex-vt/FindFile.git
cd FindFile/
./gradlew build
sudo cp build/bin/native/releaseExecutable/FindFile.kexe /bin/ff

Linux, option 2: use alias

git clone https://github.com/alex-vt/FindFile.git
cd FindFile/
./gradlew build
echo "alias ff='$PWD/build/bin/native/releaseExecutable/FindFile.kexe'" >> ~/.bashrc

Restart terminals for ff to take effect.

License

MIT license.

About

File search util for command line, used similarly to online search engines. With highlights and formatting.

Topics

Resources

License

Stars

Watchers

Forks

Languages