Getting Started with Code2Prompt

Обзор учебника

Добро пожаловать в Code2Prompt! Этот учебник предоставляет всестороннее введение в использование Code2Prompt для генерации готовых к использованию ИИ подсказок из вашего кода. Мы рассмотрим его основные функции и продемонстрируем его использование в различных методах интеграции: интерфейс командной строки (CLI), набор средств разработки (SDK) и протокол контекста модели (MCP).

Что такое Code2Prompt?

Code2Prompt - это универсальный инструмент, предназначенный для устранения разрыва между вашим кодом и большими языковыми моделями (LLM). Он интеллектуально извлекает соответствующие фрагменты кода, применяет мощную фильтрацию и форматирует информацию в структурированные подсказки, оптимизированные для потребления LLM. Это упрощает задачи, такие как документирование кода, обнаружение ошибок, рефакторинг и многое другое.

Code2Prompt предлагает различные точки интеграции:

Core

Основная библиотека Rust, обеспечивающая основу для потребления кода и подсказок.

CLI

Дружественный интерфейс командной строки для быстрой генерации подсказок. Идеален для интерактивного использования и одноразовых задач.

SDK

Мощный набор средств разработки (SDK) для бесшовной интеграции в ваши проекты на Python. Идеален для автоматизации генерации подсказок в рамках более крупных рабочих процессов.

MCP

Сервер протокола контекста модели (MCP) для расширенной интеграции с агентами LLM. Позволяет осуществлять сложные,实时 взаимодействия с вашим кодом.

📥 Установка

Для получения подробных инструкций по установке всех методов (CLI, SDK, MCP) обратитесь к всестороннему Руководству по установке.

🏁 Генерация подсказок: пример CLI

Давайте начнем с простого примера использования CLI. Создайте образец проекта:

mkdir -p my_project/{src,tests}
touch my_project/src/main.rs my_project/tests/test_1.rs
echo 'fn main() { println!("Hello, world!"); }' > my_project/src/main.rs

Теперь сгенерируйте подсказку:

code2prompt my_project

Это копирует подсказку в ваш буфер обмена. Вы можете настроить это:

• Фильтрация: code2prompt my_project --include="*.rs" --exclude="tests/*" (включает только файлы .rs, исключает каталог tests)
• Файл вывода: code2prompt my_project --output-file=my_prompt.txt
• JSON-вывод: code2prompt my_project -O json (структурированный JSON-вывод)
• Пользовательские шаблоны: code2prompt my_project -t my_template.hbs (требуется создание my_template.hbs)

См. учебники Learn Context Filtering и Learn Handlebar Templates, чтобы узнать о более продвинутом использовании.

🐍 Интеграция SDK (Python)

Для программного управления используйте Python SDK:

from code2prompt_rs import Code2Prompt

config = {
    "path": "my_project",
    "include_patterns": ["*.rs"],
    "exclude_patterns": ["tests/*"],
}

c2p = Code2Prompt(**config)
prompt = c2p.generate_prompt()
print(prompt)

Это требует установки SDK (pip install code2prompt_rs). Обратитесь к документации SDK для более подробной информации.

🤖 Интеграция с сервером MCP (расширенная)

Для расширенной интеграции с агентами LLM запустите сервер code2prompt MCP (см. руководство по установке для подробностей). Это позволяет агентам запрашивать контекст кода динамически. Это расширенная функция, и дополнительная документация доступна на сайте проекта.

Следующие шаги

Изучите расширенные учебники и документацию, чтобы освоить возможности Code2Prompt и интегрировать его в ваши рабочие процессы.

Эта страница была автоматически переведена для вашего удобства. Обратитесь к английской версии для получения оригинального содержания.