QUICKSTART · macOS 12+ · Python 3.9+

Sweep — up and running in 2 minutes

Install the CLI, run a free scan to see what's there, then clean or activate Pro.

1. Install Sweep

Option A — One-line installer (recommended)

curl -fsSL https://github.com/jlsport18/DreamCleanr/releases/download/v0.3.6/install.sh | bash
What this does: Downloads and installs the Sweep CLI into ~/.local/bin/sweep. Adds it to your PATH automatically. Requires Python 3.9+.

Option B — pip install

pip install git+https://github.com/jlsport18/[email protected]

Verify installation

sweep --version
dreamcleanr 0.3.6

2. Run your first scan

The scan is always free and never deletes anything. It shows you exactly what Sweep can reclaim before you decide to clean.

sweep scan

Scanning your Mac... (takes 10-30 seconds)

  DreamCleanr can reclaim up to 4.2 GB RAM and 18.4 GB disk right now.

  RAM   Inactive app memory   ~2.1 GB  → purge (reversible)
  RAM   Compressed pages      ~1.9 GB  → free compressed cache (reversible)
  disk  Xcode DerivedData     ~9.2 GB
  disk  node_modules (stale)  ~4.8 GB
  disk  Docker layers         ~2.9 GB
  disk  pip/npm caches        ~1.5 GB
Free scan, always. The scan runs locally on your Mac. Your file list never leaves your machine. No account needed.

3. Clean your Mac

Preview what will be deleted (dry run)

sweep clean

[DRY RUN] — nothing deleted yet. Review the plan below:

  DELETE  ~/Library/Developer/Xcode/DerivedData    (9.2 GB)
  DELETE  ~/projects/myapp/node_modules             (4.8 GB)
  DELETE  ~/.docker/buildkit (unused layers)        (2.9 GB)
  DELETE  ~/.cache/pip                              (1.5 GB)

Total: 18.4 GB recoverable.
Run `sweep clean --apply` to delete, or `sweep clean --apply --trash` to move to Trash.

Apply cleanup

sweep clean --apply           # Hard delete — reclaims space immediately
sweep clean --apply --trash   # Move to Trash — restorable from Finder

Cleaning modes

sweep clean --mode safe       # Caches only — never touches source files
sweep clean --mode balanced   # Default — caches + stale deps
sweep clean --mode max        # Aggressive — everything Sweep can find

4. Activate Sweep Pro

Sweep Pro unlocks developer mode (targets Xcode DerivedData, node_modules, Docker image layers, and AI model caches) plus scheduled automatic cleaning.

Buy Sweep Pro — $29 one-time

One-time purchase. No subscription. No auto-renewal. Works on any Mac you own.

Buy Sweep Pro — $29 →

You'll receive your license key by email within 60 seconds of purchase.

Activate your license key

sweep license activate \
  --key SWEEP-ABCDEFGHIJKLMNOP \
  --email [email protected]

✅ Sweep Pro activated. Welcome to the Pro tier.
   Developer mode, scheduled cleaning, and priority support are now unlocked.

Check license status

sweep license status

✅ Sweep Pro — active
   Email:        [email protected]
   Activated:    2026-06-02
   Tier:         PRO
License is local. Your license key is stored at ~/.sweep_license. It validates offline — no internet connection needed after activation. Works on any Mac you own.

All commands

CommandDescription
sweep scanScan and show what can be reclaimed. Never deletes anything.
sweep scan --mode maxAggressive scan — finds everything, including AI model caches (Pro)
sweep cleanPreview cleanup plan (dry run, no deletion)
sweep clean --applyExecute cleanup — hard delete, reclaims space immediately
sweep clean --apply --trashMove to Trash instead of hard delete (restorable)
sweep clean --mode safeCaches only — never touches source files or deps
sweep clean --mode maxAggressive — everything Sweep can find safely
sweep schedule installInstall LaunchAgent for automatic scheduled cleaning (Pro)
sweep schedule uninstallRemove the LaunchAgent
sweep license activate --key KEY --email EMAILActivate Sweep Pro with your license key
sweep license statusShow current license status
sweep license deactivateRemove license from this Mac
sweep --versionShow installed version

Cleaning modes

ModeWhat it targetsWhen to use
safeSystem caches, temp files onlyDaily maintenance
balancedCaches + stale dependencies (default)Weekly cleanup
maxEverything above + Xcode DerivedData, Docker layers, AI model caches (Pro)Monthly deep clean

Scheduled cleaning (Pro)

Install a macOS LaunchAgent to run Sweep automatically. Requires Sweep Pro.

# Install — runs every day at 4:30am in balanced mode
sweep schedule install

# Custom schedule — 6am, aggressive mode
sweep schedule install --hour 6 --mode max

# Remove the LaunchAgent
sweep schedule uninstall

Troubleshoot

Command not found after install

export PATH="$HOME/.local/bin:$PATH"  # Add to ~/.zshrc

Lost your license key

Your key was emailed when you purchased. Search for "Your Sweep Pro license key" in your inbox. If you can't find it, email [email protected] with your purchase email.

Deactivate and re-activate on a new Mac

# On old Mac
sweep license deactivate

# On new Mac — use the same key and email
sweep license activate --key SWEEP-... --email [email protected]
Your license key works on any Mac you own. No device limit enforced — but keep your key private.