codeprompts

Invites de code

Outil de ligne de commande (et TUI) pour créer des invites LLM à partir de votre code à l'aide de modèles de guidon.

Il s'agissait d'un projet de brossage sur la rouille et est basé sur Code2Prompt avec des fonctionnalités supplémentaires que j'ai trouvées utiles.

• Pourquoi le code invite?
• Interface utilisateur terminal
• Installation
  • Libérer le binaire
  • Bâtiment de Source
• Usage
  • Arguments
• Modèles
• Guides d'utilisation

---

Pourquoi le code invite?

Copier manuellement et coller du code et des extraits de code à LLMS a plusieurs problèmes:

1. Vous perdez le formatage et la structure . Pour une langue comme Python qui utilise Whitespace, le formatage et la structure du code sont importants pour que le LLM comprenne avec précision et de manière exhaustive le code de votre demande.
2. Vous perdez un contexte . Pour que le LLM puisse fournir les meilleures réponses, elle nécessite le contexte de tout votre code. Cela inclut les dépendances de votre extrait de code, d'autres modules / objets définis par l'utilisateur et d'autres variables et concepts de portée.
3. Vous perdez une normalisation invite : si vous utilisez des LLM pour effectuer des tâches répétées comme la documentation du code, vous devez vous assurer que vos directives de style de documentation sont cohérentes sur chaque demande.
4. Numéros de ligne! : Sur les grandes entrées, les LLM ont tendance à fournir des modifications de code dans des lignes précises, ce qui rend difficile la conduite exactement où appliquer / revoir les modifications proposées. Les numéros de ligne aident à atténuer cela pour une meilleure provenance du code.

Pour tirer le meilleur parti des LLM, l'incitation doit être claire, complète et cohérente. Comment le code invite à résoudre ces problèmes:

1. Les invites de code garantiront que la structure inhérente de votre code est conservée pour limiter toute mauvaise interprétation ou l'inferrence requise du LLM.
2. Le contexte complet requis pour comprendre le code est enfermé dans un format standardisé. Cela inclut l'arborescence du répertoire de projet et le parcours de fichiers.
3. En utilisant des modèles de guidon, les invites seront complètes et cohérentes. Si votre guide de style préféré et / ou vos pratiques de codage sont mises à jour à l'avenir, il n'est pas nécessaire de se rappeler de mettre à jour toutes les futures invites typées manuellement. Au lieu de cela, mettez simplement à jour le modèle de guidon cible une fois.

Interface utilisateur terminal

Le projet comprend également un wrapper TUI en option où vous pouvez fournir un fichier de configuration pour remplacer divers indicateurs et voir comment la commande est structurée avant de l'exécuter.

Installation

Pour télécharger et utiliser l'outil de ligne de commande CodePRompts, vous avez deux options: vous pouvez télécharger la version binaire ou compiler à partir de la source. Pour des étapes plus détaillées, y compris la configuration des compléments des onglets, consultez le guide de configuration.

Libérer le binaire

Pour télécharger une version binaire, accédez aux versions et téléchargez le binaire pour votre système d'exploitation.

Remarque : Pour utiliser le binaire TUI, vous devrez ajouter le binaire CLI à votre chemin et soit:

• Renommer le binaire de libération de CLI à codeprompt
• Mettez à jour le fichier de configuration pour que la commande exécute le binaire CLI

Bâtiment de Source

Pour construire à partir de la source, vous devrez installer du git, de la rouille et de la cargaison (sera installé avec de la rouille).

Premier cloner le référentiel:

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

Puis compiler une libération binaire:

 cd codeprompts/
cargo build --release

Usage

Des guides d'utilisation plus détaillés peuvent être trouvés ici.

Arguments

Des documents plus approfondis sur les options peuvent être trouvés ici. L'outil de ligne de commande d'invite de code a les arguments suivants:

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

Modèles

Les modèles utilisent une langue de modèle simple appelée guidon.

Les modèles prédéfinis peuvent être téléchargés à partir des versions du projet. Téléchargez les templates.zip .

Actuellement, les modèles prédéfinis inclus sont:

Nom de modèle	Description
default_template.hbs	Il s'agit d'un modèle par défaut simple qui structurera votre chemin de projet, votre arbre source et vos blocs de code.
documentation_template.hbs	Le modèle de documentation crée une invite pour documenter le code. Les directives de documentation sont conformes aux directives de Hive Lab et aux exigences de documentation.
git_commit.hbs	Modèle pour créer un message GIT Commit concis et précis. Peut être utilisé avec les options diff-staged et diff-unstaged .
git_issues.hbs	Modèle pour implémenter des modifications basées sur un problème GitHub.
code_optimization.hbs	Modèle pour optimiser le code dans le temps et la complexité de l'espace.