kv-clearnup/README.md

2.7 KiB

KV Clearnup (Antigravity) 🚀

A modern, high-performance system optimizer for macOS, built with Electron, React, and Go.

App Screenshot

Features

  • Flash Clean: Instantly remove system caches, logs, Xcode cache, Homebrew cache, and manage Trash with a detailed inspection view.
  • App Uninstaller: View installed applications, their sizes, and thoroughly remove them along with their associated preference files and caches.
  • Deep Clean: Scan for large files and heavy folders.
  • Real-time Monitoring: Track disk usage and category sizes.
  • Native Menubar Integration: Includes a responsive, monochrome template icon that adapts to macOS light/dark modes perfectly.
  • Cross-Platform: Runs natively with compiled Go backends on Apple Silicon (M1/M2/M3), Intel Macs, and Windows.

Prerequisites

  • Node.js (v18+)
  • Go (v1.20+)
  • pnpm (preferred) or npm
  • C Compiler (gcc/clang, via Xcode Command Line Tools on macOS)

Development

1. Install Dependencies

pnpm install

2. Run in Development Mode

This starts the Go backend (port 36969) and the Vite/Electron frontend concurrently.

./start-go.sh

Note: Do not run pnpm run dev directly if you want the backend to work. Use the script.

Building for Production

To create distributable release binaries (Universal .dmg for macOS, Portable .exe for Windows):

1. Build the App

# macOS Universal DMG
pnpm run build && pnpm run electron:build && npx electron-builder --mac --universal

# Windows Portable EXE
pnpm run build && pnpm run electron:build && npx electron-builder --win portable --x64

2. Locate the Installer

The output files will be automatically placed in the release/ directory:

  • release/KV Clearnup-1.0.0-universal.dmg (macOS)
  • release/KV Clearnup 1.0.0.exe (Windows)

Running the App

  1. Mount the DMG: Double-click the .dmg file in the release folder.
  2. Install: Drag the app to your Applications folder.
  3. Launch: Open "KV Clearnup" from Applications.

Troubleshooting: If you see "System Extension Blocked" or similar OS warnings, go to System Settings > Privacy & Security and allow the application.

Architecture

  • Frontend: React, TypeScript, TailwindCSS, Framer Motion.
  • Main Process: Electron (TypeScript).
  • Backend: Go (Golang) for file system operations and heavy scanning.
  • Communication: Electron uses child_process to spawn the Go binary. Frontend communicates with backend via HTTP (localhost:36969).

License

MIT