Repomix: упаковка кодовой базы в текстовый файл для поиска больших моделей

Общее введение

Repomix (ранее известный как Repopack) - это инструмент с открытым исходным кодом, предназначенный для упаковки всей кодовой базы в один файл, удобный для искусственного интеллекта. Этот инструмент позволяет разработчикам легко сделать свою кодовую базу доступной для анализа и обработки большими языковыми моделями, такими как Claude, ChatGPT и Gemini. Изначально он был разработан, чтобы упростить задачу ИИ по пониманию и генерации кода для сценариев, требующих быстрого обзора или рефакторинга кодовой базы. Repomix поддерживает различные форматы вывода, включая XML, Markdown и обычный текст, и предоставляет профили для удовлетворения потребностей различных проектов.

Список функций

• Упаковка кодовой базы: Упакуйте весь проект в один файл для удобства анализа AI.
• Поддержка вывода в нескольких форматах: Предоставляет различные форматы вывода, такие как XML, Markdown и обычный текст, которые могут быть выбраны пользователем по желанию.
• Гибкость конфигурации: С помощью файла конфигурации вы можете настроить такие параметры, как игнорирование файлов, удаление комментариев и т. д.
• Удаленная поддержка склада: Вы можете получать и упаковывать код непосредственно из удаленного репозитория GitHub.
• Поддержка DockerДля запуска Repomix в контейнерной среде предусмотрены образы Docker.
• проверка безопасности: Проверки безопасности включены по умолчанию, чтобы избежать утечки конфиденциальной информации.

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

Установка Repomix

Repomix - это инструмент на базе Node.js, поэтому вам необходимо убедиться, что в вашей системе установлен Node.js.

1.Установка Node.js::

• Посетите официальный сайт Node.js, чтобы загрузить и установить подходящую версию для вашей системы.

2.Установка Repomix::

• Установите Repomix глобально с помощью npm:

  npm install -g repomix
  

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

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

• Упаковка местных проектов::
  Перейдите в каталог вашего проекта и запустите его:

repomix

В результате в текущем каталоге будет создан файл под названиемrepomix-output.xmlфайла. Если вам нужно указать формат вывода, вы можете использовать ** --styleПараметры:

repomix --style markdown

• Упаковка Удаленный склад::
  Если вы хотите упаковать удаленный репозиторий GitHub напрямую, выполните команду:

  repomix --remote https://github.com/yamadashy/repomix
  

  Вы также можете указать ветви или конкретные коммиты:

  repomix --remote yamadashy/repomix --remote-branch main
  

файл конфигурации

• Repomix поддерживает пользовательские конфигурации, которые можно настроить черезrepomix --initСоздатьrepomix.config.jsonДокумент. В нем вы можете определить:
  • Игнорировать файлы: использовать **.repomixignoreфайл или файл конфигурации вигнорироватьопция, аналогичная опции.gitignore**.
  • формат вывода: Выберите формат выходного файла (например, XML, Markdown).
  • Текст заголовка: Добавьте пояснительный текст в начало выходного файла.
  • проверка безопасности: Включать ли проверку безопасности, чтобы избежать раскрытия конфиденциальной информации.

  Пример файла конфигурации:

  {
  "output": {
  "filePath": "repomix-output.xml",
  "style": "xml",
  "fileSummary": true
  },
  "ignore": {
  "useGitignore": true
  }
  }
  

Запуск Repomix

• Запуск в Docker::
  Если вы предпочитаете использовать Docker для управления средой, вы можете сделать это:

  docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix
  

Repomix для использования с другими инструментами искусственного интеллекта

• Созданный единый файл можно напрямую загрузить для анализа в такие инструменты искусственного интеллекта, как Claude, ChatGPT или Gemini:
  • Обзор кода: Предоставьте документацию AI, запрашивающему обзор кода или предлагающему рефакторинг.
  • Генерация документов: Создание документации или файлов README на основе кодовой базы.
  • Решение проблем: Выявление проблем в коде и их решение с помощью инструментов искусственного интеллекта.