codeprompts

Code -Eingabeaufforderungen

Befehlszeile (und TUI) Tool zum Erstellen von LLM -Eingabeaufforderungen aus Ihrem Code mithilfe von Lenkervorlagen.

Dies war ein Projekt, das Rost aufbereiten und auf Code2Prompt basiert, mit einer zusätzlichen Funktionalität, die ich nützlich fand.

• Warum Code -Eingabeaufforderungen?
• Terminalbenutzerschnittstelle
• Installation
  • Binär veröffentlichen
  • Gebäude aus der Quelle
• Verwendung
  • Argumente
• Vorlagen
• Nutzungsführer

---

Warum Code -Eingabeaufforderungen?

Kopieren und Einfügen von Code und Code -Snippets in LLMs haben mehrere Probleme:

1. Sie verlieren Formatierung und Struktur . Für eine Sprache wie Python, die Whitespace verwendet, ist die Formatierung und Struktur des Codes wichtig, damit der LLM den Code für Ihre Anfrage genau und umfassend verstehen kann.
2. Sie verlieren den Kontext . Damit der LLM die besten Antworten liefert, erfordert der Kontext aus Ihrem gesamten Code. Dies beinhaltet die Abhängigkeiten Ihres Codes -Snippets, andere benutzerdefinierte Module/Objekte sowie andere Umfangsvariablen und -konzepte.
3. Sie verlieren eine schnelle Standardisierung : Wenn Sie LLMs verwenden, um wiederholte Aufgaben wie das Dokumentieren von Code auszuführen, müssen Sie sicherstellen, dass Ihre Dokumentationsstyling -Richtlinien für jede Anfrage konsistent sind.
4. Zeilennummern! : Bei großen Eingängen liefern LLMs in der Regel Codeänderungen für präzise Zeilen, sodass es schwierig ist, genau zu bestimmen, wo die vorgeschlagenen Änderungen angewendet/prüfen müssen. Zeilennummern helfen dabei, dies für eine bessere Code -Herkunft zu lindern.

Um das Beste aus LLMs herauszuholen, muss das Auffordern klar, umfassend und konsequent sein. Wie Code auffordert, diese Probleme zu beheben:

1. Die Code -Eingabeaufforderungen stellen sicher, dass die inhärente Struktur Ihres Codes beibehalten wird, um eine mögliche Fehlinterpretation oder Abschlussfehlstellung des LLM zu begrenzen.
2. Der vollständige Kontext, der zum Verständnis des Code erforderlich ist, ist in einem standardisierten Format eingeschlossen. Dies schließt den Projektverzeichnisbaum und den Dateipfad ein.
3. Durch die Verwendung von Lenkervorlagen sind die Eingabeaufforderungen umfassend und konsistent. Wenn Ihr bevorzugter Stilhandbuch und/oder Codierungspraktiken in Zukunft aktualisiert werden, müssen Sie sich nicht daran erinnern, alle zukünftigen manuell getippten Eingabeaufforderungen zu aktualisieren. Aktualisieren Sie stattdessen nur einmal die Target -Lenkervorlage.

Terminalbenutzerschnittstelle

Das Projekt enthält auch einen optionalen TUI -Wrapper, bei dem Sie eine Konfigurationsdatei zur Übergabe verschiedener Flags bereitstellen und feststellen können, wie der Befehl vor dem Ausführen strukturiert ist.

Installation

Um das CODEPROMPTS-Befehlszeilen-Tool herunterzuladen und zu verwenden, haben Sie zwei Optionen: Sie können die Release-Binärdauer herunterladen oder aus der Quelle kompilieren. Weitere detaillierte Schritte, einschließlich der Einrichtung der Registerkartenabschlüsse, finden Sie im Setup -Handbuch.

Binär veröffentlichen

Um eine Release -Binärin herunterzuladen, gehen Sie zu den Veröffentlichungen und laden Sie die Binärdatei für Ihr Betriebssystem herunter.

Hinweis : Um die Tui -Binärin zu verwenden, müssen Sie den CLI -Binärer zu Ihrem Weg hinzufügen und beide:

• Benennen Sie die CLI -Release -Binärdatei in codeprompt um
• Aktualisieren Sie die Konfigurationsdatei für den Befehl, um die CLI -Binärin auszuführen

Gebäude aus der Quelle

Um aus der Quelle zu bauen, müssen Sie Git, Rost und Fracht (mit Rost installiert werden) installiert.

Erster Klon das Repository:

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

Und dann eine Veröffentlichung Binary zusammenstellen:

 cd codeprompts/
cargo build --release

Verwendung

Hier finden Sie detailliertere Verwendungsleitfäden.

Argumente

Umfangreichere Dokumentation zu den Optionen finden Sie hier. Das Befehlszeilen -Tool für den Code fordert die folgenden Argumente auf:

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

Vorlagen

Die Vorlagen verwenden eine einfache Vorlagensprache namens Lenker.

Die vordefinierten Vorlagen können aus den Projektveröffentlichungen heruntergeladen werden. Laden Sie die templates.zip .

Derzeit sind die mitgelieferten vordefinierten Vorlagen:

Vorlagenname	Beschreibung
default_template.hbs	Dies ist eine einfache Standardvorlage, die Ihren Projektpfad, Quellbaum und Codeblöcke strukturiert.
documentation_template.hbs	Die Dokumentationsvorlage erstellt eine Aufforderung zum Dokumentieren von Code. Die Dokumentationsrichtlinien stimmen mit den Hive Laborines und Dokumentationsanforderungen überein.
git_commit.hbs	Vorlage zum Erstellen einer prägnanten und genauen Git -Commit -Nachricht. Kann sowohl mit den diff-staged als auch diff-unstaged Optionen verwendet werden.
git_issues.hbs	Vorlage zur Implementierung von Änderungen basierend auf einem GitHub -Problem.
code_optimization.hbs	Vorlage zum Optimieren von Code in Zeit und Raumkomplexität.