cmm

README

🧹 cmm: macOS Cleanup & Maintenance

"Because your Mac deserves a spa day." ✨

cmm is a modern, interactive, Go-powered terminal utility designed to help you reclaim disk space and keep your macOS running like new. No more hunting through /Library/Caches or manually purging Time Machine snapshots. cmm does the heavy lifting with a polished TUI that makes system maintenance... dare we say, fun?

---

🚀 Key Features

• 📸 Time Machine Purge: Say goodbye to those bloated local snapshots.
• 🛠️ Xcode Detox: Clear out DerivedData and old simulators with one click.
• 🍺 Homebrew Hygiene: Cleanup old cellar versions and cache files.
• 🧹 Cache & Log Crusher: Target deep system and user caches safely.
• 🕵️ Interactive Previews: See exactly what's being deleted before you pull the trigger.
• 🎨 Beautiful TUI: Built with Bubble Tea for a premium terminal experience.

---

📦 Installation

To get started, you'll need Go installed on your system.

Recommended (via go install)

The easiest way to install cmm is via go install:

go install github.com/david-saint/cmm@latest

From Source

If you prefer to build it yourself or want to contribute:

1. Clone the repository:

   git clone https://github.com/david-saint/cmm.git
   cd cmm
   

2. Build the binary:

   go build -o cmm main.go
   

---

🛠 Usage

Run the tool interactively:

cmm run

Tips

• Use the arrow keys to navigate.
• Press Space to select/deselect modules.
• Hit Enter to confirm your cleanup path.
• Look out for Safety Red warnings on "Harsh" cleanup modules—we take your data seriously!

---

🤝 Contributing

We love contributions! cmm follows a strict Test-Driven Development (TDD) workflow managed via the conductor methodology.

Development Workflow

1. Pick a task: Check the conductor/tracks/ for open items.
2. Red Phase: Write a failing test in pkg/ or cmd/.
3. Green Phase: Implement the minimum code to make it pass.
4. Refactor: Clean up your code while keeping the tests green.
5. Coverage: Ensure you hit at least 80% code coverage.

Read the full Workflow Guide for more details.

---

📜 License

Distributed under the MIT License. See LICENSE for more information.

---

Built with ❤️ and plenty of ☕️ by David Saint.

Documentation

Overview

Copyright © 2026 David Saint

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.