codebase dump

Readme

Este proyecto es una versión liviana de CodeBase Digest, diseñada para analizar y resumir su base de código en un volcado de un solo archivo. La salida generada incluye:

• Estructura de código y contenido
• Un resumen básico de la base de código

Esta salida se puede usar como entrada para modelos de idiomas grandes (LLM) como ChatGPT, Google Gemini y otros para un análisis adicional o para admitir tareas basadas en el aviso.

Para obtener inspiración en posibles indicaciones, consulte la sección LLM Institres en el repositorio de resumen de la base de código.

Cómo usar

Instalación

Opción 1: Instalar a través de PIP

Puede instalar CodeBase-Dump directamente desde Pypi:

pip install codebase-dump

Opción 2: Instale clonando el repositorio

Repositorio de configuración de clonos

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

Recomiendo abrir este proyecto en el código de Visual Studio y configurar un entorno virtual.

Uso

Línea de comando

Una vez instalado, puede ejecutar CodeBase-Dump desde la línea de comando:

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

Argumentos disponibles

Opción	Descripción
path_to_directory	Ruta hacia el directorio que desea analizar
-o, --output-format	Formato de salida (Texto, Markdown). Valor predeterminado: texto
-f, --file	Nombre del archivo de salida
--max-size	Tamaño máximo de contenido de texto permitido en KB (predeterminado: 10240 kb)
--ignore-top-large-files	Número de archivos más grandes para ignorar (predeterminado: 0)
--audit-upload	Envíe la salida a la API de auditorías según lo definido por --audit-base-url parámetro
--audit-base-url	URL base de API para enviar la auditoría a (predeterminado: https://codeaudits.ai/)
--api-key	Su clave de API privada para asignar repositorio enviado a su cuenta en https://codeaudits.ai/

Ejemplos

Genere un archivo de Markdown de la estructura de código de su proyecto:

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

---

Genere un archivo de Markdown y presione a la aplicación de auditorías CodeAudits.ai:

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

---

Genere un archivo de Markdown y presione a una instancia personalizada de la aplicación Auditoría:

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

---

Genere un archivo de Markdown mientras ignora los 5 archivos más grandes y lo presione a la aplicación de auditorías CodeAudits.ai:

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

De la fuente

También puede ejecutar CodeBase-Dump directamente desde el código fuente:

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

Prueba en línea con Google Colab

Puede probar CodeBase-Dump en un entorno en línea, Google Colab. Puede ser una buena opción si no tiene un entorno de Python en su computadora. Simplemente inicielo aquí: CodeBase-Dump Colab. Para probarlo, ejecute todo el código a través del tiempo de ejecución -> Ejecutar todo.

Uso en acciones de Github

Puede automatizar CodeBase-Dump en un flujo de trabajo de GitHub Actions para generar y guardar el volcado de código como un artefacto. Aquí hay un ejemplo de configuración de flujo de trabajo (ejemplo de trabajo disponible en este propio repositorio: .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

En este ejemplo:

• El flujo de trabajo se activa manualmente con Workflow_Dispatch.
• Instala CodeBase-Dump y genera un archivo .md llamado Project_DUMP_FOR_LLM.MD, que contiene la estructura y el resumen del código.
• El indicador --audit-supload envía la salida a la API de auditorías en https://codeaudits.ai/
• El archivo generado se carga como un artefacto para un fácil acceso y descarga.

¿Qué sigue?

Úselo por su cuenta

Una vez que obtenga su volcado en Base de código, cifrelo en uno de los LLM como un mensaje de entrada y comience a preguntarle a Gemini, ChatGPT, Claude y otras preguntas relacionadas con su base de código. Por ejemplo, pregunte sobre "cuáles se sugieren pasos para refactorizar este código en // su elección // arquitectura".

Para obtener inspiración en posibles indicaciones, verifique la sección LLM Institres en el repositorio de digestas de código de código.

Use auditorías de código

La base de código analizada también se cargó en https://codeaudits.ai/ aplicación. Cuando inicia el enlace que se le devolvió, puede ejecutar algunas auditorías de código preconfiguradas, como sugerencias de refactorización de arquitectura, pruebas faltantes o pistas de simplificación.