https://github.com/root-hunter/zig-search
High-performance search utility written entirely in Zig
https://github.com/root-hunter/zig-search
cross-platform search zig
Last synced: 5 months ago
JSON representation
High-performance search utility written entirely in Zig
- Host: GitHub
- URL: https://github.com/root-hunter/zig-search
- Owner: root-hunter
- License: mit
- Created: 2024-05-29T23:26:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-09T15:57:48.000Z (about 2 years ago)
- Last Synced: 2024-06-10T16:33:30.140Z (about 2 years ago)
- Topics: cross-platform, search, zig
- Language: Zig
- Homepage:
- Size: 700 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
zig-search
High-performance search utility written entirely in Zig
## About The Project
This is my first project written in Zig. I've been fascinated by Zig and its features, which offer a unique blend of performance, simplicity, and control. Zig-Search is a testament to the power and efficiency that Zig brings to the table, and it has been an exciting journey exploring what this language can do. I hope this tool showcases the potential of Zig and inspires others to explore it as well.
## Features
- 100% Zig implementation
- Only std lib
- Fast and efficient directory scanning
- Recursive search in nested directories
- Simple command-line interface
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Build Prerequisites
These are the prerequisites needed only to build the project, if you only want to use zig-search you can go to the Usage section
* [Install zig](https://ziglang.org/learn/getting-started/)
### Build
1. Clone the repo
```sh
git clone https://github.com/root-hunter/zig-search
```
2. Move to zig-search dir
```sh
cd zig-search
```
3. Build executable
```sh
make build-exe
```
or
```sh
zig build-exe src/main.zig --name zig-search -static
```
## Examples
Search and export into file all path of files (with extension .txt) that contains the word "password" at least one time.
```sh
zig-search /start/path "password" -f txt -e ${HOME}/Documents/zig-search_result.txt
```
Search and export into file all path of files (with extension .txt, .js, .html) that contains the word "password" at least one time.
```sh
zig-search /start/path "password" -f txt,js,html -e ${HOME}/Documents/zig-search_result.txt
```
Search and export into file all path of files (with extension .txt) that contains the word "password" at least one time using 16 threads.
```sh
zig-search /start/path "password" -f txt -t 16 -e ${HOME}/Documents/zig-search_result.txt
```
Search and export into file all path of files (with extension .txt) that contains the word "password" at least one time using all possible threads.
```sh
zig-search /start/path "password" -f txt -t 0 -e ${HOME}/Documents/zig-search_result.txt
```
Only print paths to console without export result file (using all cpu core).
```sh
zig-search /start/path "password" -f txt -t 0
```
Active case sensitive search.
```sh
zig-search /start/path "Password" -f txt -t 0 -c
```
Help command.
```sh
zig-search --help
Usage: zig-search START_PATH SEARCH_STRING [OPTIONS]...
Options:
--help Help command
-f, --file-extensions File extensions, in this form: txt,js | js,c,cpp
-t, --thread-count Scan thread count (Default: 1)
-a, --all-match Match all the occurence in the file (Default: false)
-c, --case-sensitive Case sensitive search (Default: false)
Export options:
-e, --export-path File export path (ABSOLUTE)
--export-no-info Disable info header in the export file
--export-match-position Add match position info for each path in the export file
```
## Roadmap
- [X] Help command
- [X] Multihreading
- [X] Advance text search
- [X] Export results to file
- [X] Scan file by list file paths
## License
Distributed under the MIT License. See `LICENSE` for more information.
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/root-hunter/zig-search/blob/main/LICENSE
[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/antonio-ricciardi-279118210