https://github.com/blwarren/ftrek
A lightweight command-line utility written in Rust that generates a visual representation of a directory's structure.
https://github.com/blwarren/ftrek
cli cross-platform directory-tree rust utility
Last synced: 3 months ago
JSON representation
A lightweight command-line utility written in Rust that generates a visual representation of a directory's structure.
- Host: GitHub
- URL: https://github.com/blwarren/ftrek
- Owner: blwarren
- License: mit
- Created: 2025-04-13T14:38:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-12T20:19:38.000Z (4 months ago)
- Last Synced: 2026-02-13T03:26:58.719Z (4 months ago)
- Topics: cli, cross-platform, directory-tree, rust, utility
- Language: Rust
- Homepage: https://github.com/blwarren/ftrek
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📂 ftrek
A fast Rust utility that visually displays the directory structure of a path.
## 🚀 Features
- Clean, Unicode-based structure output
- Optional support for `.gitignore` rules with `--gitignore`
- Recursive traversal of directories
- Simple and extensible design in pure Rust
## 📦 Installation
```bash
git clone https://github.com/blwarren/ftrek.git
cd ftrek
cargo build --release
```
The executable will be located at `target/release/ftrek`.
## 🔧 Usage
```bash
ftrek [OPTIONS] [DIRECTORY]
```
### Options
- `--gitignore` — Apply `.gitignore` filtering when walking the directory structure.
If no directory is provided, it defaults to the current working directory.
### Example
```bash
ftrek --gitignore src
```
## 📄 License
This project is licensed under the MIT License.