diskhound 0.2.0

A simple CLI tool to find the largest subdirectories
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

# diskhound

A fast CLI tool to find the largest subdirectories in a given path.

## Installation

```bash
cargo install diskhound
```

## Usage

```bash
# Scan current directory, show top 10 largest subdirectories
diskhound

# Scan a specific path
diskhound ~/Downloads

# Show only top 5
diskhound --top 5

# Two-level depth grouping
diskhound --depth 2

# Exclude directories by name (repeatable)
diskhound --exclude node_modules --exclude .git

# Only show directories above a size threshold
diskhound --min-size 100MB

# Machine-readable JSON output
diskhound --json .

# Combine options
diskhound ~/Library --top 20 --exclude .cache --min-size 1MB --depth 2
```

## Example output

```
  node_modules          ████████████████████  1.24 GiB   48.2%  (12847 files)
  target                ██████████████░░░░░░  847.32 MiB 32.9%  (3241 files)
  src                   ░░░░░░░░░░░░░░░░░░░░   12.30 MiB  0.5%  (87 files)

Total: 2.57 GiB in 14312 files across 1203 directories (showing top 3)
```

## Features

- Scans subdirectories and reports total size with file counts
- Visual size bars proportional to the largest entry
- Percentage of total scanned size per directory
- Depth-aware grouping (`--depth N` for multi-level views)
- Exclude directories by name with real I/O savings (skips entire subtrees)
- Minimum size filter (`--min-size`) with human-readable input (e.g. `100MB`, `1.5GB`)
- Machine-readable JSON output (`--json`)
- Human-readable size formatting (GiB, MiB, KiB)
- Does not follow symlinks
- Silently ignores permission errors
- Fast parallel traversal using jwalk

## Development

CI runs on every pull request to `dev` and `master` — formatting, clippy, build, and tests must all pass. A separate health-check workflow runs on push to `dev` and weekly on Monday.

To enable the local pre-commit hook (runs `cargo fmt --check` and `cargo clippy`):

```bash
git config core.hooksPath .githooks
```

### Publishing a release

Pushing a version tag automatically publishes to crates.io:

```bash
# 1. Bump version in Cargo.toml
# 2. Commit and merge to master
# 3. Tag and push
git tag v0.2.0
git push origin v0.2.0
```

Requires a `CARGO_REGISTRY_TOKEN` secret in the repository settings.

## License

MIT