Skip to content

README.md

Latest commit

 

History

History
177 lines (139 loc) · 4.66 KB

README.md

File metadata and controls

177 lines (139 loc) · 4.66 KB

Mac Dev Cleaner CLI

🧹 Clean development artifacts on macOS - free up disk space fast!

Go Version License

Overview

Mac Dev Cleaner is a CLI tool that helps developers reclaim disk space by removing:

  • Xcode - DerivedData, Archives, Caches
  • Android - Gradle caches, SDK caches
  • Node.js - node_modules, npm/yarn/pnpm/bun caches

Installation

Homebrew (Coming Soon)

brew tap thanhdevapp/tools
brew install dev-cleaner

From Source

git clone https://github.com/thanhdevapp/dev-cleaner.git
cd dev-cleaner
go build -o dev-cleaner .
sudo mv dev-cleaner /usr/local/bin/

Usage

Scan for Cleanable Items

# Scan all categories
dev-cleaner scan

# Scan specific category
dev-cleaner scan --ios
dev-cleaner scan --android
dev-cleaner scan --node

Example Output:

🔍 Scanning for development artifacts...
──────────────────────────────────────────────────

  [1] android      9.0 GB  Android System Images
  [2] xcode        7.4 GB  Xcode DerivedData
  [3] android      5.4 GB  Gradle Caches
  [4] xcode        3.9 GB  DerivedData/Runner-xxx
  [5] node         1.8 GB  npm Cache
  ...
──────────────────────────────────────────────────
Total: 14 items, 31.4 GB

Clean Items

# Interactive clean (dry-run by default)
dev-cleaner clean

# Actually delete files
dev-cleaner clean --confirm

# Clean specific category
dev-cleaner clean --ios --confirm

Safety Features

  • ✅ Dry-run by default - preview before deleting
  • ✅ Confirmation required - must type yes to delete
  • ✅ Path validation - never touches system files
  • ✅ Logging - all actions logged to ~/.dev-cleaner.log

Scanned Directories

iOS/Xcode

  • ~/Library/Developer/Xcode/DerivedData/
  • ~/Library/Developer/Xcode/Archives/
  • ~/Library/Caches/com.apple.dt.Xcode/
  • ~/Library/Developer/CoreSimulator/Caches/
  • ~/Library/Caches/CocoaPods/

Android

  • ~/.gradle/caches/
  • ~/.gradle/wrapper/
  • ~/.android/cache/
  • ~/Library/Android/sdk/system-images/

Node.js

  • */node_modules/ (in common project directories)
  • ~/.npm/
  • ~/.pnpm-store/
  • ~/.yarn/cache/
  • ~/.bun/install/cache/

Development

# Build
go build -o dev-cleaner .

# Run tests
go test ./...

# Run locally
./dev-cleaner scan

Roadmap

Phase 1: Core Features (Current)

  • MVP: Scan and clean commands
  • TUI with interactive selection (BubbleTea)
  • Config file support (.dev-cleaner.yaml)
  • Homebrew distribution
  • Progress bars with ETA

Phase 2: Extended Language Support

  • Python - __pycache__, .pytest_cache, .mypy_cache, pip cache
  • Ruby - gem cache, bundler cache
  • Rust - target/ folders, cargo cache
  • Go - go build cache, go mod cache
  • Docker - unused images, containers, volumes
  • Swift Package Manager - SPM cache
  • Maven - ~/.m2/repository
  • Homebrew - brew cache

Phase 3: Smart Features

  • Statistics & History - Track cleaned space over time
    • dev-cleaner stats - View cleaning history
    • dev-cleaner history - Show past operations
    • dev-cleaner top - Top 10 space consumers
  • Smart Detection - Intelligent recommendations
    • Detect unused projects (>6 months inactive)
    • Auto-suggest cleaning when disk space is low
    • Warning when disk < 10GB free
  • Exclude/Whitelist System
    • Path exclusion rules
    • Age-based cleaning policies
    • Project importance tagging

Phase 4: Advanced Features

  • Scheduled Cleaning
    • dev-cleaner schedule weekly
    • Cron-style scheduling
    • Background daemon mode
  • Backup & Restore
    • Compress before delete option
    • Restore point creation
    • Undo last clean operation
  • Analysis Tools
    • dev-cleaner analyze - Deep disk usage analysis
    • Project activity detection
    • Smart recommendations
  • Multi-machine Sync - Sync settings across Macs
  • Web Dashboard - Browser-based UI for management
  • CI/CD Integration - Clean build artifacts on runners

Phase 5: Polish

  • Notification system (macOS native)
  • Export/Import configurations
  • Interactive file browser with preview
  • Real-time speed indicators (MB/s)
  • Cloud backup integration

License

MIT License - see LICENSE for details.