Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Omarchy Cleaner

A theme-aware Omarchy Quattro bar widget for scanning and safely reclaiming disk space. Cleanup is conservative by default, review-first when it can remove packages or caches, and always visible in an interactive terminal.

Omarchy License

Features

  • Live estimates for trash, thumbnails, the Pacman cache, journal usage, orphan packages, and archived crash dumps
  • Safe Clean for desktop trash, generated thumbnails, systemd temporary files, journal entries older than four weeks, and superseded Pacman packages
  • Deep Clean with separate reviews for orphan packages, crash dumps, unused Flatpak runtimes, Docker cache, and developer caches
  • Opt-in clipboard-history cleanup, including cached clipboard images
  • Interactive confirmation before cleanup
  • Visible sudo prompts in the user's terminal
  • No deletion of Docker volumes, downloads, projects, personal files, or user configuration

Requirements

  • Omarchy 4.0 or newer with the Quattro shell plugin system
  • Bash
  • Standard Omarchy/Arch tools used by the selected cleanup categories
  • Optional: Flatpak, Docker, npm, pnpm, pip, Go, and cargo-cache; categories for unavailable tools are safely skipped

The plugin does not download or execute remote code. System cleanup commands run locally and request privilege through interactive sudo only when needed.

Install

omarchy plugin add https://github.com/SeanGSR/omarchy-cleaner-plugin.git --enable

After installation, place the widget wherever you prefer using Omarchy's bar settings, or run:

omarchy bar move io.github.seangsr.omarchy-cleaner --section right

Click the broom icon in the bar to scan and open the cleanup panel.

Optional clipboard add-on

Install Omarchy Clipboard Cleaner to add a visible Clear button—with the same broom icon—to Omarchy's clipboard page:

omarchy plugin add https://github.com/SeanGSR/omarchy-clipboard-cleaner.git --enable

The add-on is installed manually and maintained in its own repository because the Omarchy marketplace requires one plugin per repository. It replaces the built-in clipboard overlay through Omarchy's supported clone routing and keeps the normal clipboard shortcut working.

Update

omarchy plugin update io.github.seangsr.omarchy-cleaner

Remove

omarchy plugin remove io.github.seangsr.omarchy-cleaner

Removal deletes the installed plugin files and its bar entry. It does not run cleanup or remove user data.

Cleanup boundaries

Safe Clean

Safe Clean asks once, then:

  1. Empties the current user's desktop trash.
  2. Deletes generated thumbnail previews under the user's cache directory.
  3. Applies the system's configured systemd-tmpfiles retention rules.
  4. Vacuums journal entries older than four weeks.
  5. Uses Omarchy's package-cache helper, which retains two package versions.

Deep Clean

Deep Clean requires a separate confirmation for every selected category. Orphan package names are shown before removal. Docker cleanup is restricted to stopped containers, dangling images, and builder cache; volumes are excluded. Clipboard cleanup atomically resets Omarchy's history file and removes only the image previews owned by that history. It does not alter the clipboard's currently selected content.

Security and limitations

Omarchy plugins execute as unsandboxed user code. Review the scripts before installation. Cleanup is inherently destructive after confirmation, and this project cannot guarantee that an orphaned package or cache has no value to a particular workflow. Maintain backups and read every review shown in the terminal.

Development

Validate the plugin with:

omarchy plugin validate .
bash -n scripts/*.sh
./scripts/scan.sh

License

MIT

About

Safe, review-first system cleanup widget for Omarchy Quattro

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages