Skip to content

Commit b22b0d1

Browse files
Update README.md
1 parent 1a25b35 commit b22b0d1

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ You can then use it in your project: `from bytebomber import build_zip_bomb`
88

99
## Usage
1010

11+
You can use ByteBomber as a Python module or directly from your command line.
12+
13+
### As a Python Module
14+
1115
Call `build_zip_bomb()` to create a ZIP bomb. You can pass several arguments to customize the behavior:
1216

1317
```
@@ -30,6 +34,25 @@ build_zip_bomb(
3034
| `verbose` | If `True`, shows config + summary output. Default: `True`. |
3135
| `show_progress` | If `True`, shows a live progress bar. Default: `True`. |
3236

37+
### Command-Line Usage
38+
39+
When you run ByteBomber from your terminal, you can optionally use flags to customize its behavior:
40+
41+
```
42+
bytebomber --target-size "100 GB" --payload-size "500 KB" --output "my_bomb.zip"
43+
```
44+
45+
| **Flag** | **Long Flag** | Description |
46+
|----------|---------------|--------------------------------------------------------------------|
47+
| `-t` | `--target-size` | Total uncompressed size of the ZIP bomb (e.g., `"500 GB"`). Default: `"500 GB"`. |
48+
| `-p` | `--payload-size` | Size of each file inside the ZIP (e.g., `"1 MB"`). Default: `"1 MB"`. |
49+
| `-o` | `--output` | Output ZIP file name. Default: `"bomb.zip"`. |
50+
| `-f` | `--folder` | Internal folder name for the payload files. Default: `"bomb-dir"`. |
51+
| `-n` | `--no-progress` | Disable the live progress bar. |
52+
| `-q` | `--quiet` | Silence all output messages. |
53+
54+
---
55+
3356
Use the format `<number> <unit>` when entering values (e.g., `500 GB`, `1 TB`). ByteBomber supports B, KB, MB, GB, TB, PB, EB, ZB, and YB. Valuse in the GB-TB range are usually more than enough to stress a system. Values above TB are astronomical data zizes far more than most systems can handle.
3457

3558
> [!NOTE]

0 commit comments

Comments
 (0)