snap2txt

Snap2txt

Snap2Txt es una utilidad de Python que captura la estructura y el contenido de un directorio de proyecto y los guarda en un archivo de texto. Está diseñado para una documentación rápida del sistema de archivos de su proyecto.

Características

• Captura completa : registra toda la estructura del archivo y el contenido del proyecto.
• Filtros personalizables : ofrece opciones de ignore y blanca para escaneo dirigido.
• Interfaz de línea de comandos : herramienta de línea de comandos simple y fácil de usar.

Instalación

Instale Snap2Txt con PIP:

pip install snap2txt

Nota : La instalación ahora proporciona automáticamente archivos .il y .wl junto con el paquete.

Uso

Navegue a su directorio de proyecto y ejecute:

snap2txt

De forma predeterminada, Snap2TXT escaneará todos los archivos y directorios en la carpeta actual y producirá un archivo de salida llamado project_contents.txt .

Localice los archivos .il y .wl

Si necesita ver dónde se instalaron los archivos .il y .wl de Snap2txt en su sistema (por ejemplo, para personalizarlos), ejecute:

snap2txt --show-locations

Esto imprimirá la ruta completa a cada archivo, para que pueda abrirlos o editarlo según sea necesario.

Banderas opcionales

• --il : use la lista Ignore definida en .il .
• --wl : use la lista blanca definida en .wl .

Ejemplo:

snap2txt --il

snap2txt --wl

Configuración

Snap2Txt respeta dos archivos para el filtrado:

1. Ignorar la lista ( .il ) : excluya ciertos archivos/directorios.
2. Whitelist ( .wl ) : incluya solo ciertos archivos/directorios.

De forma predeterminada, Snap2TXT instala un .il y .wl básico en el directorio de paquetes. Para adaptar el comportamiento de su proyecto, puede editar esos archivos o reemplazarlos con sus propias reglas personalizadas.

Consejo : Para localizar rápidamente dónde se instalaron estos archivos, use snap2txt --show-locations .

Ejemplo .il archivo

 node_modules/
*.log

Ejemplo .wl archivo

 *.py
*.md

Que contribuye

¡Las contribuciones a Snap2Txt son bienvenidas! Siéntase libre de desembolsar el repositorio, hacer sus cambios y enviar una solicitud de extracción.

Licencia

SNAT2TXT es un software de código abierto con licencia bajo la licencia MIT.

Apoyo

Para soporte, preguntas o comentarios, abra un problema en el repositorio de GitHub.