askrepo: инструмент для чтения исходного кода, использует LLM для анализа кода, предоставляет подробные пояснения к коду, поддерживает множество языков программирования

Общее введение

askrepo - это инструмент для чтения исходного кода, основанный на LLM (Large Language Model). Он может прочитать содержимое управляемого Git'ом текстового файла в указанной директории и отправить его в Google Близнецы API, предоставляющий ответы на вопросы на основе заданных подсказок. Инструмент призван помочь разработчикам лучше понять и проанализировать исходный код и поддерживает широкий спектр языков программирования.

Список функций

• Чтение исходного кода: Считывает содержимое текстового файла, управляемого Git'ом.
• анализ кода: Анализ кода с помощью API Google Gemini.
• Решение проблем: Предоставление ответов на вопросы на основе заданных подсказок.
• Поддержка нескольких языков: Поддерживается несколько языков программирования.
• инструмент командной строки: Предоставляет инструменты командной строки для разработчиков.
• Подробное объяснение кода: Предоставляйте подробные пояснения к коду, чтобы помочь разработчикам лучше понять его.

Использование помощи

Процесс установки

1. Получите ключ API Google Gemini: ДоступGoogle API StudioПолучите ключ API.
2. Установите askrepo: Установите askrepo, выполнив следующую команду в терминале:

   cargo install askrepo

3. Установка ключа API: Установите переменные окружения в терминале, чтобы использовать ключ API:

   export GOOGLE_API_KEY="YOUR_API_KEY"

Использование

1. Основное использование: Выполните следующую команду в терминале, чтобы проанализировать исходный код в указанном каталоге и сгенерировать комментарии:

   askrepo --prompt "解释提供的文件中的代码" --model "gemini-1.5-flash" ./src

2. Пользовательские советы: Можно сделать через--promptНапример, проблемы с настройкой параметров:

   askrepo --prompt "这段代码的目的是什么？" --model "gemini-1.5-flash" ./src

3. Определение моделей: Можно сделать через--modelПараметр указывает используемую модель искусственного интеллекта Google, например:

   askrepo --model "gemini-1.5-flash" ./src

4. Поиск ошибок в коде: Используйте следующую команду, чтобы найти потенциальные ошибки в коде:

   askrepo --prompt "查找这段代码中的错误" --model "gemini-1.5-flash" ./src

Подробный порядок работы функций

1. Прочитайте содержимое файла: askrepo считывает все управляемые Git'ом текстовые файлы в указанном каталоге и форматирует их содержимое в форму, удобную для запросов.
2. Советы по строительству: Конструирование подсказок на основе информации о файлах, вопросов и извлеченного содержимого исходного кода.
3. Отправить запрос: Отправьте запрос в Google Gemini API для анализа.
4. разобрать ответ: Разбирает ответ JSON, возвращаемый API, и извлекает сгенерированный текст.
5. результат вывода: Вывод сгенерированного текста в терминал, чтобы помочь разработчикам понять код или найти ошибки.