Skip to content

mia-care/documentation-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repository Analyzer

Overview

The Repository Analyzer is a Rust-based application designed to retrieve code files from a Git repository, filter out non-code files, and analyze the implementation of specified requirements using the Gemini LLM. This tool aims to streamline the process of understanding codebases by focusing on relevant code files.

Project Structure

repo-analyzer
├── src
│   ├── main.rs        # Entry point of the application
│   ├── git.rs         # Functions for interacting with Git repositories
│   ├── filter.rs      # Logic for filtering out non-code files
│   ├── gemini.rs      # Communication with the Gemini LLM
│   └── prompt.rs      # Construction of prompts for the LLM
├── Cargo.toml         # Project configuration and dependencies
└── README.md          # Documentation for the project

Features

  • Clone Git repositories and retrieve file structures.
  • Filter out non-code files such as .gitignore, README.md, and test files.
  • Communicate with the Gemini LLM to analyze code and verify requirement implementations.

Setup Instructions

  1. Ensure you have Rust and Cargo installed on your machine.
  2. Clone the repository:
    git clone <repository-url>
    cd repo-analyzer
    
  3. Build the project:
    cargo build
    
  4. Run the application:
    cargo run
    

Usage

To use the Repository Analyzer, provide the URL of the Git repository and the requirements you want to analyze. The application will handle the rest, filtering the files and communicating with the Gemini LLM to provide insights on the implementation of the specified requirements.

Contributing

Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages