RustScout

A high-performance, concurrent code search tool written in Rust. RustScout is designed for quickly searching and analyzing large codebases with a focus on performance and usability.

Features

• 🚀 High Performance: Utilizes Rust's concurrency features for blazing-fast searches
• 🔍 Smart Search: Regex support with intelligent pattern matching
• 📁 File Filtering: Flexible ignore patterns and file type filtering
• 📊 Rich Output: Detailed search results with statistics
• 🛠️ Developer Friendly: Clear documentation with .NET comparison examples

Quick Start

Install RustScout using cargo:

cargo install rustscout-cli

Basic usage:

rustscout-cli "pattern" /path/to/search

For more options:

rustscout-cli --help

Installation

From crates.io

cargo install rustscout-cli

From Source

git clone https://github.com/willibrandon/rustscout.git

cd rustscout

cargo install --path rtrace_cli

Usage

Basic Search

rustscout-cli "search pattern" .

With File Type Filter

rustscout-cli "pattern" . --type rs,toml

Ignore Patterns

rustscout-cli "pattern" . --ignore "target/*"

Statistics Only

rustscout-cli "pattern" . --stats-only

Library Usage

RustScout can also be used as a library in your Rust projects:

[dependencies]

rustscout = "0.1.0"

use rustscout::search;

fn main() {
    let results = search("pattern", ".", None).unwrap();
    println!("Found {} matches", results.total_matches);
}

Configuration

RustScout can be configured via command line arguments or configuration files. See the documentation for more details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Benchmarks

Performance comparison with other popular search tools (searching a large Rust codebase):

Note: These are example benchmarks. Actual performance may vary based on the specific use case and system configuration.