codeprompts

Indica el código

Herramienta de línea de comando (y tui) para crear las indicaciones LLM desde su código utilizando plantillas de manillares.

Este fue un proyecto para repasar el óxido y se basa en Code2Prompt con alguna funcionalidad adicional que me pareció útil.

• ¿Por qué el código indica?
• Interfaz de usuario terminal
• Instalación
  • Liberar binario
  • Edificio de la fuente
• Uso
  • Argumentos
• Plantillas
• Guías de uso

---

¿Por qué el código indica?

Copiar y pegar el código y el código de los fragmentos de código a LLMS tiene varios problemas:

1. Pierdes el formato y la estructura . Para un lenguaje como Python que usa espacios en blanco, el formato y la estructura del código es importante para que el LLM comprenda el código de manera precisa e integral para su solicitud.
2. Pierdes el contexto . Para que el LLM proporcione las mejores respuestas, requiere el contexto de todo su código. Esto incluye las dependencias de su fragmento de código, otros módulos/objetos definidos por el usuario y otras variables y conceptos de alcance.
3. Pierde la avalancha de estandarización : si está utilizando LLM para realizar tareas repetidas como documentar el código, debe asegurarse de que las pautas de estilo de documentación sean consistentes en cada solicitud.
4. ¡Números de línea! : En las entradas grandes, los LLM tienden a proporcionar cambios en el código a líneas precisas, lo que dificulta la fijación exactamente de dónde aplicar/revisar los cambios propuestos. Los números de línea ayudan a aliviar esto para una mejor procedencia de código.

Para aprovechar al máximo las LLM, la solicitud debe ser clara, integral y consistente. Cómo las indicaciones del código solucionan estos problemas:

1. Las indicaciones del código asegurarán que la estructura inherente de su código se retenga para limitar cualquier posible interpretación errónea o inferrencia requerida de la LLM.
2. El contexto completo requerido para comprender el código está encerrado en un formato estandarizado. Esto incluye el árbol del directorio del proyecto y la ruta de archivo.
3. Mediante el uso de plantillas de manillar, las indicaciones serán integrales y consistentes. Si su guía de estilo preferido y/o prácticas de codificación se actualizan en el futuro, no hay necesidad de recordar actualizar todas las indicaciones futuras tipadas manualmente. En su lugar, simplemente actualice la plantilla de Manillar de destino una vez.

Interfaz de usuario terminal

El proyecto también incluye un contenedor TUI opcional donde puede proporcionar un archivo de configuración para anular varios indicadores y ver cómo se estructura el comando antes de ejecutarlo.

Instalación

Para descargar y usar la herramienta de línea de comandos de CodePrompts, tiene dos opciones: puede descargar el binario de lanzamiento o compilar desde la fuente. Para obtener pasos más detallados, incluida la configuración de la pestaña, consulte la guía de configuración.

Liberar binario

Para descargar un binario de lanzamiento, vaya a los lanzamientos y descargue el binario para su sistema operativo.

Nota : Para usar el binario Tui, deberá agregar el binario CLI a su ruta y cualquiera de los dos:

• Cambiar el nombre del binario de lanzamiento de CLI a codeprompt
• Actualice el archivo de configuración para el comando para ejecutar el binario CLI

Edificio de la fuente

Para construir desde la fuente, deberá instalarse Git, Rust y Cargo (se instalará con óxido).

Primer clon el repositorio:

git clone [email protected]:seankim658/codeprompts.git

Y luego compilar un binario de lanzamiento:

 cd codeprompts/
cargo build --release

Uso

Se pueden encontrar guías de uso más detalladas aquí.

Argumentos

Puede encontrar una documentación más extensa sobre las opciones aquí. La herramienta de línea de comando de solicita el código tiene los siguientes argumentos:

Create standardized LLM prompts from your code

Usage: codeprompt [OPTIONS] [PATH] [COMMAND]

Commands:
  completion  Generate shell completion scripts.
  help        Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]  Path to project directory

Options:
      --include <INCLUDE>    Glob patterns to include
      --exclude <EXCLUDE>    Glob patterns to exclude
      --exclude-priority     Change pattern priority in case of conflict to prioritize the exclusion pattern
      --exclude-from-tree    Eclude files/folders from the source tree based on exclude patterns
      --gitignore            Don't respect .gitignore file
  -d, --diff-staged          Capture the git diff for staged changes only (equivalent to running `git diff --cached` or `git diff --staged`
  -u, --diff-unstaged        Capture the git diff for unstaged changes only (equivalent to running `git diff`)
      --no-tokens            Don't display approximate token count of the genrated prompt
  -c, --encoding <ENCODING>  Tokenizer to use for token count [default: cl100k]
  -o, --output <OUTPUT>      Redirect output to file
  -l, --no-line-numbers      Turn off line numbers in source code blocks
      --no-codeblock         Disable wrapping code inside markdown code blocks
      --relative-paths       Use relative paths instead of absolute paths, including parent directory
      --no-clipboard         Disable copying to clipboard
  -t, --template <TEMPLATE>  Optional path to Handlebars template
      --no-spinner           Whether to render the spinner
      --json                 Whether to print the output as JSON. Defaults to False
      --issue <ISSUE>        Fetch a specific Github issue for the repository
      --verbose              Run in verbose mode to investigate glob pattern matching
  -h, --help                 Print help (see more with '--help')
  -V, --version              Print version

Plantillas

Las plantillas usan un lenguaje de plantilla simple llamado manillares.

Las plantillas predefinidas se pueden descargar de los lanzamientos del proyecto. Descargue las templates.zip .

Actualmente, las plantillas predefinidas incluidas son:

Nombre de plantilla	Descripción
default_template.hbs	Esta es una plantilla predeterminada simple que estructurará su ruta de proyecto, árbol de origen y bloques de código.
documentation_template.hbs	La plantilla de documentación crea un mensaje para documentar el código. Las pautas de documentación son consistentes con las pautas de Hive Lab y los requisitos de documentación.
git_commit.hbs	Plantilla para crear un mensaje de confirmación Git conciso y preciso. Se puede usar con las opciones de diff-staged diff-unstaged .
git_issues.hbs	Plantilla para implementar cambios basados ​​en un problema de GitHub.
code_optimization.hbs	Plantilla para optimizar el código en el tiempo y la complejidad del espacio.