A powerful disk usage analyzer with iCloud support
Project description
reclaimed 🌟
A powerful and user-friendly command-line tool for analyzing disk usage, with special handling for iCloud storage on macOS. Quickly find your largest files and directories with a beautiful, color-coded interface. I let aider write the README.md boilerplate and it's all accurate but I'm still not sure how we feel about the emojis... it seems Claude is a colorful gentleman when writing markdown.
Features
- 🚀 Fast recursive directory scanning, legitimately performant and batches progress updates efficently
- ☁️ Smart detection of iCloud vs local storage which is nice on the macbook
- 📊 She pretty (it utilizes the Textualize/rich library for fancy CLI stylings)
- 💾 Export results to JSON for further analysis or batch operations
- ⚡️ Real-time progress indication actually great
- 🛡️ Graceful handling of permission issues, doesn't freeze like the old diskinventoryx
Installation
Prerequisites
- Python 3.8 or higher
- pip (Python package installer)
- Technically not a venv but if you aren't using a venv you're generally doing python wrong
Using pip
pip install reclaimed
From Source
git clone https://github.com/taylorwilsdon/reclaimed.git
cd reclaimed
pip install -r requirements.txt
hatch shell
Usage
Basic usage:
reclaimed ~/Documents
Advanced options:
# Show more results
reclaimed ~/Documents --files 20 --dirs 15
# Save results to JSON
reclaimed ~/Documents --output results.json
Options
PATH: Directory to scan (default: current directory)-f, --files N: Number of largest files to show (default: 10)-d, --dirs N: Number of largest directories to show (default: 10)-o, --output FILE: Save results to JSON file
Output
The tool provides:
- A real-time progress indicator showing files scanned and total size
- Two tables showing the largest files and directories
- Clear indication of iCloud vs local storage
- Summary of any access issues encountered
Development
This project uses Hatch for development workflow management.
Setup Development Environment
pip install -r requirements.txt
hatch shell
Common Commands
# Run tests
hatch run test
# Run tests with coverage
hatch run test-cov
# Run linting (black, ruff, mypy)
hatch run lint
# Build distribution packages
hatch build
Contributing
Contributions are welcome! Please see our Contributing Guide for details.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reclaimed-0.1.2.tar.gz.
File metadata
- Download URL: reclaimed-0.1.2.tar.gz
- Upload date:
- Size: 40.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
561344810ee312e463e827ce448c68d58b022625169528fe5cc67bacaba676f7
|
|
| MD5 |
dd5fdd34628ef5ae4c191af1e4300f21
|
|
| BLAKE2b-256 |
f839a775bd770a0b442e628fb48f20420a78e7cbfe04cd21638b98c825b2f1a0
|
File details
Details for the file reclaimed-0.1.2-py3-none-any.whl.
File metadata
- Download URL: reclaimed-0.1.2-py3-none-any.whl
- Upload date:
- Size: 41.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44b08ae7be67fb7e2de9e1c110ea0959c46936bec9357b0456650b716b2b64d5
|
|
| MD5 |
d1fdbf564a130edf63d4194a65a3531e
|
|
| BLAKE2b-256 |
6f04c8ea9723cd9a70eaa3d494ab6068baa3d15f3a59e5ddc8a30359c1ee2cf6
|