https://github.com/pr4k/locate
A Recursive Search tool in Rust
https://github.com/pr4k/locate
Last synced: about 1 year ago
JSON representation
A Recursive Search tool in Rust
- Host: GitHub
- URL: https://github.com/pr4k/locate
- Owner: pr4k
- License: mit
- Created: 2020-03-20T16:23:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-30T20:08:37.000Z (about 5 years ago)
- Last Synced: 2025-04-16T03:08:29.208Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 465 KB
- Stars: 32
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Key Features •
Usage •
Test Run •
Demo •
Installation •
To-Do •
License
> A recursive Search Tool written in Rust
How many times have you gone through files in search of a string, or finding origin of a function.
Locate is a tool written in *Rust* which goes through each file and gives **exact location of the string** in the file.
---
## **Key Features**
- Works on **Windows**, **MacOS** and **Linux**
- Blazing **Fast**
- Finds String Deep Inside **Directory Structure**
---
## **Installation**
``` bash
# Clone the repo
git clone https://github.com/pr4k/locate
# Build the project
cargo build --release
```
It will create a binary in `target/release`, copy it to `/usr/bin` and you are good to go.
Or simply do
`cargo install locate`
---
## **Give it a Test Run**
Don't want to clone the project, *No worries!!*
Go to the **releases** and downlaod the latest release, copy it to `/usr/bin` that's all.
---
## **Usage**
```bash
➜ ~ locate -h
Usage:
locate [OPTIONS]
Recursive string locater in files
Optional arguments:
-h,--help Show this help message and exit
-p,--path PATH Path to folder
-q,--query QUERY Query string to find
```
Try `locate -p /path/to/folder -q /string-to-be-searched`
---
## **Demo**
Click on image to get a Asciinema shot:
---
## **TO-DO**
- Add **regex** support for the search string
- Control Folder depth for search
- Provide option to replace the searched word by another
## **License**
[](https://github.com/pr4k/locate)
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
- Copyright 2020 © pr4k
---