Skip to content

README.md

Latest commit

 

History

History
44 lines (34 loc) · 1.67 KB

README.md

File metadata and controls

44 lines (34 loc) · 1.67 KB

finder

finder lets you find your files and directories (currently only on Windows).

finder was created as a find clone. It is a hobby project.

Usage

finder [-s | --search] <search term> [-p | --path <path>] 
[-c | --current] [--debug] [--no-stream] [-D | -F]

Example

# find all files and directories with "test" in their name in the directory "C:\"
finder "test" -p "C:\"

# find all files and directories with "test" in their name on all drives of the system
finder -s "test"

Installation

Cargo is required to build the project.

  1. Clone the repository
  2. Run cargo build --release in the repository root directory
  3. The executable is located at target/release/finder.exe
  4. Add the executable to your PATH

Voilà! You can now use finder in your terminal.

CLI Flags

All flags can be changed in their order

  • -s, --search <search term>: Specify the you want to search for. This flag is not needed when the term is specified as the first argument.
  • -p, --path [<path> ...]: Specify one or more paths. The paths will be considered the root of the search.
  • c, --current: Specify the current directory as the root of the search.
  • -D: Only searches for directories.
  • -F: Only searches for files.
  • --debug: finder will print all errors to the console.
  • --no-stream: The result of the search will be only returned at the end as one block. This can have the effect, that all existing results were found but the user does not see them because finder still searches some paths.
  • -i, --ignore-case: Ignore case when searching for the search term.
  • -h, --help: Print help info.
  • -v, --version: Print the version.