ai digest

ai-digerir

Una herramienta CLI para agregar su código base en un único archivo Markdown para usar con Claude Projects o ChatGPT personalizados.

Características

• Agrega todos los archivos en el directorio y subdirectorios especificados.

• Ignora artefactos de compilación y archivos de configuración comunes

• Genera un único archivo Markdown que contiene todo el código base.

• Proporciona opciones para la eliminación de espacios en blanco y patrones de ignoración personalizados.

Cómo utilizar

Comience ejecutando la herramienta CLI en el directorio de su proyecto:

 npx ai-digest

Esto generará un archivo codebase.md con su código base.

Una vez que haya generado el archivo Markdown que contiene su código base, puede usarlo con modelos de IA como ChatGPT y Claude para asistencia y análisis de código.

Con ChatGPT:

1. Crear un GPT personalizado

2. Cargue el archivo Markdown generado en la base de conocimientos de GPT

Con Claudio:

1. Crear un nuevo proyecto

2. Agregar el archivo Markdown al conocimiento del Proyecto

Para obtener mejores resultados, vuelva a cargar el archivo Markdown antes de iniciar una nueva sesión de chat para garantizar que la IA tenga la versión más actualizada de su código base.

Opciones

• -i, --input : especifica el directorio de entrada (predeterminado: directorio actual)

• -o, --output : especifica el archivo de salida (predeterminado: codebase.md)

• --no-default-ignores : Desactiva los patrones de ignorar predeterminados

• --whitespace-removal : Habilita la eliminación de espacios en blanco

• --show-output-files : muestra una lista de archivos incluidos en la salida

• --ignore-file : especifica un archivo de ignorar personalizado (predeterminado: .aidigestignore)

• --help : Mostrar ayuda

Ejemplos

1. Uso básico:

    npx ai-digest

2. Especificar entrada y salida:

    npx ai-digest -i /ruta/a/su/proyecto -o proyecto_summary.md

3. Habilite la eliminación de espacios en blanco:

    npx ai-digest --eliminación de espacios en blanco

4. Mostrar lista de archivos incluidos:

    npx ai-digest --mostrar-archivos-de-salida

5. Combina múltiples opciones:

    npx ai-digest -i /ruta/a/su/proyecto -o proyecto_summary.md --whitespace-removal --show-output-files

Patrones de ignorar personalizados

ai-digest admite patrones de ignoración personalizados utilizando un archivo .aidigestignore en el directorio raíz de su proyecto. Este archivo funciona de manera similar a .gitignore , lo que le permite especificar archivos y directorios que deben excluirse de la agregación.

Utilice la marca --show-output-files para ver qué archivos se incluyen, lo que facilita la identificación de candidatos para la exclusión.

Eliminación de espacios en blanco

Cuando se usa el indicador --whitespace-removal , ai-digest elimina el exceso de espacios en blanco de los archivos para reducir el recuento de tokens cuando se usa con modelos de IA. Esta función está deshabilitada para lenguajes que dependen de espacios en blanco como Python y YAML.

Manejo de archivos binarios y SVG

Los archivos binarios y SVG se incluyen en el resultado con una nota sobre su tipo de archivo. Esto permite que los modelos de IA conozcan estos archivos sin incluir su contenido completo.

Desarrollo Local

Ejecute npm run start para ejecutar la herramienta CLI en el proyecto local. (¡Muy meta!)

Ejecute npm test para ejecutar las pruebas.

Para pasar indicadores a la CLI, use el indicador -- , como este: npm run start -- --whitespace-removal .

Implementar nueva versión

npm publish

Contribuyendo

¡Las contribuciones son bienvenidas! No dude en enviar una solicitud de extracción.

Licencia

Este proyecto está bajo la licencia MIT.