retree 0.6.0

# retree 🌲


[![Rust](https://img.shields.io/badge/rust-1.80%2B-orange.svg)](https://www.rust-lang.org)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)](https://github.com/M4dPac/retree)
[![GitHub](https://img.shields.io/github/v/release/M4dPac/retree?label=latest)](https://github.com/M4dPac/retree/releases)
[![Build](https://img.shields.io/badge/status-pre--release-yellow.svg)](https://github.com/M4dPac/retree)

**retree** — современная GNU `tree`-совместимая утилита для отображения структуры каталогов.  
Написана на Rust. Оптимизирована для Windows. Работает на Windows, Linux и macOS.

[🇬🇧 English version](https://github.com/M4dPac/retree/blob/main/README.md)

---

## 🎯 Почему retree?


- ✅ Совместимость с GNU `tree`
- ⚡ Параллельный обход (до 6× быстрее на больших деревьях)
- 🎨 Поддержка `LS_COLORS` и `TREE_COLORS`
- 🔤 Иконки (Nerd Font / Unicode / ASCII)
- 📦 Экспорт в JSON / XML / HTML
- 🪟 Полная поддержка NTFS (ADS, junctions, длинные пути)
- 🌍 Русский и английский интерфейс

---

## 📦 Установка


### Бинарные релизы


Скачайте готовый бинарник с [GitHub Releases](https://github.com/M4dPac/retree/releases), распакуйте и добавьте в `PATH`.

### Cargo


```bash
cargo install retree
```

### Сборка из исходников


```bash
git clone https://github.com/M4dPac/retree.git
cd retree
cargo build --release
```

Бинарный файл будет в `target/release/rt`.

### 🔐 Верификация релизов


Каждый релиз включает `SHA256SUMS.txt` с контрольными суммами, подписанный через [Sigstore cosign](https://docs.sigstore.dev/cosign/overview/).

**Linux / macOS:**

```bash
# Скачайте бинарник, SHA256SUMS.txt и SHA256SUMS.txt.bundle из Releases


# Проверьте контрольную сумму

sha256sum -c SHA256SUMS.txt

# Проверьте подпись (требуется cosign)

cosign verify-blob SHA256SUMS.txt --bundle SHA256SUMS.txt.bundle \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  --certificate-identity-regexp "github\.com/M4dPac/retree"
```

**Windows PowerShell:**

```bash
# Проверьте контрольную сумму

(Get-Content SHA256SUMS.txt) | ForEach-Object {
    $hash, $file = $_ -split '\s+', 2
    $actual = (Get-FileHash $file -Algorithm SHA256).Hash.ToLower()
    if ($actual -eq $hash) { "OK: $file" } else { "FAIL: $file" }
}
```

> **Примечание:** ⚠️ Windows .exe пока не подписан Authenticode. Используйте проверку SHA256 + cosign для подтверждения целостности.

---

## 🚀 Быстрый старт


> 💡 **На заметку:** Для максимальной скорости набора в терминале утилита использует короткую команду `rt` (буквы находятся рядом на клавиатуре).

```bash
# Показать текущий каталог

rt

# Показать скрытые файлы

rt -a

# Ограничить глубину

rt -L 2

# Только каталоги

rt -d

# Цвета и иконки

rt -C --icons always

# JSON-вывод

rt -J > tree.json

# Форматированный JSON

rt --json-pretty > tree.json

# Параллельный режим (авто-определение потоков)

rt --parallel

# Параллельный режим с явным числом потоков

rt --parallel --threads 4
```

---

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


```
rt [OPTIONS] [PATH...]
```

### Часто используемые опции


| Флаг             | Описание                   |
| ---------------- | -------------------------- |
| `-a`             | Показать скрытые файлы     |
| `-d`             | Только каталоги            |
| `-L N`           | Ограничить глубину         |
| `-P PATTERN`     | Фильтр по glob             |
| `-I PATTERN`     | Исключить по glob          |
| `-h`             | Человекочитаемые размеры   |
| `-D`             | Дата модификации           |
| `-J`             | JSON-вывод                 |
| `--json-pretty`  | Форматированный JSON-вывод |
| `-C`             | Цвет всегда                |
| `--icons always` | Включить иконки            |
| `--parallel`     | Параллельный обход         |
| `--threads N`    | Число рабочих потоков      |

### 📖 Полная документация


- 👉 [CLI Reference](https://github.com/M4dPac/retree/blob/main/docs/cli-reference.md)
- 🎨 [Настройка цветов](https://github.com/M4dPac/retree/blob/main/docs/colors.md)
- 🔤 [Иконки](https://github.com/M4dPac/retree/blob/main/docs/icons.md)
- ⚡ [Производительность](https://github.com/M4dPac/retree/blob/main/docs/performance.md)
- ⚙️ [Конфигурация](https://github.com/M4dPac/retree/blob/main/docs/configuration.md)
- 🪟 [Windows-специфика](https://github.com/M4dPac/retree/blob/main/docs/windows.md)
- 🛠️ [Troubleshooting](https://github.com/M4dPac/retree/blob/main/docs/troubleshooting.md)

---

## ⚡ Производительность


retree использует Rayon (work-stealing), ленивую загрузку метаданных, оптимизированную сортировку и потоковый вывод.

Результаты реальных бенчмарков (median time, Criterion, режим `release`, Windows/NTFS, end-to-end):

| Файлов    | Обычный режим | Параллельный (авто) | Streaming |
| --------- | ------------- | ------------------- | --------- |
| 100       | ~54 мс        | ~14 мс              | ~54 мс    |
| 10 000    | ~5.3 с        | ~861 мс             | ~5.7 с    |
| 100 000   | ~51.5 с       | ~9.4 с              | ~53.5 с   |
| 1 000 000 | ~576 с        | ~102 с              | ~622 с    |

💾 **Потребление памяти** (PeakWorkingSet64):

| Файлов    | Sequential | Streaming | Экономия |
| --------- | ---------- | --------- | -------- |
| 10 000    | 15.6 МБ    | 6.6 МБ    | **58%**  |
| 100 000   | 100.2 МБ   | 10.4 МБ   | **90%**  |
| 1 000 000 | 938.9 МБ   | 59.0 МБ   | **94%**  |

> Параллельный режим эффективен начиная с ~1 000 файлов (ускорение до 6×).
> Streaming-режим не строит дерево в памяти — экономия 90%+ на больших деревьях.

> 💡 **Совет:** для быстрого просмотра первых N записей большого дерева используйте `--streaming --max-entries N` — обход остановится сразу после вывода N записей. В стандартном режиме дерево строится целиком, затем обрезается.

Подробнее: 👉 [Бенчмарки](https://github.com/M4dPac/retree/blob/main/docs/performance.md)

---

## 📊 Сравнение с GNU tree


| Возможность        | GNU tree | retree |
| ------------------ | :------: | :----: |
| Цвета              |    ✅    |   ✅   |
| JSON               |    ✅    |   ✅   |
| XML                |    ✅    |   ✅   |
| HTML               |    ✅    |   ✅   |
| Параллельный обход |    ❌    |   ✅   |
| Иконки             |    ❌    |   ✅   |
| NTFS ADS           |    ❌    |   ✅   |
| Junction points    |    ❌    |   ✅   |
| Длинные пути       |    ❌    |   ✅   |
| Потоковый вывод    |    ❌    |   ✅   |
| Многоязычность     |    ❌    |   ✅   |

---

## 🗺️ Roadmap


- [ ] Стабильный релиз на crates.io
- [ ] Конфигурационный файл (`~/.retree.toml`)
- [ ] Поддержка `.gitignore` / `.treeignore`
- [ ] Суммарный размер каталогов (`--du`)
- [ ] Интерактивный режим
- [ ] Пакеты для Homebrew / Scoop / Winget

---

## 🤝 Вклад в проект


PR и issues приветствуются.

```bash
cargo test
cargo fmt
cargo clippy
```

Подробности: 👉 [Development Guide](https://github.com/M4dPac/retree/blob/main/docs/development.md)

---

## 📄 Лицензия


[MIT License](LICENSE)

---

Сделано с ❤️ и 🦀 Rust