rustscout 0.1.0

High-performance, concurrent code search tool written in Rust
Documentation

RustScout

Crates.io Documentation License:MIT Build Status

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

Basic usage:

rustscout "pattern" /path/to/search

For more options:

rustscout --help

Installation

From crates.io

cargo install rustscout

From Source

git clone https://github.com/willibrandon/rustscout.git
cd rustscout
cargo install --path .

Usage

Basic Search

rustscout "search pattern" .

With File Type Filter

rustscout "pattern" . --type rs,toml

Ignore Patterns

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

Statistics Only

rustscout "pattern" . --stats-only

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):

Tool Time (ms) Memory (MB)
RustScout 120 15
ripgrep 150 18
grep 450 12

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