CodeFetch

A modern, comprehensive code analysis tool for software projects.

Features

CodeFetch provides detailed insights into your codebase,offering a complete analysis suite
that helps developers understand their projects better through multiple metrics.

• Line counting statistics (code, comments, total)
• Language distribution analysis
• License detection
• Build system identification
• Git repository statistics
  • Commit history
  • Contributor analysis
  • Timeline information
• Multi-threaded file processing
• Beautiful, colorful console output

Getting Started

Dependencies

• libgit2 for Git statistics

Build & Install from source

git clone https://github.com/yellow-footed-honeyguide/codefetch.git
cd codefetch
cmake -S . -B build -G Ninja && cmake --build build
# codefetch binary in build dir now

# for system-wide installation (may require elevated privileges):
cd build && sudo ninja install && cd ..

Usage

Basic usage:

codefetch <directory>    # Analyze directory with all modules

Available options:

-c, --line_counter       Show line counter statistics
-l, --languages          Show language statistics
-g, --git-statistics     Show git statistics information
-m, --metabuild_system   Show metabuild system information
-i, --license            Show license information
-v, --version            Show version information

Contributing

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

• Fork the Project
• Create your Feature Branch (git checkout -b feature/AmazingFeature)
• Commit your Changes (git commit -m 'Add some AmazingFeature')
• Push to the Branch (git push origin feature/AmazingFeature)
• Open a Pull Request

Adding New Modules

The project is designed to be modular. To add a new analysis module:

1. Create a new class that inherits from CodeFetchModule
2. Implement the required virtual functions:
   • process_file(const fs::path& file_path)
   • print_stats() const
3. Add your module to the main processing loop in main.cpp

License

Distributed under the MIT License. See LICENSE file for more information.