ai digest

ай-дайджест

Инструмент CLI для объединения вашей базы кода в один файл Markdown для использования с проектами Claude или пользовательскими ChatGPT.

Функции

• Объединяет все файлы в указанном каталоге и подкаталогах.

• Игнорирует распространенные артефакты сборки и файлы конфигурации.

• Выводит один файл Markdown, содержащий всю кодовую базу.

• Предоставляет параметры удаления пробелов и пользовательские шаблоны игнорирования.

Как использовать

Начните с запуска инструмента CLI в каталоге вашего проекта:

 npx ai-дайджест

Это создаст файл codebase.md с вашей кодовой базой.

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

С ChatGPT:

1. Создайте собственный GPT

2. Загрузите сгенерированный файл Markdown в базу знаний GPT.

С Клодом:

1. Создать новый проект

2. Добавьте файл Markdown в базу знаний проекта.

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

Параметры

• -i, --input : указать входной каталог (по умолчанию: текущий каталог)

• -o, --output : указать выходной файл (по умолчанию: codebase.md)

• --no-default-ignores : отключить шаблоны игнорирования по умолчанию.

• --whitespace-removal : включить удаление пробелов.

• --show-output-files : показать список файлов, включенных в выходные данные.

• --ignore-file : указать собственный файл игнорирования (по умолчанию: .aidigestignore).

• --help : Показать справку

Примеры

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

    npx ai-дайджест

2. Укажите ввод и вывод:

    npx ai-digest -i /путь/к/вашему/проекту -o project_summary.md

3. Включить удаление пробелов:

    npx ai-digest --удаление пробелов

4. Показать список включенных файлов:

    npx ai-digest --show-output-files

5. Объедините несколько вариантов:

    npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files

Пользовательские шаблоны игнорирования

ai-digest поддерживает пользовательские шаблоны игнорирования, используя файл .aidigestignore в корневом каталоге вашего проекта. Этот файл работает аналогично .gitignore , позволяя указать файлы и каталоги, которые следует исключить из агрегации.

Используйте флаг --show-output-files , чтобы увидеть, какие файлы включаются, что упрощает идентификацию кандидатов на исключение.

Удаление пробелов

При использовании флага --whitespace-removal ai-digest удаляет лишние пробелы из файлов, чтобы уменьшить количество токенов при использовании с моделями AI. Эта функция отключена для языков, зависящих от пробелов, таких как Python и YAML.

Обработка двоичных файлов и файлов SVG

Двоичные файлы и SVG включаются в выходные данные с примечанием об их типе файла. Это позволяет моделям ИИ знать об этих файлах, не включая их полное содержимое.

Местное развитие

Запустите npm run start , чтобы запустить инструмент CLI в локальном проекте. (Очень мета!)

Запустите npm test чтобы запустить тесты.

Чтобы передать флаги в CLI, используйте флаг -- , например: npm run start -- --whitespace-removal .

Развернуть новую версию

npm publish

Содействие

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

Лицензия

Этот проект распространяется по лицензии MIT.