bloaty 0.0.2

Bloaty package
Documentation 
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

# Bloaty

A tool for analyzing binary size and feature impact across Rust workspace members. Bloaty helps you understand how different features affect your binary sizes and identify potential optimization opportunities.

## Features

- Analyze binary sizes across workspace members
- Compare feature impact on binary sizes
- Support for multiple output formats (text, JSON, JSONL)
- Integration with cargo-bloat, cargo-llvm-lines, and cargo-size
- Detailed reporting of size differences between features

## Installation

```bash
cargo install --path packages/bloaty
```

## Usage

Basic usage:
```bash
cargo run --bin bloaty
```

This will analyze all workspace members and generate reports in all supported formats.

### Command Line Options

All list arguments (packages, skip-packages, skip-features, tool, output-format) support both comma-separated lists and multiple arguments.

- `-p, --package <PACKAGE>`: Specify packages to analyze
  ```bash
  # Using comma-separated list
  --package pkg1,pkg2,pkg3
  # Using multiple arguments
  --package pkg1 --package pkg2 --package pkg3
  ```

- `--skip-packages <SKIP_PACKAGES>`: Packages to skip
  ```bash
  # Using comma-separated list
  --skip-packages pkg1,pkg2
  # Using multiple arguments
  --skip-packages pkg1 --skip-packages pkg2
  ```

- `--skip-features <SKIP_FEATURES>`: Features to skip
  ```bash
  # Using comma-separated list
  --skip-features test,bench,dev
  # Using multiple arguments
  --skip-features test --skip-features bench
  ```

- `-t, --tool <TOOL>`: Tools to use (options: bloat, llvm-lines, size)
  ```bash
  # Using comma-separated list
  --tool bloat,size
  # Using multiple arguments
  --tool bloat --tool size
  ```

- `--report-file <REPORT_FILE>`: Custom report file name (without extension)

- `--output-format <FORMAT>`: Output format (text, json, jsonl, all)
  ```bash
  # Using comma-separated list
  --output-format text,json
  # Using multiple arguments
  --output-format text --output-format json
  # Using 'all' for all formats
  --output-format all
  ```

### Examples

Analyze specific packages:
```bash
# Using comma-separated list
cargo run --bin bloaty -- -p package1,package2

# Using multiple arguments
cargo run --bin bloaty -- -p package1 -p package2
```

Skip certain features:
```bash
# Using comma-separated list
cargo run --bin bloaty -- --skip-features test,bench,dev

# Using multiple arguments
cargo run --bin bloaty -- --skip-features test --skip-features bench
```

Use specific tools:
```bash
# Using comma-separated list
cargo run --bin bloaty -- -t bloat,size

# Using multiple arguments
cargo run --bin bloaty -- -t bloat -t size
```

Generate specific output formats:
```bash
# Using comma-separated list
cargo run --bin bloaty -- --output-format text,json

# Using multiple arguments
cargo run --bin bloaty -- --output-format text --output-format json

# Generate all formats
cargo run --bin bloaty -- --output-format all
```

Custom report file:
```bash
cargo run --bin bloaty -- --report-file analysis
```

## Output Formats

### Text Format
Human-readable format showing package, target, and feature sizes with differences.

Example:
```
Package: my_crate
===================

Target: my_target
-------------------
Base size: 1.2 MB
Feature: default        | Size: 1.2 MB | Diff: +0 B
Feature: extra          | Size: 1.5 MB | Diff: +300 KB
Feature: minimal        | Size: 900 KB | Diff: -300 KB
```

### JSON Format
Complete analysis in a single JSON object, useful for programmatic processing.

### JSONL Format
Line-delimited JSON format, with each line representing a single event in the analysis process. Useful for streaming and real-time processing.

Example:
```jsonl
{"type":"package_start","name":"my_crate","timestamp":1234567890}
{"type":"target_start","package":"my_crate","target":"my_target","timestamp":1234567890}
{"type":"base_size","package":"my_crate","target":"my_target","size":1258291,"size_formatted":"1.2 MB","timestamp":1234567890}
{"type":"feature","package":"my_crate","target":"my_target","feature":"default","size":1258291,"diff":0,"diff_formatted":"+0 B","size_formatted":"1.2 MB","timestamp":1234567890}
```

## Dependencies

- cargo-bloat
- cargo-llvm-lines
- cargo-size

Make sure these tools are installed before running bloaty:
```bash
cargo install cargo-bloat cargo-llvm-lines cargo-size
```