Skip to content

elev1e1nSure/broominal

Repository files navigation

🧹 broominal

safe, transparent, undoable Windows cleanup from the terminal

go ci release downloads license platform


What

broominal cleans Windows by moving files into quarantine — not deleting them. Every cleanup is inspectable and restorable.

62 scanner categories across three risk levels (Safe / Review / Danger), interactive TUI, JSON manifests, multilingual (EN/RU), AI-polished release notes.

No fake boost magic. No hidden tweaks. No "trust me bro" cleanup.


Install

go install github.com/elev1e1nSure/broominal/cmd/broominal@latest

Or download from releases.

Quick Start

broominal scan              # find cleanup candidates
broominal clean --yes       # execute safe cleanup (Quick preset)
broominal restore last      # undo last cleanup
broominal ui                # interactive TUI

How It Works

Scan → Review → Clean → Quarantine → Restore

Files go to %LOCALAPPDATA%\broominal\quarantine\<id>\ with a manifest.json. Restore reads the manifest and moves files back. Operations are protected by a Write-Ahead Log (WAL) (journal.jsonl) that guarantees 100% atomic cleanups and automatically repairs interrupted operations (e.g. power loss) on next launch.

Safety

Level Behavior
Safe Auto-selected. Temp, caches, auto-rebuilt data
Review Manual select. Downloads, dumps, update cache
Danger Never auto-selected. System paths

Three presets: Quick (19 safe categories) → Standard (42 total) → Deep (62 total). Review items require manual selection regardless of preset.

Commands

scan · clean · restore · ui · doctor · config · quarantine · report · path · update

See docs/commands.md for full reference.

Develop

git clone https://github.com/elev1e1nSure/broominal.git
cd broominal
just build
just run ui

Release notes are generated from conventional commits via git-cliff and optionally beautified with an LLM through the scripts/ai-changelog.ps1 script (requires OPENROUTER_API_KEY).

See docs/developing.md.

Docs

License

MIT © elev1e1nSure

About

safe, transparent, undoable Windows cleanup CLI/TUI written in Go.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages