https://github.com/sameh-farouk/rstgrep
a mini grep clone written in Rust
https://github.com/sameh-farouk/rstgrep
Last synced: 9 months ago
JSON representation
a mini grep clone written in Rust
- Host: GitHub
- URL: https://github.com/sameh-farouk/rstgrep
- Owner: sameh-farouk
- Created: 2021-05-24T13:41:06.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-08T10:10:32.000Z (about 5 years ago)
- Last Synced: 2025-04-09T18:56:41.068Z (about 1 year ago)
- Language: Rust
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
## About The Project
note: this project for-educational-purposes-only.
this is a mini grep clone. That is a tool that we can give a string or regex pattern and a file path and it’ll print only the lines that contain the given string.
while i code this project I practiced the fundamentals and learnt about:
* Parsing CLI arguments with `StructOpt`
* using `BufReader` to read files contents.
* handling Potential failure using a shortcut method on `Results`, called `unwrap`
* use `anyhow` library to provide a context and build a custom error message and get a “chain” of error messages pointing out the root cause.
* parsing, compiling, and executing regular expressions.
### Built With
* [Rust](https://www.rust-lang.org/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
* Rust
to install Rust run
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
If you have installed Rustup some time ago, chances are your Rust version is out of date. Get the latest version of Rust by running `rustup update`.
### Installation
1. Clone the repo
```sh
git clone https://github.com/sameh-farouk/rstgrep.git
```
3. cd into `rstgrep`:
```sh
cd rstgrep
```
4. Compile and run it in the same step using `cargo run` command:
```sh
cargo run
```
## Usage
### from src code
`cargo run -- `
```sh
cargo run -- main ./src/main.rs
```
for help you can run
`cargo run -- --help`
### from a release binary
you can downlaod the latest release from [here](https://github.com/sameh-farouk/rstgrep/releases) which built and tested on ubuntu 20.04
or build it yourself from source code
1. first to build the binary run `cargo build` command:
```sh
cargo build --release
```
you will find the built binary in `./target/release/`
```sh
cd target/release/
```
2. run `./rstgrep `
:
```sh
cd target/release
./rstgrep main ../../src/main.rs
```
for help you can run
`./rstgrep --help`
```
rstGREP 0.2.0
an alternative to grep written in Rust.
USAGE:
rstgrep [FLAGS]
FLAGS:
-c, --count print only a count of selected lines per FILE
-h, --help Prints help information
-n, --line-number Show relative line number in the file
-r, --recursive Read all files under each directory, recursively
-V, --version Prints version information
ARGS:
The pattern to look for
The path to the file to read
```
finally, to be able to run rstgrep from any location without specifing the executable path, you could move or copy it to a location which exists in your PATH.
for example ```cp rstgrep ~/.local/bin/```
also you have to make sure that the rstgrep have executable permissions.
we can add execute permissions to the file (for everyone, perhaps) with ```chmod +x rstgrep```
## Examples
rstgrep regex syntax is similar to Perl-style regular expressions. you could do intersting things like find all lines with a date.
```sh
rstgrep -r "\d{4}-\d{2}-\d{2}" testfile
```
The syntax supported in rstgrep pattern is documented [here](https://docs.rs/regex/1.5.4/regex/#syntax)
## Acknowledgements
* [The Rust Programming Language: The Book](https://doc.rust-lang.org/book/title-page.html)
* [Command line apps in Rust](https://rust-cli.github.io/book/index.html)
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/sameh-farouk-software-developer/