kaban

CLI-утилита: собирает структуру каталога и содержимое файлов в один .md-файл для любых нужд.

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

Установка

Нужен Node.js 18+.

npm install -g @kabanooovd/kaban

После этого команда kaban доступна из любого каталога.

Обновление

npm install -g @kabanooovd/kaban@latest

Удаление

npm uninstall -g @kabanooovd/kaban

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

# Сканирует текущий каталог → kaban.md
kaban

# Сканирует ./src → kaban.md
kaban ./src

# Сканирует ./src → отчёт в DOC.md
kaban ./src -o DOC.md

# Игнорирует папки tmp и logs
kaban -i "tmp,logs"

# Только .js и .ts файлы
kaban -e js,ts

# Только структура, без содержимого файлов
kaban --no-content

# Справка
kaban -h

По умолчанию

• Игнорируются: .git, node_modules, dist, __pycache__, .venv, lock-файлы и другие типовые артефакты.
• Файлы больше 512 КБ не включаются в отчёт.
• Бинарные файлы пропускаются.
• Выходной файл: kaban.md.

Разработка

git clone https://gitverse.ru/kabanooovd/kaban.git
cd kaban
npm install
npm link

После npm link команда kaban будет указывать на локальный код. Изменения в src/ вступают в силу после npm run build.

Лицензия

MIT