Skip to content

sejoung/SystemScope

Repository files navigation

SystemScope Icon

SystemScope

An all-in-one system monitoring and cleanup tool for developers.
Monitor CPU, memory, GPU, and disk in real time, then move into disk analysis, Docker cleanup, and process management from one app.

English | 한국어

Download Page

Platform License Electron React CI Latest Release Release Date Downloads

Highlights

  • Real-time monitoring: CPU, memory, GPU, and disk metrics with live charts
  • Alerts: configurable disk / memory / GPU usage alerts
  • Disk analysis: folder scan, treemap, large files, extension breakdown, old file scan, recent growth, and duplicate detection
  • Quick cleanup: scan common cache, log, build, and temp locations
  • Docker management: inspect and clean up containers, images, volumes, and build cache
  • Process tools: search, inspect, and terminate processes
  • Port tools: inspect active ports and monitor specific ports/IPs
  • Application cleanup: uninstall installed apps, review leftover app data, and clean leftover uninstall registry entries on Windows
  • Growth tracking: snapshot-based folder growth analysis over 1 hour / 24 hours / 7 days
  • Update checks: packaged builds can check for new releases and open the download page
  • Localization: English / Korean UI
  • Tray resident UX: restore the app from the menu bar or system tray
  • Dark / light themes

For more detailed behavior, see docs/features.md.

Pages

Page Description
Overview Live gauges, charts, alerts, storage summary, top consumers
Storage Folder scan, treemap, large/old/duplicate file insights, recent growth, quick cleanup, file deletion
Docker Containers / images / volumes / build cache management
Activity Processes, ports, and live port watch
Applications Installed apps, related data cleanup, leftover data cleanup, Windows-only leftover registry cleanup
Preferences Theme, language, alert thresholds, snapshot interval, update check, app data/log paths

Getting Started

Requirements

  • Node.js
  • npm
  • macOS or Windows

Recommended:

  • Node.js 24+
  • docker CLI plus Docker Desktop or Docker Engine for Docker features
  • A standard Windows environment with reg.exe available for Windows app management
  • .nvmrc is included and pins the project to Node 24

Install and Run

# install dependencies
npm install

# development mode
npm run dev

# production build
npm run build

# preview built app
npm run preview

External Dependencies and Graceful Failure

Some features depend on OS tools or external commands.

  • Docker pages require the docker CLI and a running Docker daemon.
  • Disk size measurement prefers du on macOS/Linux and falls back to recursive scanning if unavailable.
  • APFS disk correction on macOS prefers diskutil and falls back to standard filesystem information.
  • Windows app discovery uses reg query.

Where possible, SystemScope degrades gracefully instead of failing hard when these commands are unavailable.

Packaging

npm run dist:mac    # macOS .dmg (Intel + Apple Silicon)
npm run dist:win    # Windows .exe

Testing

npm test            # unit/integration tests
npm run test:watch
npm run build
npm run test:e2e    # Electron + Playwright E2E (uses existing build)
npm run test:e2e:build
npm run test:e2e:debug
npm run check       # typecheck -> lint -> test -> build

E2E tests build the app first, then launch it through Playwright.

Release Flow

Recommended release flow:

npm run release:patch   # or release:minor / release:major
git push origin main
git push origin --tags

The release scripts run the full local validation flow first, then create the version commit and tag with npm version. Pushing a v* tag triggers the release workflow, which builds platform artifacts and creates a draft GitHub Release.

Project Structure

src/
  main/        Electron main process, IPC, services, system collection
  preload/     contextBridge API exposed to the renderer
  renderer/    React UI, pages, stores, components
  shared/      IPC channels, shared types, constants, contracts
tests/
  unit/        unit tests
  integration/ integration tests
  e2e/         Playwright-based Electron E2E tests

Tech Stack

Area Tech
Framework Electron 41, React 19
Language TypeScript
Build Vite / electron-vite
State Zustand
Charts Recharts
System info systeminformation
Settings electron-store
Testing Vitest, Playwright

Security Model

The renderer does not access Node APIs directly.

  • contextIsolation: true
  • sandbox: true
  • nodeIntegration: false
  • only explicit IPC APIs are exposed through contextBridge
  • deletion paths are constrained and items are moved to Trash instead of being hard-deleted

Platform Notes

  • SystemScope supports both macOS and Windows.
  • macOS includes APFS and unified-memory related corrections.
  • Windows includes platform-specific handling for Quick Scan, app uninstall flows, Explorer opening, and tray behavior.
  • Some system paths are intentionally restricted to open-only or trash-only flows for safety.

See docs/features.md for more platform-specific details.

Contributing

Issues and pull requests are welcome. Before opening a PR, please make sure the full validation flow passes:

npm run check

License

Apache License 2.0

About

See what your system is really doing

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages