Skip to content
graentPublic

About

A lightweight, safe and ad-free PC cleaner. Junk cleanup, chat-app deep cleaning, driver cleanup, disk analysis and data migration — all transparent and under your control, chat history never touched.

Resources

Stars

88 stars

Watchers

0 watching

Forks

Repository files navigation

GrClean

An Electron application with Vue3 and TypeScript for Windows cleaning & optimization

electron-version electron-vite-version electron-builder-version vite-version vue-version typescript-version

Features

GrClean is a free, open-source Windows cleaning & optimization tool. It is built as a native Electron desktop client talking to a lightweight PHP backend for version/update and content delivery.

Core capabilities:

  • 🧹 Junk cleaning — system, browser and app caches, temp files, with safe default scope rules.
  • 💬 Social-app cleaner — WeChat / QQ / WeCom and more: clean cached images, files and temp data. Chat history is never touched (one of our hard promises).
  • 📦 Big-file analysis — find the largest files on each disk to reclaim space.
  • 👯 Duplicate finder — locate identical files by hash and remove the redundant copies.
  • 🚀 Startup manager — review and disable unwanted startup items.
  • 🗑 Uninstall residue — detect leftovers after software uninstallation.
  • 🧩 Registry cleaner — cautious, rule-based registry cleanup (heuristic, never over-aggressive).
  • 💿 Installer cleanup — remove orphaned installer/setup leftovers.
  • 📜 Log cleanup — trim OS and app logs that grow over time.
  • 💽 Disk & driver management — per-disk view, SMART health overview, driver inventory.
  • 🩺 Health score — a weighted PC health rating with clear, actionable advice.
  • 🔄 Migrate / move — relocate bulky folders to another drive.
  • ⚡ System optimize — one-click tweaks for a snappier system.
  • 🪶 Slim — strip optional Windows components you don't need.
  • 🕑 Scheduled tasks — browse and manage Windows Task Scheduler entries.
  • 🖱 Context-menu manager — add/remove right-click menu items.
  • ♻ Recycle-bin manager — list and clean recycle-bin items.
  • 🔧 Software uninstall — built-in uninstall with residual scan.
  • 📸 Snapshot — save/restore system state points.
  • 📋 Rules — customizable cleaning rules.
  • 🎨 8 themes and a global font-scale setting.
  • 🌐 9 built-in languages (zh-CN / en-US / zh-TW / ja / ko / fr / de / es / ru).

Screenshots

Overview (Home) — health score, system info and the 11-factor scoring breakdown:

GrClean overview — light theme GrClean overview — dark theme
薄荷青 · Light 暗夜青柠 · Dark

Themes

8 built-in themes with one-click switching (accents apply to the window chrome and controls only, default is 晴空蓝):

GrClean theme picker — 8 themes

The same view in a few more themes:

GrClean overview — sage theme GrClean overview — peach theme
鼠尾草 · Sage 蜜桃粉 · Peach

Tech Stack

  • Electron 28
  • Vue 3 + TypeScript 5
  • Vite 5 via electron-vite 2 (main / preload / renderer in one project)
  • electron-builder 24 (NSIS installer + portable build, Windows x64)
  • Lucide icons

Project Setup

Install

npm install

The postinstall script runs electron-builder install-app-deps. On Windows it also pulls the Electron binaries from the configured mirror (see .npmrc).

Development

npm run dev

Type checking

npm run typecheck

Build

# Windows installer + portable (unsigned)
npm run build:win

Build artifacts land in dist/ (git-ignored).

Code signing (Windows)

electron-builder.yml is pre-configured with signingHashAlgorithms: [sha256] and a DigiCert RFC3161 timestamp server. To produce a signed build you need an OV/EV code-signing certificate; supply it via one of:

  • win.certificateSubjectName / win.certificateSha1 (certificate store or EV token), or
  • CSC_LINK (+ CSC_KEY_PASSWORD) pointing to a .pfx.

Run npm run sign:check to verify the signing environment before building.

Project Structure

src/
  main/        Electron main process (engine/, ipc/, index.ts)
    engine/    Pure TS+Node scan/clean engines (streaming generators)
    ipc/       IPC handlers (scan-*:start streams + one-shot handles)
  preload/     Preload bridge (typed window.api, safe wrappers)
  renderer/    Vue 3 UI (views/, components/, stores/, assets/)
build/         App icons + macOS entitlements
resources/     Bundled assets (e.g. windows-trash helper)
scripts/       Build/release helpers (sign check, icon gen, font scaling)

Download & Links

Donate

If GrClean helped you out, you can buy the author a cup of milk tea 🧋. Donations are completely voluntary and never affect any feature.

Payment QR codes

WeChat Pay QR code Alipay QR code
微信收款码 · WeChat Pay 支付宝收款码 · Alipay

Community

Official WeChat account QR code QQ group QR code
微信公众号 · Official Account QQ 交流群 · QQ Group

License

GrClean is free to use for non-commercial purposes, including but not limited to personal use, educational use, and security research. Copyright © Graent. All rights reserved.

The following restrictions apply — by using or obtaining this software you agree to them:

  • 🚫 No commercialization — you may not use it for any commercial purpose, including but not limited to selling, reselling, bundling, or any other paid or commercial activity.
  • 🚫 No redistribution (secondary distribution prohibited) — you may not re-publish, mirror, or make it available through any other channel.
  • 🚫 No removal or tampering — you may not remove, obscure, or modify any copyright notice, author information, or integrity/verification information (including the embedded file-integrity checks) in the software or this repository.

For commercial licensing or any form of cooperation, please contact the author directly.

Suggestions and improvement ideas are always welcome — feel free to open an issue or reach out.

This project is distributed without a separate LICENSE file; the terms above constitute the license.

About

A lightweight, safe and ad-free PC cleaner. Junk cleanup, chat-app deep cleaning, driver cleanup, disk analysis and data migration — all transparent and under your control, chat history never touched.

Resources

Stars

88 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages