fstree 0.1.0

fstree - A blazing fast File System Tree command in Rust with smart file type icons.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

<div align="center">

# 🌳 fstree

**File System Tree (fstree) - A blazing fast directory listing command in Rust**

![Crates.io](https://img.shields.io/crates/v/fstree)
![License](https://img.shields.io/crates/l/fstree)
![Rust Edition](https://img.shields.io/badge/edition-2024-blue)
![Build](https://img.shields.io/badge/build-passing-brightgreen)
![Downloads](https://img.shields.io/crates/d/fstree)

</div>

## 🚀 Features

- ⚡ **Blazing Fast:** Built with Rust for maximum performance.
- 🎨 **Smart Icons:** Automatically detects file types (Rust, Python, Images, etc.).
- 🛠️ **Zero Dependencies:** A single static binary.

## 📦 Installation

```bash
cargo install fstree
```

Or build from source:

```bash
git clone https://github.com/your-username/fstree.git
cd fstree
cargo install --path .
```

## 💻 Usage & Examples

### Example 1: Basic Directory Listing

```bash
# List current directory
$ fstree
.
├── 📂 src
│   ├── 🦀 main.rs
│   ├── 🦀 lib.rs
│   └── 📂 utils
├── 📄 Cargo.toml
├── 📝 README.md
├── 📂 tests
│   └── 🧪 test_basic.rs
└── 📦 target
```

---

### Example 2: Limit Depth

```bash
# Show only 2 levels deep
$ fstree -d 2
.
├── 📂 src
│   ├── 📂 config
│   │   └── 📋 settings.json
│   ├── 📄 main.rs
│   └── 🦀 lib.rs
├── 📄 Cargo.toml
├── 📝 README.md
└── 📦 target
```

---

### Example 3: Show Hidden Files

```bash
# Include files starting with .
$ fstree -a
.
├── 📂 .git
│   ├── 📦 HEAD
│   ├── 📦 config
│   └── 📂 hooks
├── 📂 .vscode
│   └── ⚙️ settings.json
├── 📄 .gitignore
├── 📂 src
│   └── 🦀 main.rs
└── 📝 README.md
```

---

### Example 4: Target Specific Path

```bash
# List another directory
$ fstree -p ./my-project
my-project
├── 🌐 index.html
├── 🎨 style.css
├── 📜 app.js
├── 📂 api
│   └── 🦀 main.rs
└── 📄 package.json
```

## ⚙️ Options Reference

| Option            | Description        | Example            |
| ----------------- | ------------------ | ------------------ |
| `-p, --path PATH` | Target directory   | `fstree -p ./src`  |
| `-d, --depth NUM` | Limit depth levels | `fstree -d 3`      |
| `-a, --all`       | Show hidden files  | `fstree -a`        |
| `-h, --help`      | Show help          | `fstree --help`    |
| `-V, --version`   | Show version       | `fstree --version` |

## 📄 License

MIT License

---

<div align="center">
  <b>Made with ❤️ and 🦀</b>
</div>