aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 8fb62772fc08873a8553b1f496bca91ce706359b (plain)
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
# ๐Ÿ“ฆ Rust folder size cli tool

A fast and lightweight folder analyzer written in Rust.  
Recursively calculates the size of directories and files, with support for:

- ๐Ÿ”— Symlink resolution
- ๐Ÿ—‚๏ธ Per-directory size breakdown
- ๐Ÿ” Configurable depth limit


## ๐Ÿ› ๏ธ Features

- ๐Ÿ“‚ Recursively sums up file sizes in a given directory
- ๐Ÿ“ Outputs total size in bytes, KB, MB, and GB
- ๐Ÿ”— Optional symlink following (`--symlink`)
- ๐Ÿงฑ Shows size of each file or folder (`--directory-b`)
- โฌ‡๏ธ Limit recursion depth (`--depth-limit <n>`)


## ๐Ÿš€ Usage

```bash
cargo run -- [OPTIONS]
```
๐Ÿ”ง Options

 Flag	    Description

--symlink:	Follow and resolve symlinks

--directory-b:	Print size breakdown for each directory/file

--depth-limit n:	Limit recursion depth (default: 10)

๐Ÿ” Example
```
cargo run -- --symlink --directory-b --depth-limit 5
```
๐Ÿงช Sample Output

symlink: true

directory_breakdown: true

depth_limit: 5

../../folder_size

โ”œโ”€โ”€ bin/         (2.1 MB)

โ”œโ”€โ”€ lib/         (490.6 MB)

โ”œโ”€โ”€ LICENSE.txt  (11 KB)

โ”œโ”€โ”€ README.md    (5 KB)

Total size: 492.3MB

๐Ÿ“ฆ Dependencies

    clap โ€” command-line argument parser

Install them automatically with:
```
cargo build
```
๐Ÿ“„ License

MIT License

Made by ven โ€” Rust beginner