Пользовательские инструкции

Repomix позволяет предоставлять пользовательские инструкции, которые будут включены в выходной файл. Это может быть полезно для добавления контекста или конкретных рекомендаций для ИИ-систем, обрабатывающих репозиторий.

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

Чтобы включить пользовательскую инструкцию, создайте markdown-файл (например, repomix-instruction.md) в корне вашего репозитория. Затем укажите путь к этому файлу в вашем repomix.config.json:

{
  "output": {
    "instructionFilePath": "repomix-instruction.md"
  }
}

Содержимое этого файла будет включено в вывод в разделе «Instruction».

Пример

# Инструкции для репозитория

Этот репозиторий содержит исходный код инструмента Repomix. Пожалуйста, следуйте этим рекомендациям при анализе кода:

1. Сосредоточьтесь на основной функциональности в директории `src/core`.
2. Обратите особое внимание на проверки безопасности в `src/core/security`.
3. Игнорируйте все файлы в директории `tests`.

Это приведёт к следующему разделу в выводе:

<instruction>
# Инструкции для репозитория

Этот репозиторий содержит исходный код инструмента Repomix. Пожалуйста, следуйте этим рекомендациям при анализе кода:

1. Сосредоточьтесь на основной функциональности в директории `src/core`.
2. Обратите особое внимание на проверки безопасности в `src/core/security`.
3. Игнорируйте все файлы в директории `tests`.
</instruction>

Связанные ресурсы

• Конфигурация - Настройка output.instructionFilePath в файле конфигурации
• Форматы вывода - Узнать о различных форматах вывода
• Примеры промптов - Примеры промптов для анализа с ИИ
• Сценарии использования - Реальные примеры использования Repomix с ИИ