code2prompt

Быстрая установка ⚡

# Cargo
$ cargo install code2prompt

# Homebrew
$ brew install code2prompt

SDK с pip 🐍

pip install code2prompt-rs

Related MCP server: Gemini CLI MCP Server

Чем это полезно?

Основной

code2prompt — это инструмент для приема кода, который упрощает процесс создания подсказок LLM для анализа кода, генерации и других задач. Он работает путем обхода каталогов, построения древовидной структуры и сбора информации о каждом файле. Основная библиотека может быть легко интегрирована в другие приложения.

CLI

Интерфейс командной строки code2prompt (CLI) был разработан для людей, чтобы они могли генерировать подсказки непосредственно из вашей кодовой базы. Сгенерированная подсказка автоматически копируется в буфер обмена и может быть сохранена в выходной файл. Кроме того, вы можете настроить генерацию подсказок с помощью шаблонов Handlebars. Ознакомьтесь с предоставленными подсказками в документе!

SDK

Комплект разработки программного обеспечения (SDK) code2prompt предлагает привязку Python к основной библиотеке. Это идеально подходит для агентов ИИ или скриптов автоматизации, которые хотят беспрепятственно взаимодействовать с кодовой базой. SDK размещен на Pypi и может быть установлен через pip.

МКП

code2prompt также доступен как сервер Model Context Protocol (MCP), что позволяет запускать его как локальную службу. Это позволяет LLM на стероидах, предоставляя им инструмент для автоматического сбора хорошо структурированного контекста вашей кодовой базы.

Документация 📚

Подробные инструкции можно найти в нашей онлайн -документации .

Функции

Code2Prompt преобразует всю вашу кодовую базу в хорошо структурированную подсказку для больших языковых моделей. Основные функции включают:

• Автоматическая обработка кода : преобразование кодовых баз любого размера в читаемые, отформатированные подсказки.

• Умная фильтрация : включение/исключение файлов с использованием шаблонов glob и соблюдение правил .gitignore

• Гибкие шаблоны : настраивайте подсказки с помощью шаблонов Handlebars для различных вариантов использования.

• Отслеживание токенов : отслеживание использования токенов для соблюдения ограничений контекста LLM.

• Интеграция с Git : включение различий, журналов и сравнений веток в ваши подсказки

• Опыт разработчика : автоматическое копирование в буфер обмена, нумерация строк и параметры организации файлов

Хватит вручную копировать файлы и форматировать код для LLM. Code2Prompt берет на себя утомительную работу, чтобы вы могли сосредоточиться на получении идей и решений из моделей ИИ.

Альтернативная установка

Подробные инструкции по установке смотрите в документации .

Бинарные релизы

Загрузите последнюю версию двоичного кода для вашей ОС с сайта Releases .

Исходный код сборки

Требует:

• Git , Rust и Cargo .

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt/
cargo install --path crates/code2prompt

История Звезды

Лицензия

Лицензировано по лицензии MIT, для получения дополнительной информации см. ЛИЦЕНЗИЯ.

Понравился проект?

Если вам понравился проект и вы нашли его полезным, пожалуйста, поставьте ему :star: !

Вклад

Способы внесения вклада:

• Предложить функцию

• Сообщить об ошибке

• Исправьте что-нибудь и откройте запрос на включение

• Помогите мне задокументировать код

• Распространите слово