https://github.com/zefir1990/gofis
Gofis - Go file search CLI tool
https://github.com/zefir1990/gofis
cli filesearch go
Last synced: 6 days ago
JSON representation
Gofis - Go file search CLI tool
- Host: GitHub
- URL: https://github.com/zefir1990/gofis
- Owner: zefir1990
- License: mit
- Created: 2026-01-03T22:49:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-04T09:34:06.000Z (5 months ago)
- Last Synced: 2026-02-21T21:20:28.477Z (3 months ago)
- Topics: cli, filesearch, go
- Language: Go
- Homepage: https://demensdeum.com
- Size: 55.7 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gofis - Go File Search CLI Tool
**Gofis** is a lightweight, high-performance command-line utility built in Go for searching files across your system. It leverages Go's native concurrency model to walk directory trees rapidly, making it significantly faster than traditional single-threaded search tools.
---
### 🛠️ Features
* **Concurrent Searching:** Uses a configurable pool of goroutines to scan multiple directories simultaneously.
* **Smart Filtering:** Search by partial filenames, specific extensions, or both.
* **Automatic Ignoring:** Defaults to skip heavy folders like `enode_modules`, `.git`, and `vendor` to save time.
* **Human-Readable Output:** Displays file sizes in a formatted, easy-to-read way (KB, MB, GB, etc.).
* **Flexible Interface:** Supports both traditional flags and shorthand positional arguments.
---
### 🛠️ Installation
Ensure you have [Go](https://go.dev/doc/install) installed on your machine.
```bash
git clone https://github.com/yourusername/gofis.git
cd gofis
go build -o gofis main.go
```
---
### 📖 Usage
Gofis provides two ways to search: using flags or using positional arguments.
### 1. Using Flags (Recommended)
```bash
./gofis -n "config" -e ".yaml" -p ./src
```
### 2. Positional Shorthand
```bash
./gofis "filename" "searchPath" [maxGoroutines]
```
Example: `./gofis "main" "./projects" 50`
#### 3. Managing the Ignore List
By default, Gofis skips common metadata and dependency folders to increase speed ("node_modules,.git,.svn,vendor"). You can override this using the `-i` flag.
* **To customize the list:**
```bash
./gofis -n "main" -i "dist,temp,logs"
```
* **To disable the ignore list (Search ALL directories):**
Pass an empty string to the ignore flag.
```bash
./gofis -n "target_file" -i ""
```
---
🔍 Regex Filename Search
Gofis treats the search term as a Regular Expression (case-insensitive by default). This allows for much more powerful queries than simple string matching.
```bash
.\gofis.exe "^.*\.ini$" "D:\"
```
Note: When using special characters like |, *, or ( ) in your terminal, remember to wrap your search term in quotes (e.g., "^data_.*").
### ⚙️ How it Works
Gofis uses a **Semaphore Pattern** to manage system resources. While it spawns a new goroutine for every subdirectory it encounters, it limits the number of active operations using a buffered channel (`sem`). This prevents the application from hitting "too many open files" errors or overwhelming the CPU.
### Performance Logic
* **WaitGroup:** Ensures the main process doesn't exit until all sub-directories have been fully scanned.
* **Channels:** Streams results back to the main thread in real-time, allowing you to see matches immediately without waiting for the entire scan to finish.
---
### 📄 License
This project is open-source and available under the [MIT License](LICENSE).