Основное использование Code2Prompt

Обзор руководства

Добро пожаловать в руководство по использованию Code2Prompt.

Использование

Генерация промпта из кодовой базы:

code2prompt путь/к/кодовой/базе

Генерация промпта и копирование в буфер обмена:

code2prompt путь/к/кодовой/базе -c

Запуск интерактивного TUI:

code2prompt путь/к/кодовой/базе --tui

Отображение карты токенов:

code2prompt путь/к/кодовой/базе --token-map

Использование пользовательского шаблона Handlebars:

code2prompt путь/к/кодовой/базе -t путь/к/шаблону.hbs

Фильтрация файлов с помощью glob‑шаблонов:

code2prompt путь/к/кодовой/базе --include="*.rs,*.toml"

Исключение файлов с помощью glob‑шаблонов:

code2prompt путь/к/кодовой/базе --exclude="*.txt,*.md"

Исключение файлов/папок из дерева исходного кода по шаблонам исключения:

code2prompt путь/к/кодовой/базе --exclude="*.npy,*.wav" --exclude-from-tree

Отображение количества токенов сгенерированного промпта:

code2prompt путь/к/кодовой/базе --tokens

Указание токенизатора для подсчёта токенов:

code2prompt путь/к/кодовой/базе --tokens --encoding=p50k

Поддерживаемые токенизаторы: cl100k, p50k, p50k_edit, r50k_bas.

Сохранение сгенерированного промпта в файл:

code2prompt путь/к/кодовой/базе -O output.txt

Вывод в формате JSON:

code2prompt путь/к/кодовой/базе -F JSON

Пример JSON‑вывода:

{
  "prompt": "<Сгенерированный промпт>",
  "directory_name": "codebase",
  "token_count": 1234,
  "model_info": "ChatGPT модели, text-embedding-ada-002",
  "files": []
}

Генерация сообщения коммита Git (для проиндексированных файлов):

code2prompt путь/к/кодовой/базе --diff -t templates/write-git-commit.hbs

Генерация Pull Request с сравнением веток (для проиндексированных файлов):

code2prompt путь/к/кодовой/базе --git-diff-branch 'main, development' --git-log-branch 'main, development' -t templates/write-github-pull-request.hbs

Добавление номеров строк к блокам кода:

code2prompt путь/к/кодовой/базе --line-number

Отключение обёртки кода в markdown‑блоках:

code2prompt путь/к/кодовой/базе --no-codeblock

Code2Prompt — отличный инструмент для эффективного создания токен‑оптимизированных промптов. Он полезен в различных сценариях, таких как:

Переписывание кода на другой язык
Поиск багов/уязвимостей
Документирование кода
Реализация новых функций