Skip to main content

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.

Disk Scanner Demo

image

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reclaimed-0.1.3.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reclaimed-0.1.3-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

Details for the file reclaimed-0.1.3.tar.gz.

File metadata

  • Download URL: reclaimed-0.1.3.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for reclaimed-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8708016ad6a711fa5f30bb2fa0420c925ac749fa56ae1c318292c30d38dd8af9
MD5 da0d2415790110ec433edc3a6b980503
BLAKE2b-256 30e71bd92fb8e539ac62318c33cab57b08a9853e7b1c5689e9a00054de74a58a

See more details on using hashes here.

File details

Details for the file reclaimed-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: reclaimed-0.1.3-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

Hashes for reclaimed-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0817db7c9fb332904f666708961591fda9c673eebbf7c4b84a3a656ea1f0edc4
MD5 8ef5458e8d4ce5f38510ea2ca5ea39c7
BLAKE2b-256 5db5e95559a607a6b198a77f7245faf0f3f685af7de9f335f9f01b6a7210c28d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page