https://github.com/kyza/rusefs
A simple Rust grep-like CLI tool for searching your filesystem with regex.
https://github.com/kyza/rusefs
filesystem grep rust search
Last synced: about 1 year ago
JSON representation
A simple Rust grep-like CLI tool for searching your filesystem with regex.
- Host: GitHub
- URL: https://github.com/kyza/rusefs
- Owner: Kyza
- Created: 2021-07-26T17:00:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-26T22:40:21.000Z (almost 5 years ago)
- Last Synced: 2025-01-25T21:11:23.696Z (over 1 year ago)
- Topics: filesystem, grep, rust, search
- Language: Rust
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
rusefs
RUst SEarch FileSystem
---
A simple [Rust](https://www.rust-lang.org/) [grep](https://www.gnu.org/software/grep/)-like CLI tool for searching your filesystem with [regex](https://docs.rs/regex/1.5.4/regex/#syntax).
## Example
Search for all JavaScript files by their extension (case-insensitively) with `functionName()` in them that are under 5MB in `~/GitHub` and `~/Downloads` while skipping all files and folders named `node_modules` or `.git`.
```bash
rusefs -f ~/GitHub -f ~/Downloads -n "(?i)\.js" -c "functionName\(\)" -e "node_modules" -e "^\.git$" -s 5
```
## Installation
Download the binary for your architechure from the [releases](https://github.com/Kyza/rusefs/releases), extract it, and place it somewhere in your PATH. Alternatively you can create an alias for it in your `.bashrc` or `.zshrc`.
A [`rusefs-config.toml`](https://github.com/Kyza/rusefs/blob/master/rusefs-config.toml) file can be created in the same folder as the binary to include default settings. The keys are the same as the long names for the CLI flags, run `rusefs --help` to find them.
## Building
Building this program requires [Rust](https://www.rust-lang.org/).
Once you've installed [Rust](https://www.rust-lang.org/), build the binary with the command below.
```bash
cargo build --release
```