Scout the Meerkat got your back!

Scout is a lightweight and fast command-line tool for analyzing codebases. Whether you're copying code for context (like when using ChatGPT) or exploring a new project, Scout gives you a quick and comprehensive overview of your codebase’s folder structure, file types, and code statistics in seconds!

• Quick Code Extraction: Instantly gather project details to copy into tools like ChatGPT for context.
• Folder Structure Analysis: Generates a detailed report of the project's folder hierarchy.
• File Type & Line Count Stats: Summarizes the number of files and lines of code per file type.
• Largest File Identification: Find the biggest files in terms of size and lines.
• Respects .gitignore: Ignores files and directories listed in your .gitignore.
• File Content Summarization: Provides content summaries with truncation for large files.

scout <path/to/codebase> <path/to/outputfile>

• Codebase Path: Path to the codebase to analyze (defaults to current directory).
• Output File Path: Where to save the report (defaults to a file in the current directory).

1. Download the binary for your platform from the Releases.
2. Extract the file:

tar -xvzf scout_<platform>.tgz

3. Run the scout binary from the command line.

Scout gives you instant insights into your project's structure, helping you stay organized and focused on what matters most — coding!

I welcome your contributions! Here's how you can help:

• Open Issues: Share your ideas, feature suggestions, or any bugs you discover.
• Submit Pull Requests: Feel free to directly propose code improvements or new features.