---
title: Документация Code2Prompt
description: Официальная документация Code2prompt
template: splash
hero:
  tagline: Преобразуйте свой код в оптимизированные для ИИ подсказки за секунды
  image:
    file: ../../../../assets/logo_dark_v0.0.1.svg
  actions:
    - text: Начать работу 🚀
      link: /docs/tutorials/getting_started
    - text: Установка 📥
      link: /docs/how_to/install
---

import { Card, CardGrid } from "@astrojs/starlight/components";
import { LinkCard } from "@astrojs/starlight/components";

## Быстрый старт

<LinkCard title="Начало работы 🚀" href="/docs/tutorials/getting_started" />
<LinkCard title="Установка 📥" href="/docs/how_to/install" />
<LinkCard
  title="Узнайте о фильтрации 🔍"
  href="/docs/tutorials/learn_filters"
/>
<LinkCard
  title="Узнайте о шаблонизации 📝"
  href="/docs/tutorials/learn_templates"
/>
<LinkCard title="Видение 🔮" href="/docs/vision" />

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

Он упрощает процесс объединения и форматирования кода, делая его легко анализируемым, документируемым или рефакторируемым с помощью LLM.

Вы можете использовать `code2prompt` следующими способами:

<CardGrid>
  <Card title="Ядро" icon="seti:rust">
    Ядро библиотеки для быстрого анализа кода
  </Card>
  <Card title="CLI" icon="seti:powershell">
    Интерфейс командной строки, специально разработанный для людей
  </Card>
  <Card title="SDK" icon="seti:python">
    Программный инструментарий для агентов ИИ и скриптов автоматизации
  </Card>
  <Card title="MCP" icon="seti:folder">
    Сервер протокола контекста модели для LLM на стероидах
  </Card>
</CardGrid>
---

## Ключевые особенности

- **Генерация подсказок LLM**: Быстро преобразуйте целые базы кода в структурированные подсказки LLM.
- **Фильтрация по шаблону Glob**: Включайте или исключайте определенные файлы и директории с помощью шаблонов glob.
- **Настройка шаблонов**: Адаптируйте генерацию подсказок с помощью шаблонов Handlebars.
- **Подсчет токенов**: Анализируйте использование токенов и оптимизируйте для LLM с разными окнами контекста.
- **Интеграция с Git**: Включайте разницы Git и сообщения о коммитах в подсказки для обзора кода.
- **Уважение к `.gitignore`**: Автоматически игнорирует файлы, перечисленные в `.gitignore`, чтобы упростить генерацию подсказок.

---

## Почему `code2prompt`?

1. **Экономьте время**:

   - Автоматизирует процесс обхода базы кода и форматирования файлов для LLM.
   - Избегает повторяющегося копирования и вставки кода.

2. **Повышайте производительность**:

   - Предоставляет структурированный и последовательный формат для анализа кода.
   - Помогает выявлять ошибки, рефакторировать код и писать документацию быстрее.

3. **Работа с большими базами кода**:

   - Разработан для работы с большими базами кода, уважая ограничения контекста LLM.

4. **Настройка рабочих процессов**:
   - Гибкие возможности для фильтрации файлов, использования шаблонов и генерации целевых подсказок.

---

## Примеры использования

- **Документация кода**:
  Автоматически генерируйте документацию для публичных функций, методов и классов.

- **Обнаружение ошибок**:
  Найдите потенциальные ошибки и уязвимости, анализируя вашу базу кода с помощью LLM.

- **Рефакторинг**:
  Упростите и оптимизируйте код, генерируя подсказки для улучшения качества кода.

- **Обучение и исследование**:
  Поймите новые базы кода, генерируя сводки и подробные разборы.

- **Описания коммитов и PR**:
  Генерируйте осмысленные сообщения о коммитах и описания pull-запросов из разниц Git.

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