projecttree-by-almira 0.1.1

A beautiful CLI tool to generate project tree structures.

projecttree-by-almira

Красивая и гибкая CLI-утилита на Python для визуализации структуры папок и файлов вашего проекта прямо в терминале с возможностью экспорта.

---

Особенности

• Красивый вывод: Генерирует аккуратное дерево папок с использованием символов разветвления.
• Ограничение глубины: Опция --depth позволяет не тонуть в глубоких вложенных папках.
• Умное игнорирование: По умолчанию скрывает системный мусор (.git, __pycache__, venv), а также поддерживает кастомные фильтры через --ignore.
• Фильтрация: Возможность отображать только директории с помощью флага --dirs-only.
• Markdown-формат: Генерация структуры в виде готового списка для ваших GitHub репозиториев.
• Экспорт: Быстрое сохранение в файл (--output) или копирование прямо в буфер обмена (--copy).

---

Установка

Установите утилиту напрямую из PyPI:

pip install projecttree-almira

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

После установки утилита доступна в любой папке по ключевому слову projecttree:

projecttree [ПУТЬ] [ОПЦИИ]

Доступные флаги и опции

Флаг	Полное имя	Описание	Пример
-d	--depth	Ограничение глубины сканирования	projecttree --depth 2
-i	--ignore	Игнорировать указанные файлы/папки	projecttree --ignore tests LICENSE
	--dirs-only	Отображает только директории	projecttree --dirs-only
-o	--output	Сохранить дерево в текстовый файл	projecttree --output tree.txt
-m	--markdown	Сгенерировать дерево в формате Markdown	projecttree --markdown
-c	--copy	Скопировать результат в буфер обмена	projecttree --copy

Примеры использования

Обычный просмотр текущей папки:

projecttree

Показать только папки не глубже 2-го уровня:

projecttree --depth 2 --dirs-only

Сгенерировать структуру в Markdown, скопировать её в буфер обмена и настроить исключения:

projecttree --ignore tests LICENSE --markdown --copy

Лицензия

Этот проект распространяется под лицензией MIT. См. файл LICENSE для подробностей.

Автор: Almira