askrepo: herramienta de lectura de código fuente, que utiliza LLM para analizar el código, proporcionar explicaciones detalladas del código, soporte para una variedad de lenguajes de programación.

Introducción general

askrepo es una herramienta de lectura de código fuente basada en el LLM (Large Language Model). Puede leer el contenido de un archivo de texto gestionado por Git en un directorio especificado y enviarlo al servidor de Google Géminis API que proporciona respuestas a preguntas basadas en indicaciones especificadas. La herramienta está diseñada para ayudar a los desarrolladores a comprender y analizar mejor el código fuente y es compatible con una amplia gama de lenguajes de programación.

Lista de funciones

• Lectura del código fuente: Lee el contenido de un archivo de texto gestionado por Git.
• análisis del códigoAnálisis de código mediante la API Gemini de Google.
• Resolución de problemas: Proporciona respuestas a preguntas basadas en indicaciones especificadas.
• Soporte multilingüe: Se admiten varios lenguajes de programación.
• herramienta de línea de comandos: Proporciona herramientas de línea de comandos para uso de los desarrolladores.
• Explicación detallada del códigoProporcionar explicaciones detalladas del código para ayudar a los desarrolladores a comprenderlo mejor.

Utilizar la ayuda

Proceso de instalación

1. Obtener la clave API de Google Gemini: AccesoGoogle API StudioObtener la clave API.
2. Instalar askrepoInstala askrepo ejecutando el siguiente comando en un terminal:

   cargo install askrepo

3. Configuración de la clave API: Establezca variables de entorno en el terminal para utilizar la clave API:

   export GOOGLE_API_KEY="YOUR_API_KEY"

Utilización

1. Uso básicoEjecute el siguiente comando en el terminal para analizar el código fuente en el directorio especificado y generar comentarios:

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

2. Consejos personalizados: Puede hacerse a través de--promptProblemas de personalización de parámetros, por ejemplo:

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

3. Especificación de modelos: Puede hacerse a través de--modelEl parámetro especifica el modelo de Google AI utilizado, por ejemplo:

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

4. Detección de errores de código: Utilice el siguiente comando para encontrar posibles errores en el código:

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

Flujo detallado de funcionamiento de las funciones

1. Leer el contenido del fichero: askrepo lee todos los archivos de texto gestionados por Git en el directorio especificado y formatea su contenido en un formato adecuado para su consulta.
2. Consejos de construcción: Construye pistas basadas en la información de los archivos, las preguntas y el contenido del código fuente extraído.
3. Enviar solicitudEnvía la solicitud a la API Gemini de Google para su análisis.
4. analizar la respuestaAnaliza la respuesta JSON devuelta por la API y extrae el texto generado.
5. resultado de salidaSalida del texto generado al terminal para ayudar a los desarrolladores a entender el código o encontrar errores.