askrepo: ferramenta de leitura de código-fonte que usa o LLM para analisar o código, fornece explicações detalhadas do código e oferece suporte a várias linguagens de programação

Introdução geral

O askrepo é uma ferramenta de leitura de código-fonte baseada no LLM (Large Language Model). Ela pode ler o conteúdo de um arquivo de texto gerenciado pelo Git em um diretório específico e enviá-lo para o Google Gêmeos API que fornece respostas a perguntas com base em prompts especificados. A ferramenta foi projetada para ajudar os desenvolvedores a entender e analisar melhor o código-fonte e oferece suporte a uma ampla variedade de linguagens de programação.

Lista de funções

• Leitura do código-fonteGit: lê o conteúdo de um arquivo de texto gerenciado pelo Git.
• análise de códigoAnálise de código usando a API do Google Gemini.
• Solução de problemasResposta: Forneça respostas a perguntas com base em prompts especificados.
• Suporte a vários idiomasSuporte a várias linguagens de programação.
• ferramenta de linha de comandoLinha de comando: fornece ferramentas de linha de comando para uso dos desenvolvedores.
• Explicação detalhada do códigoFornecer explicações detalhadas do código para ajudar os desenvolvedores a entender melhor o código.

Usando a Ajuda

Processo de instalação

1. Obter a chave da API do Google Gemini: AcessoEstúdio de API do GoogleObter a chave da API.
2. Instalar o askrepoInstalação: Instale o askrepo executando o seguinte comando em um terminal:

   cargo install askrepo

3. Configuração da chave da APIConfigure as variáveis de ambiente no terminal para usar a chave de API:

   export GOOGLE_API_KEY="YOUR_API_KEY"

Uso

1. Uso básicoComando: Execute o seguinte comando no terminal para analisar o código-fonte no diretório especificado e gerar comentários:

   askrepo --prompt "Interprete o código no arquivo fornecido" --model "gemini-1.5-flash" . /src

2. Dicas personalizadasPode ser feito por meio de--promptProblemas de personalização de parâmetros, por exemplo:

   askrepo --prompt "Qual é o objetivo deste código?" ---modelo "gemini-1.5-flash" . /src

3. Especificação de modelosPode ser feito por meio de---modeloO parâmetro especifica o modelo de IA do Google usado, por exemplo:

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

4. Localização de erros de códigoUse o seguinte comando para localizar possíveis erros no código:

   askrepo --prompt "Find errors in this code" --model "gemini-1.5-flash" . /src

Fluxo de operação detalhado da função

1. Ler o conteúdo do arquivoaskrepo: lê todos os arquivos de texto gerenciados pelo Git no diretório especificado e formata seu conteúdo em um formato adequado para consulta.
2. Dicas de construçãoDicas de construção baseadas em informações de arquivos, perguntas e conteúdo de código-fonte extraído.
3. Enviar solicitaçãoEnviar o prompt para a API do Google Gemini para análise.
4. analisar a respostaAnálise: analisa a resposta JSON retornada pela API e extrai o texto gerado.
5. resultado de saídaSaída do texto gerado para o terminal para ajudar os desenvolvedores a entender o código ou encontrar erros.

O guia do leigo para começar a usar a IA

Ajuda você a aprender a utilizar as ferramentas de IA com baixo custo e a partir de uma base zero.A IA, assim como o software de escritório, é uma habilidade essencial para todos. Dominar a IA lhe dará uma vantagem em sua busca de emprego e metade do esforço em seu trabalho e estudos futuros.

Ver detalhes>