codeprompts

Prompts de código

Ferramenta Linha de comando (e TUI) para criar prompts LLM do seu código usando modelos de guidão.

Este foi um projeto para aprimorar a ferrugem e é baseado no Code2Prompt com algumas funcionalidades adicionais que achei úteis.

• Por que o código solicita?
• Interface do usuário do terminal
• Instalação
  • Libere o binário
  • Edifício da fonte
• Uso
  • Argumentos
• Modelos
• Guias de uso

---

Por que o código solicita?

Copiar manualmente e colar o código e os trechos de código para o LLMS tem vários problemas:

1. Você perde formatação e estrutura . Para um idioma como o Python que usa espaço em branco, a formatação e a estrutura do código são importantes para o LLM entender com precisão e abrangência o código da sua solicitação.
2. Você perde o contexto . Para que o LLM forneça as melhores respostas, requer o contexto de todo o seu código. Isso inclui as dependências do seu snippet de código, outros módulos/objetos definidos pelo usuário e outras variáveis ​​e conceitos de escopo.
3. Você perde a padronização imediata : se você estiver usando o LLMS para executar tarefas repetidas, como documentar o código, precisará garantir que suas diretrizes de estilo de documentação sejam consistentes em todas as solicitações.
4. Números de linha! : Em grandes entradas, os LLMs tendem a fornecer alterações de código para linhas precisas, dificultando a definição exatamente de onde aplicar/revisar as alterações propostas. Os números de linha ajudam a aliviar isso para uma melhor proveniência do código.

Para tirar o máximo proveito do LLMS, o pedido deve ser claro, abrangente e consistente. Como o código solicita corrigir esses problemas:

1. Os avisos de código garantirão que a estrutura inerente ao seu código seja retida para limitar qualquer possível interpretação ou inferir necessária do LLM.
2. O contexto completo necessário para a compreensão do código é anexado em um formato padronizado. Isso inclui a árvore do diretório do projeto e o caminho do arquivo.
3. Ao usar modelos de guidão, os avisos serão abrangentes e consistentes. Se o seu guia de estilo preferido e/ou práticas de codificação forem atualizados no futuro, não há necessidade de se lembrar de atualizar todos os futuros prompts digitados manualmente. Em vez disso, basta atualizar o modelo do guidão de destino uma vez.

Interface do usuário do terminal

O projeto também inclui um invólucro opcional da TUI, onde você pode fornecer um arquivo de configuração para substituir vários sinalizadores e ver como o comando é estruturado antes de executá -lo.

Instalação

Para baixar e usar a ferramenta de linha de comando CodePrompts, você tem duas opções: você pode baixar o binário de liberação ou compilar da fonte. Para etapas mais detalhadas, incluindo a configuração das conclusões da guia, consulte o guia de configuração.

Libere o binário

Para baixar um binário de lançamento, acesse os lançamentos e baixe o binário para o seu sistema operacional.

NOTA : Para usar o binário TUI, você precisará adicionar o binário da CLI ao seu caminho e:

• Renomeie o CLI Release binário para codeprompt
• Atualize o arquivo de configuração para o comando executar o binário da CLI

Edifício da fonte

Para construir a partir da fonte, você precisará ter git, ferrugem e carga (será instalado com ferrugem) instalado.

Primeiro clone o repositório:

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

E então compile um binário de liberação:

 cd codeprompts/
cargo build --release

Uso

Guias de uso mais detalhados podem ser encontrados aqui.

Argumentos

Documentação mais extensa sobre as opções pode ser encontrada aqui. O código solicita a ferramenta de linha de comando tem os seguintes 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

Modelos

Os modelos usam uma linguagem simples de modelos chamada guidão.

Os modelos predefinidos podem ser baixados dos lançamentos do projeto. Faça o download dos templates.zip .

Atualmente, os modelos predefinidos incluídos são:

Nome do modelo	Descrição
default_template.hbs	Este é um modelo padrão simples que estruturará o caminho do projeto, a árvore de origem e os blocos de código.
documentation_template.hbs	O modelo de documentação cria um prompt para documentar o código. As diretrizes de documentação são consistentes com as diretrizes do Hive Lab.
git_commit.hbs	Modelo para criar uma mensagem de comprometimento concisa e precisa do Git. Pode ser usado com as opções diff-staged e diff-unstaged .
git_issues.hbs	Modelo para implementar alterações com base em um problema do GitHub.
code_optimization.hbs	Modelo para otimizar o código na complexidade do tempo e do espaço.