Uso básico de Code2Prompt

Descripción general de la guía

Bienvenido a la guía de uso de Code2Prompt.

Uso

Generar un prompt desde un código base:

code2prompt ruta/a/código-base

Generar un prompt y copiarlo al portapapeles:

code2prompt ruta/a/código-base -c

Iniciar la TUI interactiva:

code2prompt ruta/a/código-base --tui

Mostrar el mapa de tokens

code2prompt ruta/a/código-base --token-map

Usar un archivo de plantilla Handlebars personalizado:

code2prompt ruta/a/código-base -t ruta/a/plantilla.hbs

Filtrar archivos usando patrones glob:

code2prompt ruta/a/código-base --include="*.rs,*.toml"

Excluir archivos usando patrones glob:

code2prompt ruta/a/código-base --exclude="*.txt,*.md"

Excluir archivos/carpetas del árbol de origen según patrones de exclusión:

code2prompt ruta/a/código-base --exclude="*.npy,*.wav" --exclude-from-tree

Mostrar el recuento de tokens del prompt generado:

code2prompt ruta/a/código-base --tokens

Especificar un tokenizador para el recuento de tokens:

code2prompt ruta/a/código-base --tokens --encoding=p50k

Tokenizadores compatibles: cl100k, p50k, p50k_edit, r50k_bas.

Guardar el prompt generado en un archivo de salida:

code2prompt ruta/a/código-base -O output.txt

Imprimir salida como JSON:

code2prompt ruta/a/código-base -F JSON

La salida JSON tendrá la siguiente estructura:

{
  "prompt": "<Prompt generado>",
  "directory_name": "codebase",
  "token_count": 1234,
  "model_info": "ChatGPT models, text-embedding-ada-002",
  "files": []
}

Generar un mensaje de commit de Git (para archivos preparados):

code2prompt ruta/a/código-base --diff -t templates/write-git-commit.hbs

Generar una Pull Request con comparación de ramas (para archivos preparados):

code2prompt ruta/a/código-base --git-diff-branch 'main, development' --git-log-branch 'main, development' -t templates/write-github-pull-request.hbs

Agregar números de línea a los bloques de código fuente:

code2prompt ruta/a/código-base --line-number

Desactivar el encapsulado de código dentro de bloques de código markdown:

code2prompt ruta/a/código-base --no-codeblock

Code2prompt es una excelente manera de generar prompts de forma eficiente en tokens. Puede ser práctico para una variedad de casos de uso, tales como:

Reescribir el código en otro lenguaje.
Encontrar errores/vulnerabilidades de seguridad.
Documentar el código.
Implementar nuevas funcionalidades.