Code2Prompt Grundlegende Nutzung

Übersicht der Anleitung

Willkommen zur Code2Prompt-Nutzungsanleitung.

Nutzung

Prompt aus einem Code‑Basisverzeichnis generieren:

code2prompt pfad/zur/codebase

Prompt generieren und in die Zwischenablage kopieren:

code2prompt pfad/zur/codebase -c

Interaktive TUI starten:

code2prompt pfad/zur/codebase --tui

Token‑Map anzeigen:

code2prompt pfad/zur/codebase --token-map

Eigenes Handlebars‑Template verwenden:

code2prompt pfad/zur/codebase -t pfad/zum/template.hbs

Dateien mit Glob‑Mustern filtern:

code2prompt pfad/zur/codebase --include="*.rs,*.toml"

Dateien mit Glob‑Mustern ausschließen:

code2prompt pfad/zur/codebase --exclude="*.txt,*.md"

Dateien/Ordner im Quellbaum anhand von Ausschlussmustern entfernen:

code2prompt pfad/zur/codebase --exclude="*.npy,*.wav" --exclude-from-tree

Token‑Anzahl des generierten Prompts anzeigen:

code2prompt pfad/zur/codebase --tokens

Tokenizer für die Token‑Zählung angeben:

code2prompt pfad/zur/codebase --tokens --encoding=p50k

Unterstützte Tokenizer: cl100k, p50k, p50k_edit, r50k_bas.

Prompt in eine Ausgabedatei schreiben:

code2prompt pfad/zur/codebase -O ausgabe.txt

Ausgabe als JSON ausgeben:

code2prompt pfad/zur/codebase -F JSON

Die JSON‑Ausgabe hat folgendes Format:

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

Git‑Commit‑Nachricht generieren (für gestagte Dateien):

code2prompt pfad/zur/codebase --diff -t templates/write-git-commit.hbs

Pull‑Request mit Branch‑Vergleich generieren (für gestagte Dateien):

code2prompt pfad/zur/codebase --git-diff-branch 'main, development' --git-log-branch 'main, development' -t templates/write-github-pull-request.hbs

Zeilennummern zu Quellcode‑Blöcken hinzufügen:

code2prompt pfad/zur/codebase --line-number

Code‑Block‑Umhüllung in Markdown‑Blöcken deaktivieren:

code2prompt pfad/zur/codebase --no-codeblock

Code2Prompt ist ein hervorragendes Werkzeug, um effizient token‑optimierte Prompts zu erzeugen. Es ist nützlich für verschiedene Anwendungsfälle, z. B.:

Code in eine andere Sprache umschreiben.
Fehler bzw. Sicherheitslücken finden.
Code dokumentieren.
Neue Funktionen implementieren.