cachekaro 2.0.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. cachekaro-2.0.5/LICENSE +21 -0
  2. cachekaro-2.0.5/PKG-INFO +360 -0
  3. cachekaro-2.0.5/README.md +316 -0
  4. cachekaro-2.0.5/cachekaro/__init__.py +20 -0
  5. cachekaro-2.0.5/cachekaro/__main__.py +11 -0
  6. cachekaro-2.0.5/cachekaro/cli.py +612 -0
  7. cachekaro-2.0.5/cachekaro/config/__init__.py +12 -0
  8. cachekaro-2.0.5/cachekaro/config/default.py +214 -0
  9. cachekaro-2.0.5/cachekaro/config/paths/__init__.py +3 -0
  10. cachekaro-2.0.5/cachekaro/core/__init__.py +15 -0
  11. cachekaro-2.0.5/cachekaro/core/analyzer.py +333 -0
  12. cachekaro-2.0.5/cachekaro/core/cleaner.py +418 -0
  13. cachekaro-2.0.5/cachekaro/core/scanner.py +317 -0
  14. cachekaro-2.0.5/cachekaro/exporters/__init__.py +53 -0
  15. cachekaro-2.0.5/cachekaro/exporters/base.py +105 -0
  16. cachekaro-2.0.5/cachekaro/exporters/csv_export.py +137 -0
  17. cachekaro-2.0.5/cachekaro/exporters/html_export.py +680 -0
  18. cachekaro-2.0.5/cachekaro/exporters/json_export.py +84 -0
  19. cachekaro-2.0.5/cachekaro/exporters/text.py +178 -0
  20. cachekaro-2.0.5/cachekaro/models/__init__.py +17 -0
  21. cachekaro-2.0.5/cachekaro/models/cache_item.py +225 -0
  22. cachekaro-2.0.5/cachekaro/models/scan_result.py +274 -0
  23. cachekaro-2.0.5/cachekaro/platforms/__init__.py +16 -0
  24. cachekaro-2.0.5/cachekaro/platforms/base.py +591 -0
  25. cachekaro-2.0.5/cachekaro/platforms/detector.py +119 -0
  26. cachekaro-2.0.5/cachekaro/platforms/linux.py +474 -0
  27. cachekaro-2.0.5/cachekaro/platforms/macos.py +391 -0
  28. cachekaro-2.0.5/cachekaro/platforms/windows.py +617 -0
  29. cachekaro-2.0.5/cachekaro/utils/__init__.py +15 -0
  30. cachekaro-2.0.5/cachekaro/utils/colors.py +174 -0
  31. cachekaro-2.0.5/cachekaro/utils/formatting.py +190 -0
  32. cachekaro-2.0.5/cachekaro.egg-info/PKG-INFO +360 -0
  33. cachekaro-2.0.5/cachekaro.egg-info/SOURCES.txt +41 -0
  34. cachekaro-2.0.5/cachekaro.egg-info/dependency_links.txt +1 -0
  35. cachekaro-2.0.5/cachekaro.egg-info/entry_points.txt +2 -0
  36. cachekaro-2.0.5/cachekaro.egg-info/requires.txt +12 -0
  37. cachekaro-2.0.5/cachekaro.egg-info/top_level.txt +1 -0
  38. cachekaro-2.0.5/pyproject.toml +126 -0
  39. cachekaro-2.0.5/setup.cfg +4 -0
  40. cachekaro-2.0.5/tests/test_analyzer.py +133 -0
  41. cachekaro-2.0.5/tests/test_cleaner.py +134 -0
  42. cachekaro-2.0.5/tests/test_exporters.py +167 -0
  43. cachekaro-2.0.5/tests/test_platforms.py +137 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Mohit Bagri
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,360 @@
1
+ Metadata-Version: 2.4
2
+ Name: cachekaro
3
+ Version: 2.0.5
4
+ Summary: Cross-platform storage and cache analyzer & cleaner - Cache Karo!
5
+ Author-email: MOHIT BAGRI <mailmohitbagri@gmail.com>
6
+ Maintainer-email: MOHIT BAGRI <mailmohitbagri@gmail.com>
7
+ License-Expression: MIT
8
+ Project-URL: Homepage, https://github.com/Mohit-Bagri/cachekaro
9
+ Project-URL: Documentation, https://github.com/Mohit-Bagri/cachekaro#readme
10
+ Project-URL: Repository, https://github.com/Mohit-Bagri/cachekaro.git
11
+ Project-URL: Issues, https://github.com/Mohit-Bagri/cachekaro/issues
12
+ Project-URL: Changelog, https://github.com/Mohit-Bagri/cachekaro/blob/main/CHANGELOG.md
13
+ Keywords: cache,storage,cleanup,disk-space,system-maintenance,cross-platform,macos,linux,windows
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Environment :: Console
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Intended Audience :: System Administrators
18
+ Classifier: Intended Audience :: End Users/Desktop
19
+ Classifier: Operating System :: OS Independent
20
+ Classifier: Operating System :: MacOS :: MacOS X
21
+ Classifier: Operating System :: POSIX :: Linux
22
+ Classifier: Operating System :: Microsoft :: Windows
23
+ Classifier: Programming Language :: Python :: 3
24
+ Classifier: Programming Language :: Python :: 3.9
25
+ Classifier: Programming Language :: Python :: 3.10
26
+ Classifier: Programming Language :: Python :: 3.11
27
+ Classifier: Programming Language :: Python :: 3.12
28
+ Classifier: Topic :: System :: Systems Administration
29
+ Classifier: Topic :: Utilities
30
+ Requires-Python: >=3.9
31
+ Description-Content-Type: text/markdown
32
+ License-File: LICENSE
33
+ Requires-Dist: pyyaml>=6.0
34
+ Requires-Dist: colorama>=0.4.6
35
+ Provides-Extra: dev
36
+ Requires-Dist: pytest>=7.0; extra == "dev"
37
+ Requires-Dist: pytest-cov>=4.0; extra == "dev"
38
+ Requires-Dist: ruff>=0.1.0; extra == "dev"
39
+ Requires-Dist: mypy>=1.0; extra == "dev"
40
+ Requires-Dist: types-PyYAML>=6.0; extra == "dev"
41
+ Provides-Extra: rich
42
+ Requires-Dist: rich>=13.0; extra == "rich"
43
+ Dynamic: license-file
44
+
45
+ <div align="center">
46
+
47
+ # **CacheKaro**
48
+
49
+ ### Cross-Platform Storage & Cache Manager
50
+
51
+ **CacheKaro** - *Clean It Up!*
52
+
53
+ [![Python](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
54
+ [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
55
+ [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey.svg)](#-platform-support)
56
+ [![Tests](https://img.shields.io/badge/tests-53%20passing-brightgreen.svg)](#-development)
57
+
58
+ [Overview](#-overview) · [Installation](#-installation) · [Uninstall](#-uninstall) · [Quick Start](#-quick-start) · [Commands](#-commands) · [Detection](#-what-it-detects) · [Safety](#-safety--risk-levels) · [Config](#-configuration)
59
+
60
+ </div>
61
+
62
+ ---
63
+
64
+ ## ▸ Overview
65
+
66
+ **CacheKaro** is a cross-platform CLI tool to analyze and clean cache/storage on **macOS**, **Linux** and **Windows**. It automatically discovers caches from all installed applications and games.
67
+
68
+ ### Why CacheKaro?
69
+
70
+ | # | Feature | Description |
71
+ |:-:|---------|-------------|
72
+ | 1 | **Auto-Discovery** | Automatically detects 300+ known apps and any new software you install |
73
+ | 2 | **Cross-Platform** | One tool for macOS, Linux and Windows |
74
+ | 3 | **Developer Friendly** | Cleans npm, pip, Gradle, Maven, Cargo, Go, Docker and more |
75
+ | 4 | **Game Support** | Steam, Epic Games, Riot Games, Battle.net, Minecraft and more |
76
+ | 5 | **Creative Suite** | Adobe CC, DaVinci Resolve, Blender, Ableton, AutoCAD and more |
77
+ | 6 | **Safe by Default** | Risk-based classification prevents accidental data loss |
78
+ | 7 | **Beautiful Reports** | Cyberpunk-themed HTML reports with charts |
79
+
80
+ ---
81
+
82
+ ## ▸ Installation
83
+
84
+ ### ● Prerequisites
85
+
86
+ - Python 3.9 or higher
87
+ - pip (Python package manager)
88
+
89
+ ### ● Install Steps
90
+
91
+ ```bash
92
+ # 1. Clone the repository
93
+ git clone https://github.com/Mohit-Bagri/cachekaro.git
94
+
95
+ # 2. Navigate to the ROOT folder (not cachekaro/cachekaro)
96
+ cd cachekaro
97
+
98
+ # 3. Create and activate virtual environment (recommended)
99
+ python3 -m venv venv
100
+ source venv/bin/activate # macOS/Linux
101
+ # OR
102
+ .\venv\Scripts\activate # Windows
103
+
104
+ # 4. Install CacheKaro
105
+ pip install -e .
106
+ ```
107
+
108
+ ### ● Verify Installation
109
+
110
+ ```bash
111
+ cachekaro --version
112
+ ```
113
+
114
+ > **Note:** The `cachekaro` command only works when the virtual environment is activated. Always run `source venv/bin/activate` before using CacheKaro.
115
+
116
+ ---
117
+
118
+ ## ▸ Uninstall
119
+
120
+ ```bash
121
+ pip uninstall cachekaro
122
+ ```
123
+
124
+ To also remove configuration files:
125
+
126
+ | Platform | Command |
127
+ |----------|---------|
128
+ | macOS/Linux | `rm -rf ~/.config/cachekaro` |
129
+ | Windows | `rmdir /s %APPDATA%\cachekaro` |
130
+
131
+ ---
132
+
133
+ ## ▸ Quick Start
134
+
135
+ ```bash
136
+ # ► Analyze your storage
137
+ cachekaro analyze
138
+
139
+ # ► Preview what can be cleaned (safe mode)
140
+ cachekaro clean --dry-run
141
+
142
+ # ► Clean caches interactively
143
+ cachekaro clean
144
+
145
+ # ► Auto-clean all safe items without prompts
146
+ cachekaro clean --auto
147
+
148
+ # ► Generate cyberpunk HTML report
149
+ cachekaro report --output report.html
150
+ ```
151
+
152
+ ---
153
+
154
+ ## ▸ Commands
155
+
156
+ ### ● `cachekaro analyze`
157
+
158
+ Scans and displays all cache/storage usage on your system.
159
+
160
+ ```bash
161
+ cachekaro analyze # Basic analysis
162
+ cachekaro analyze -f json # Output as JSON
163
+ cachekaro analyze -f csv -o data.csv # Export to CSV
164
+ cachekaro analyze -c browser # Only browser caches
165
+ cachekaro analyze --min-size 100MB # Only items > 100MB
166
+ cachekaro analyze --stale-days 7 # Mark items older than 7 days as stale
167
+ ```
168
+
169
+ | Option | Short | Description | Default |
170
+ |--------|-------|-------------|---------|
171
+ | `--format` | `-f` | Output format: `text`, `json`, `csv` | `text` |
172
+ | `--output` | `-o` | Save output to file | stdout |
173
+ | `--category` | `-c` | Filter: `browser`, `development`, `game`, `application`, `system` | all |
174
+ | `--min-size` | — | Minimum size filter (e.g., `50MB`, `1GB`) | `0` |
175
+ | `--stale-days` | — | Days threshold for stale detection | `30` |
176
+
177
+ ---
178
+
179
+ ### ● `cachekaro clean`
180
+
181
+ Removes cache files based on selected criteria.
182
+
183
+ ```bash
184
+ cachekaro clean # Interactive mode
185
+ cachekaro clean --dry-run # Preview only, no deletion
186
+ cachekaro clean --auto # Auto-clean without prompts
187
+ cachekaro clean --auto --risk moderate # Include moderate risk items
188
+ cachekaro clean -c browser # Clean only browser caches
189
+ cachekaro clean --stale-only # Clean only stale items
190
+ ```
191
+
192
+ | Option | Description | Default |
193
+ |--------|-------------|---------|
194
+ | `--dry-run` | Preview what would be deleted without actually deleting | `false` |
195
+ | `--auto` | Automatically clean all items without confirmation prompts | `false` |
196
+ | `--category` | Category to clean: `browser`, `development`, `game`, `application`, `system` | all |
197
+ | `--risk` | Maximum risk level: `safe`, `moderate`, `caution` | `safe` |
198
+ | `--stale-only` | Only clean items older than stale threshold | `false` |
199
+
200
+ ---
201
+
202
+ ### ● `cachekaro report`
203
+
204
+ Generates detailed visual reports with charts.
205
+
206
+ ```bash
207
+ cachekaro report # Generate HTML report
208
+ cachekaro report -o myreport.html # Custom filename
209
+ cachekaro report -f json -o report.json # JSON format
210
+ ```
211
+
212
+ | Option | Short | Description | Default |
213
+ |--------|-------|-------------|---------|
214
+ | `--format` | `-f` | Report format: `html`, `json`, `csv`, `text` | `html` |
215
+ | `--output` | `-o` | Output file path | `cachekaro_report_<timestamp>.html` |
216
+
217
+ ---
218
+
219
+ ### ● `cachekaro info`
220
+
221
+ Displays system information and CacheKaro configuration.
222
+
223
+ ```bash
224
+ cachekaro info
225
+ ```
226
+
227
+ ---
228
+
229
+ ## ▸ What It Detects
230
+
231
+ ### ● Automatic Discovery
232
+
233
+ CacheKaro automatically scans standard cache directories and identifies **any** application by its folder name. It recognizes 300+ known apps with friendly names.
234
+
235
+ ### ● Categories
236
+
237
+ | # | Category | Examples |
238
+ |:-:|----------|----------|
239
+ | 1 | **Browser** | Chrome, Firefox, Safari, Edge, Brave, Arc, Vivaldi, Opera |
240
+ | 2 | **Development** | npm, pip, Cargo, Gradle, Maven, Docker, VS Code, JetBrains, Xcode |
241
+ | 3 | **Games** | Steam, Epic Games, Riot Games, Battle.net, Minecraft, Unity, GOG |
242
+ | 4 | **Creative** | Photoshop, Premiere Pro, After Effects, DaVinci Resolve, Final Cut Pro |
243
+ | 5 | **3D & Design** | Blender, Cinema 4D, Maya, ZBrush, SketchUp, Figma, Sketch |
244
+ | 6 | **Audio** | Ableton Live, FL Studio, Logic Pro, Pro Tools, Cubase, GarageBand |
245
+ | 7 | **Engineering** | AutoCAD, SolidWorks, Fusion 360, MATLAB, Simulink, Revit |
246
+ | 8 | **Applications** | Spotify, Discord, Slack, Zoom, WhatsApp, Notion, Obsidian |
247
+ | 9 | **System** | OS caches, temp files, logs, crash reports, font caches |
248
+
249
+ ### ● Platform-Specific Paths
250
+
251
+ | Platform | Locations Scanned |
252
+ |----------|-------------------|
253
+ | **macOS** | `~/Library/Caches`, `~/.cache`, `~/Library/Logs`, `~/Library/Application Support` |
254
+ | **Linux** | `~/.cache`, `~/.config`, `~/.local/share`, `~/.steam`, `~/.var/app` |
255
+ | **Windows** | `%LOCALAPPDATA%`, `%APPDATA%`, `%TEMP%`, `%USERPROFILE%` |
256
+
257
+ ---
258
+
259
+ ## ▸ Safety & Risk Levels
260
+
261
+ | Level | Icon | Description | Examples |
262
+ |-------|------|-------------|----------|
263
+ | **Safe** | 🟢 | 100% safe to delete, no data loss | Browser cache, npm cache, pip cache, temp files |
264
+ | **Moderate** | 🟡 | Generally safe, may require re-login or re-download | HuggingFace models, Maven repo, Docker images |
265
+ | **Caution** | 🔴 | Review before deleting, may contain user data | Downloads folder, application data |
266
+
267
+ ```bash
268
+ # ► Only clean safe items (default behavior)
269
+ cachekaro clean --risk safe
270
+
271
+ # ► Include moderate risk items
272
+ cachekaro clean --risk moderate
273
+
274
+ # ► Preview caution-level items before cleaning
275
+ cachekaro clean --risk caution --dry-run
276
+ ```
277
+
278
+ ---
279
+
280
+ ## ▸ Export Formats
281
+
282
+ | # | Format | Use Case | Command Example |
283
+ |:-:|--------|----------|-----------------|
284
+ | 1 | **Text** | Terminal output with colors | `cachekaro analyze` |
285
+ | 2 | **JSON** | APIs and automation | `cachekaro analyze -f json` |
286
+ | 3 | **CSV** | Spreadsheet analysis | `cachekaro analyze -f csv -o data.csv` |
287
+ | 4 | **HTML** | Interactive reports with charts | `cachekaro report` |
288
+
289
+ ---
290
+
291
+ ## ▸ Configuration
292
+
293
+ ### ● Config File Location
294
+
295
+ | Platform | Path |
296
+ |----------|------|
297
+ | macOS/Linux | `~/.config/cachekaro/config.yaml` |
298
+ | Windows | `%APPDATA%\cachekaro\config.yaml` |
299
+
300
+ ### ● Example Config
301
+
302
+ ```yaml
303
+ settings:
304
+ stale_threshold_days: 30 # Days before item is considered stale
305
+ default_format: text # Default output format
306
+ color_output: true # Enable colored terminal output
307
+ backup_before_delete: false # Create backup before deletion
308
+
309
+ custom_paths: # Add your own cache paths
310
+ - path: ~/my-app/cache
311
+ name: My App Cache
312
+ category: custom
313
+ risk_level: safe
314
+ ```
315
+
316
+ ---
317
+
318
+ ## ▸ Development
319
+
320
+ ```bash
321
+ # ► Setup development environment
322
+ git clone https://github.com/Mohit-Bagri/cachekaro.git
323
+ cd cachekaro
324
+ python3 -m venv venv
325
+ source venv/bin/activate
326
+ pip install -e ".[dev]"
327
+
328
+ # ► Run tests
329
+ pytest
330
+
331
+ # ► Linting & type checking
332
+ ruff check .
333
+ mypy cachekaro
334
+ ```
335
+
336
+ ---
337
+
338
+ ## ▸ Platform Support
339
+
340
+ | OS | Python 3.9 | Python 3.10 | Python 3.11 | Python 3.12 |
341
+ |----|:----------:|:-----------:|:-----------:|:-----------:|
342
+ | macOS | ✓ | ✓ | ✓ | ✓ |
343
+ | Ubuntu | ✓ | ✓ | ✓ | ✓ |
344
+ | Windows | ✓ | ✓ | ✓ | ✓ |
345
+
346
+ ---
347
+
348
+ ## ▸ License
349
+
350
+ MIT License — see [LICENSE](LICENSE)
351
+
352
+ ---
353
+
354
+ <div align="center">
355
+
356
+ Made in 🇮🇳 with ❤️ by [MOHIT BAGRI](https://github.com/Mohit-Bagri)
357
+
358
+ **CacheKaro** - *Clean It Up!*
359
+
360
+ </div>
@@ -0,0 +1,316 @@
1
+ <div align="center">
2
+
3
+ # **CacheKaro**
4
+
5
+ ### Cross-Platform Storage & Cache Manager
6
+
7
+ **CacheKaro** - *Clean It Up!*
8
+
9
+ [![Python](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
10
+ [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
11
+ [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey.svg)](#-platform-support)
12
+ [![Tests](https://img.shields.io/badge/tests-53%20passing-brightgreen.svg)](#-development)
13
+
14
+ [Overview](#-overview) · [Installation](#-installation) · [Uninstall](#-uninstall) · [Quick Start](#-quick-start) · [Commands](#-commands) · [Detection](#-what-it-detects) · [Safety](#-safety--risk-levels) · [Config](#-configuration)
15
+
16
+ </div>
17
+
18
+ ---
19
+
20
+ ## ▸ Overview
21
+
22
+ **CacheKaro** is a cross-platform CLI tool to analyze and clean cache/storage on **macOS**, **Linux** and **Windows**. It automatically discovers caches from all installed applications and games.
23
+
24
+ ### Why CacheKaro?
25
+
26
+ | # | Feature | Description |
27
+ |:-:|---------|-------------|
28
+ | 1 | **Auto-Discovery** | Automatically detects 300+ known apps and any new software you install |
29
+ | 2 | **Cross-Platform** | One tool for macOS, Linux and Windows |
30
+ | 3 | **Developer Friendly** | Cleans npm, pip, Gradle, Maven, Cargo, Go, Docker and more |
31
+ | 4 | **Game Support** | Steam, Epic Games, Riot Games, Battle.net, Minecraft and more |
32
+ | 5 | **Creative Suite** | Adobe CC, DaVinci Resolve, Blender, Ableton, AutoCAD and more |
33
+ | 6 | **Safe by Default** | Risk-based classification prevents accidental data loss |
34
+ | 7 | **Beautiful Reports** | Cyberpunk-themed HTML reports with charts |
35
+
36
+ ---
37
+
38
+ ## ▸ Installation
39
+
40
+ ### ● Prerequisites
41
+
42
+ - Python 3.9 or higher
43
+ - pip (Python package manager)
44
+
45
+ ### ● Install Steps
46
+
47
+ ```bash
48
+ # 1. Clone the repository
49
+ git clone https://github.com/Mohit-Bagri/cachekaro.git
50
+
51
+ # 2. Navigate to the ROOT folder (not cachekaro/cachekaro)
52
+ cd cachekaro
53
+
54
+ # 3. Create and activate virtual environment (recommended)
55
+ python3 -m venv venv
56
+ source venv/bin/activate # macOS/Linux
57
+ # OR
58
+ .\venv\Scripts\activate # Windows
59
+
60
+ # 4. Install CacheKaro
61
+ pip install -e .
62
+ ```
63
+
64
+ ### ● Verify Installation
65
+
66
+ ```bash
67
+ cachekaro --version
68
+ ```
69
+
70
+ > **Note:** The `cachekaro` command only works when the virtual environment is activated. Always run `source venv/bin/activate` before using CacheKaro.
71
+
72
+ ---
73
+
74
+ ## ▸ Uninstall
75
+
76
+ ```bash
77
+ pip uninstall cachekaro
78
+ ```
79
+
80
+ To also remove configuration files:
81
+
82
+ | Platform | Command |
83
+ |----------|---------|
84
+ | macOS/Linux | `rm -rf ~/.config/cachekaro` |
85
+ | Windows | `rmdir /s %APPDATA%\cachekaro` |
86
+
87
+ ---
88
+
89
+ ## ▸ Quick Start
90
+
91
+ ```bash
92
+ # ► Analyze your storage
93
+ cachekaro analyze
94
+
95
+ # ► Preview what can be cleaned (safe mode)
96
+ cachekaro clean --dry-run
97
+
98
+ # ► Clean caches interactively
99
+ cachekaro clean
100
+
101
+ # ► Auto-clean all safe items without prompts
102
+ cachekaro clean --auto
103
+
104
+ # ► Generate cyberpunk HTML report
105
+ cachekaro report --output report.html
106
+ ```
107
+
108
+ ---
109
+
110
+ ## ▸ Commands
111
+
112
+ ### ● `cachekaro analyze`
113
+
114
+ Scans and displays all cache/storage usage on your system.
115
+
116
+ ```bash
117
+ cachekaro analyze # Basic analysis
118
+ cachekaro analyze -f json # Output as JSON
119
+ cachekaro analyze -f csv -o data.csv # Export to CSV
120
+ cachekaro analyze -c browser # Only browser caches
121
+ cachekaro analyze --min-size 100MB # Only items > 100MB
122
+ cachekaro analyze --stale-days 7 # Mark items older than 7 days as stale
123
+ ```
124
+
125
+ | Option | Short | Description | Default |
126
+ |--------|-------|-------------|---------|
127
+ | `--format` | `-f` | Output format: `text`, `json`, `csv` | `text` |
128
+ | `--output` | `-o` | Save output to file | stdout |
129
+ | `--category` | `-c` | Filter: `browser`, `development`, `game`, `application`, `system` | all |
130
+ | `--min-size` | — | Minimum size filter (e.g., `50MB`, `1GB`) | `0` |
131
+ | `--stale-days` | — | Days threshold for stale detection | `30` |
132
+
133
+ ---
134
+
135
+ ### ● `cachekaro clean`
136
+
137
+ Removes cache files based on selected criteria.
138
+
139
+ ```bash
140
+ cachekaro clean # Interactive mode
141
+ cachekaro clean --dry-run # Preview only, no deletion
142
+ cachekaro clean --auto # Auto-clean without prompts
143
+ cachekaro clean --auto --risk moderate # Include moderate risk items
144
+ cachekaro clean -c browser # Clean only browser caches
145
+ cachekaro clean --stale-only # Clean only stale items
146
+ ```
147
+
148
+ | Option | Description | Default |
149
+ |--------|-------------|---------|
150
+ | `--dry-run` | Preview what would be deleted without actually deleting | `false` |
151
+ | `--auto` | Automatically clean all items without confirmation prompts | `false` |
152
+ | `--category` | Category to clean: `browser`, `development`, `game`, `application`, `system` | all |
153
+ | `--risk` | Maximum risk level: `safe`, `moderate`, `caution` | `safe` |
154
+ | `--stale-only` | Only clean items older than stale threshold | `false` |
155
+
156
+ ---
157
+
158
+ ### ● `cachekaro report`
159
+
160
+ Generates detailed visual reports with charts.
161
+
162
+ ```bash
163
+ cachekaro report # Generate HTML report
164
+ cachekaro report -o myreport.html # Custom filename
165
+ cachekaro report -f json -o report.json # JSON format
166
+ ```
167
+
168
+ | Option | Short | Description | Default |
169
+ |--------|-------|-------------|---------|
170
+ | `--format` | `-f` | Report format: `html`, `json`, `csv`, `text` | `html` |
171
+ | `--output` | `-o` | Output file path | `cachekaro_report_<timestamp>.html` |
172
+
173
+ ---
174
+
175
+ ### ● `cachekaro info`
176
+
177
+ Displays system information and CacheKaro configuration.
178
+
179
+ ```bash
180
+ cachekaro info
181
+ ```
182
+
183
+ ---
184
+
185
+ ## ▸ What It Detects
186
+
187
+ ### ● Automatic Discovery
188
+
189
+ CacheKaro automatically scans standard cache directories and identifies **any** application by its folder name. It recognizes 300+ known apps with friendly names.
190
+
191
+ ### ● Categories
192
+
193
+ | # | Category | Examples |
194
+ |:-:|----------|----------|
195
+ | 1 | **Browser** | Chrome, Firefox, Safari, Edge, Brave, Arc, Vivaldi, Opera |
196
+ | 2 | **Development** | npm, pip, Cargo, Gradle, Maven, Docker, VS Code, JetBrains, Xcode |
197
+ | 3 | **Games** | Steam, Epic Games, Riot Games, Battle.net, Minecraft, Unity, GOG |
198
+ | 4 | **Creative** | Photoshop, Premiere Pro, After Effects, DaVinci Resolve, Final Cut Pro |
199
+ | 5 | **3D & Design** | Blender, Cinema 4D, Maya, ZBrush, SketchUp, Figma, Sketch |
200
+ | 6 | **Audio** | Ableton Live, FL Studio, Logic Pro, Pro Tools, Cubase, GarageBand |
201
+ | 7 | **Engineering** | AutoCAD, SolidWorks, Fusion 360, MATLAB, Simulink, Revit |
202
+ | 8 | **Applications** | Spotify, Discord, Slack, Zoom, WhatsApp, Notion, Obsidian |
203
+ | 9 | **System** | OS caches, temp files, logs, crash reports, font caches |
204
+
205
+ ### ● Platform-Specific Paths
206
+
207
+ | Platform | Locations Scanned |
208
+ |----------|-------------------|
209
+ | **macOS** | `~/Library/Caches`, `~/.cache`, `~/Library/Logs`, `~/Library/Application Support` |
210
+ | **Linux** | `~/.cache`, `~/.config`, `~/.local/share`, `~/.steam`, `~/.var/app` |
211
+ | **Windows** | `%LOCALAPPDATA%`, `%APPDATA%`, `%TEMP%`, `%USERPROFILE%` |
212
+
213
+ ---
214
+
215
+ ## ▸ Safety & Risk Levels
216
+
217
+ | Level | Icon | Description | Examples |
218
+ |-------|------|-------------|----------|
219
+ | **Safe** | 🟢 | 100% safe to delete, no data loss | Browser cache, npm cache, pip cache, temp files |
220
+ | **Moderate** | 🟡 | Generally safe, may require re-login or re-download | HuggingFace models, Maven repo, Docker images |
221
+ | **Caution** | 🔴 | Review before deleting, may contain user data | Downloads folder, application data |
222
+
223
+ ```bash
224
+ # ► Only clean safe items (default behavior)
225
+ cachekaro clean --risk safe
226
+
227
+ # ► Include moderate risk items
228
+ cachekaro clean --risk moderate
229
+
230
+ # ► Preview caution-level items before cleaning
231
+ cachekaro clean --risk caution --dry-run
232
+ ```
233
+
234
+ ---
235
+
236
+ ## ▸ Export Formats
237
+
238
+ | # | Format | Use Case | Command Example |
239
+ |:-:|--------|----------|-----------------|
240
+ | 1 | **Text** | Terminal output with colors | `cachekaro analyze` |
241
+ | 2 | **JSON** | APIs and automation | `cachekaro analyze -f json` |
242
+ | 3 | **CSV** | Spreadsheet analysis | `cachekaro analyze -f csv -o data.csv` |
243
+ | 4 | **HTML** | Interactive reports with charts | `cachekaro report` |
244
+
245
+ ---
246
+
247
+ ## ▸ Configuration
248
+
249
+ ### ● Config File Location
250
+
251
+ | Platform | Path |
252
+ |----------|------|
253
+ | macOS/Linux | `~/.config/cachekaro/config.yaml` |
254
+ | Windows | `%APPDATA%\cachekaro\config.yaml` |
255
+
256
+ ### ● Example Config
257
+
258
+ ```yaml
259
+ settings:
260
+ stale_threshold_days: 30 # Days before item is considered stale
261
+ default_format: text # Default output format
262
+ color_output: true # Enable colored terminal output
263
+ backup_before_delete: false # Create backup before deletion
264
+
265
+ custom_paths: # Add your own cache paths
266
+ - path: ~/my-app/cache
267
+ name: My App Cache
268
+ category: custom
269
+ risk_level: safe
270
+ ```
271
+
272
+ ---
273
+
274
+ ## ▸ Development
275
+
276
+ ```bash
277
+ # ► Setup development environment
278
+ git clone https://github.com/Mohit-Bagri/cachekaro.git
279
+ cd cachekaro
280
+ python3 -m venv venv
281
+ source venv/bin/activate
282
+ pip install -e ".[dev]"
283
+
284
+ # ► Run tests
285
+ pytest
286
+
287
+ # ► Linting & type checking
288
+ ruff check .
289
+ mypy cachekaro
290
+ ```
291
+
292
+ ---
293
+
294
+ ## ▸ Platform Support
295
+
296
+ | OS | Python 3.9 | Python 3.10 | Python 3.11 | Python 3.12 |
297
+ |----|:----------:|:-----------:|:-----------:|:-----------:|
298
+ | macOS | ✓ | ✓ | ✓ | ✓ |
299
+ | Ubuntu | ✓ | ✓ | ✓ | ✓ |
300
+ | Windows | ✓ | ✓ | ✓ | ✓ |
301
+
302
+ ---
303
+
304
+ ## ▸ License
305
+
306
+ MIT License — see [LICENSE](LICENSE)
307
+
308
+ ---
309
+
310
+ <div align="center">
311
+
312
+ Made in 🇮🇳 with ❤️ by [MOHIT BAGRI](https://github.com/Mohit-Bagri)
313
+
314
+ **CacheKaro** - *Clean It Up!*
315
+
316
+ </div>