Flatty

Flatty-CodeBase-To-Text для LLMS

Преобразовать любые репо или папку GitHub на вашем Mac в простой текстовый файл, чтобы вы могли загрузить его в LLM (Claude, CHATGPT и т. Д.), Чтобы рассуждать все это в окне контекста.

Кодовая база → текстовый файл (ы)

LLM, такие как Chatgpt и Claude, позволили вам загружать файлы, но они ограничивают, сколько вы можете загрузить одновременно. Когда вы имеете дело с большими кодовыми базами, которые имеют тонны файлов, вы не можете просто загрузить их непосредственно в LLM. В конечном итоге вам необходимо использовать методы тряпичной (поисковой добытой генерации), которые, по моему опыту, не так эффективны, как загружать все в полное окно контекста, особенно если вам нужно рассуждать об архитектуре или понимать всю систему. Смотрите пример.

Помощники кодирования, такие как курсор, являются Amazeballs, но они работают лучше для повседневного завершения кода и встроенных изменений, чем для понимания системы более высокого уровня.

Функции

• Комплексное сглаживание файлов: преобразует целые кодовые базы в структурированные текстовые файлы, подходящие для LLMS.
• Управление интеллектуальными файлами: интеллектуально пропускает двоичные файлы, изображения, создание артефактов, каталоги пакетов, скрытые файлы и системные файлы.
• ****? Фильтрация на основе шаблонов: улучшить процесс выравнивания путем выборочно, включив файлы на основе конкретных шаблонов кода или ключевых слов как в содержимого файла, так и в имени файлов. Настройте критерии включения, используя AND / OR условия, чтобы точно ориентироваться на то, что вам нужно для целенаправленного анализа.

Установка

Выберите свое приключение:

? ‍♂️ Quick Install (Easy Mode)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash -s -- --quick

Paranoid Install (дополнительная проверка безопасности)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash

Параноидальная установка (по умолчанию) включает проверку контрольной суммы и полную проверку безопасности. Быстрая установка пропускает эти чеки для толпы «Я люблю жить опасно».

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

Основное использование глупо простое:

 cd your-project-directory
flatty

Это создает красиво отформатированный текстовый файл в ~/Documents/flatty/ содержит все текстовые файлы вашего проекта, готовые к потреблению LLM.

Фильтрация на основе шаблонов

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

Аргументы командной строки:

• --pattern "pattern1" : укажите шаблон или ключевое слово для фильтрации файлов. Вы можете использовать несколько --pattern для нескольких шаблонов.
• --condition AND|OR : Определите, как следует сопоставить несколько шаблонов.
  • AND : все указанные шаблоны должны присутствовать в файле (либо в имени файла, либо в контенте).
  • OR : любой из указанных шаблонов должен присутствовать.

Примеры:

1. Включите файлы, содержащие либо useEffect , или async function :

   flatty --pattern " useEffect " --pattern " async function " --condition OR

2. Включите файлы, содержащие как useEffect , так и async function :

   flatty --pattern " useEffect " --pattern " async function " --condition AND

3. Включите файлы с README в имя файла:

   flatty --pattern " README " --condition OR

4. Поведение по умолчанию без шаблонов (включает в себя все подходящие текстовые файлы):

   flatty

Поведение:

• Или условие: файлы включены, если какой -либо из указанных шаблонов находится в имени файла или содержимого файла.
• И условие: файлы включены только в том случае, если все указанные шаблоны находятся в имени файла или содержимого файла.
• Никаких шаблонов не указано: по умолчанию включать все подходящие текстовые файлы, поддержание исходного поведения.

Умная обработка файлов

Пласти разумно пропускает:

• Двоичные файлы и изображения
• Строить артефакты
• Каталоги пакетов ( node_modules , vendor )
• Скрытые файлы и .git
• Системные файлы ( .DS_Store )

Выход

Сплющенные текстовые файлы сохраняются в каталоге ~/flattened/ именами файлов, отформатированных как:

 <project-name>-v<version>-<timestamp>.txt

Каждый выходной файл включает в себя:

• Информация о проекте и метаданные
• Полная структура хранилища с каталогами и подсчетом токенов файлов
• Содержание каждого включенного текстового файла, разделенного определенными разделителями

Разработка

Разработан с помощью ❤ Talktastic

Внося

Взносы приветствуются! Пожалуйста, откройте проблему или отправьте запрос на привлечение для любых улучшений или исправлений ошибок.

Git Hooks

Чтобы поддерживать целостность сценария flatty.sh и убедиться, что файл контрольной суммы ( flatty.sh.sha256 ) всегда актуально, участники должны настроить предварительный крючок GIT. Этот крюк автоматически генерирует и обновляет контрольную сумму перед каждым коммит.

Шаги, чтобы настроить крюк перед набор:

1. Перейдите к каталогу Git Hooks:

    cd .git/hooks

2. Создайте или отредактируйте крюк pre-commit :

   cursor pre-commit

3. Добавьте следующий скрипт в pre-commit файл:

    #! /bin/bash
   
   # Generate SHA256 checksum for flatty.sh
   sha256sum flatty.sh > flatty.sh.sha256
   
   # Add the checksum file to the commit
   git add flatty.sh.sha256

4. Сделайте исполняемый файл крюка:

   chmod +x pre-commit

Объяснение: Этот крючок гарантирует, что каждый раз, когда модифицируется flatty.sh , и производится коммит, соответствующий файл контрольной суммы flatty.sh.sha256 автоматически обновляется и включен в коммит. Это поддерживает процесс проверки целостности для сценария установки.

Лицензия

Грань