aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 00a1378537484b65a4fabb16f875bc4e617058b7 (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
74
# langbreak

![Example file](/example.png)

A lightweight bash script that displays a coloured language breakdown bar for your codebase, similar to GitHub's linguist feature.

# Installation

```bash
# download the script
chmod +x langbreak
```

# Usage

## Basic Usage
Display a visual breakdown of the current directory:
```bash
./langbreak
```

## Help
```bash
./langbreak --help
```

## Options
Export language data to JSON or YAML:
```bash
./langbreak --json
./langbreak --yaml
```

Limit directory depth:
```bash
./langbreak --max-depth 2
```

Redirect to a file:
```bash
./langbreak --json > stats.json
./langbreak --yaml > stats.yaml
```

### JSON Export
```json
{
  "timestamp": "2026-01-08T18:34:27+00:00",
  "total_bytes": 15234,
  "languages": [
    {
      "name": "Python",
      "bytes": 8500,
      "files": 12,
      "percentage": 55.8
    }
  ]
}
```

### YAML Export
```yaml
timestamp: "2026-01-08T18:34:27+00:00"
total_bytes: 15234
languages:
  - name: "Python"
    bytes: 8500
    files: 12
    percentage: 55.8
```

# License

GPLv3