codebase dump

Readme

Este projeto é uma versão leve do CodeBase Digest, projetado para analisar e resumir sua base de código em um despejo de arquivo único. A saída gerada inclui:

• Estrutura de código e conteúdo
• Um resumo básico da base de código

Essa saída pode ser usada como entrada para grandes modelos de idiomas (LLMS) como ChatGPT, Google Gemini e outros para análise posterior ou para suportar tarefas rápidas.

Para inspirar possíveis avisos, consulte a seção Prompts LLM no repositório CodeBase Digest.

Como usar

Instalação

Opção 1: Instale via PIP

Você pode instalar o código-base-dump diretamente do Pypi:

pip install codebase-dump

Opção 2: Instale clonando o repositório

Repositório de configuração do clone

git clone https://github.com/your-username/codebase-dump.git
cd codebase-dump
pip install -r requirements.txt

Eu recomendo abrir este projeto no código do Visual Studio e configurar um ambiente virtual.

Uso

Linha de comando

Depois de instalado, você pode executar o código-base-dump na linha de comando:

codebase-dump < path_to_codebase > -f < output_filename > -o < output_format >

Argumentos disponíveis

Opção	Descrição
path_to_directory	Caminho para o diretório que você deseja analisar
-o, --output-format	Formato de saída (texto, Markdown). Padrão: texto
-f, --file	Nome do arquivo de saída
--max-size	Tamanho máximo de conteúdo de texto permitido em KB (Padrão: 10240 KB)
--ignore-top-large-files	Número de arquivos maiores a serem ignorados (padrão: 0)
--audit-upload	Envie a saída para a API Audits, conforme definido pelo parâmetro- --audit-base-url
--audit-base-url	URL base da API para enviar a auditoria para (padrão: https://codeaudits.ai/)
--api-key	Sua chave de API privada para atribuir repositório enviado à sua conta em https://codeaudits.ai/

Exemplos

Gere um arquivo de remarcação da estrutura de código do seu projeto:

codebase-dump . -f project_dump_for_llm.md -o markdown

---

Gerar um arquivo de remarca e empurrá -lo para os Audits App Codeaudits.ai:

codebase-dump . -o markdown --audit-upload

---

Gere um arquivo de marcação e empurre -o para a instância personalizada do aplicativo de auditorias:

codebase-dump . -o markdown --audit-upload --audit-base-url https://your-audit-instance.com/

---

Gere um arquivo de remarcação enquanto ignora os 5 maiores arquivos e empurre -o para os Audits App Codeaudits.ai:

codebase-dump . -o markdown --audit-upload --ignore-top-large-files=5

Da fonte

Você também pode executar o código-base-dump diretamente do código-fonte:

pip install -e .
python src/codebase_dump/app.py < path_to_codebase > -f < output_filename > -o < output_format >

Experimente online com o Google Colab

Você pode experimentar o código-base em um ambiente on-line, Google Colab. Pode ser uma boa opção se você não tiver um ambiente Python no seu computador. Basta iniciá-lo aqui: CodeBase-Dump Colab. Para testá -lo, execute todo o código via tempo de execução -> Execute tudo.

Uso em ações do GitHub

Você pode automatizar o dump de base de código em um fluxo de trabalho de ações do GitHub para gerar e salvar o despejo de código como um artefato. Aqui está um exemplo de configuração do fluxo de trabalho (exemplo de funcionamento disponível neste próprio repositório: .github/workflows/codebase_dump.yml).

 name : Generate Project Dump for LLM

on :
  workflow_dispatch :

jobs :
  generate-file :
    runs-on : ubuntu-latest

    steps :
      - name : Checkout code
        uses : actions/checkout@v4

      - name : Set up Python
        uses : actions/setup-python@v3
        with :
          python-version : " 3.10 "

      - name : Install codebase-dump
        run : pip install codebase-dump

      - name : Generate Single-File Prompt for LLM
        run : codebase-dump . -f project_dump_for_llm.md -o markdown --audit-upload

      - name : Upload Prompt File as Artifact
        uses : actions/upload-artifact@v3
        with :
          name : project_dump_for_llm.md
          path : project_dump_for_llm.md

Neste exemplo:

• O fluxo de trabalho é acionado manualmente com o Workflow_dispatch.
• Ele instala o código-base-dump e gera um arquivo .md chamado Project_Dump_For_LLM.MD, contendo a estrutura e o resumo do código.
• A bandeira --audit-upload envia a saída para a API de auditorias em https://codeaudits.ai/
• O arquivo gerado é então enviado como um artefato para facilitar o acesso e o download.

O que vem a seguir?

Use -o por conta própria

Depois de obter seu despejo de código de código, copie -o em um dos LLMs como prompt de entrada e comece a perguntar às perguntas de Gemini, Chatgpt, Claude e outras pessoas relacionadas à sua base de código. Por exemplo, pergunte sobre "o que são sugeridas etapas para refatorar esse código em // sua escolha // arquitetura".

Para inspiração sobre possíveis avisos, verifique a seção Prompts do LLM no repositório CodeBase Digest.

Use auditorias de código

O codebase de análise parsed também foi enviado para https://codeaudits.ai/ aplicativo. Quando você inicia o link que foi devolvido a você, você pode executar algumas auditorias de código pré-configuradas, como a arquitetura refatorar dicas, testes ausentes ou dicas de simplificação.