Skip to content

Repository files navigation

Deco (Developer Compact)

Deco is a desktop-first cleanup app for developer machines, with a CLI for automation. Both use a native Rust engine in the desktop app and a parallel TypeScript implementation in the CLI today—see ROADMAP.md Milestone 2 for long-term contract alignment.

Goals: safe defaults (scan → review → quarantine-first cleanup → restore/purge), low learning curve, and broad dev-artifact coverage—not a general-purpose “every file” browser.

Role: convenient cleanup and space management first; on Windows, listed tool storage migration (Cursor, Chrome, …) is a reliable adjunct. Game data and arbitrary folders are manual — often via Windows Documents relocation or junction guides, not Deco automation.

Honest limits: There is no perfect solution for custom migration on Windows. Deco states what it commits to and what it does not — capabilities and limits · positioning.

v1.0 (shipped) — GA cleanup on Windows, macOS, and Linux. Windows tool storage migration remains a labeled Settings feature — see v1.0 roadmap.

v0.8.5 (Windows): Optional NTFS USN journal probe in Settings → Experimental adds informational scan warnings on drive-letter volumes; candidate discovery remains a full directory walk (details).

Demo

Scan Cleanup Settings
Scan demo Cleanup demo Settings demo

Full walkthrough: user guide. To refresh recordings (flows, window size, compression): readme-demos.md.

Recorded on Windows (SSD). Cleanup throughput depends on disk, tree size, and how many node_modules / build folders are selected—see batch delete.

Privacy & security

Deco is built for developers who need to trust what runs on their machine:

  • Local-first — scanning, classification, preview, quarantine, and cleanup run on your PC. File paths and sizes stay on disk; the engine does not upload your tree, file names, or scan results to any server.
  • Offline by default — normal use does not require a network connection. The only optional online step is Check for updates in Settings, which you trigger manually; it reads public GitHub Release metadata to compare versions and open download links.
  • Open and auditable — source is available in this repository. There are no hidden scripts, telemetry bundles, or bundled third-party “phone home” components in the desktop installer or CLI package.
  • Safety-first deletes — quarantine-first defaults, blocked system paths, and review-tier confirmations; see Safety model and PROJECT.md.

If you find a security issue, please report it via a private security advisory on GitHub. See SECURITY.md for supported versions and the full disclosure process.

Repository layout

Path Role
apps/cli Node/TypeScript CLI (deco binary via dist/cli.js)
apps/desktop Tauri shell + Rust backend
apps/frontend Vite + React UI served to the WebView
docs/ Documentation encyclopedia (getting started, product, CLI, distribution, milestones)

Quick start (Milestone 0 baseline)

Prerequisites: Node 20+, pnpm, Rust (for desktop/tests), WebView2 on Windows for the desktop UI.

pnpm install
pnpm test:all    # CLI (Vitest) + Rust engine (cargo test)

CLI

pnpm build:cli
pnpm dev:cli -- --dry-run --root . --max-depth 4 --no-size

Scan only (default dry-run in non-interactive mode): omit --delete. Deletion requires --delete --yes.

Desktop (development)

Uses the Tauri CLI from npm (pnpm -F @dendro-x0/deco-desktop tauri). Frontend dev server: http://localhost:5173 (configured in apps/desktop/src-tauri/tauri.conf.json).

pnpm dev:desktop

Desktop (release installer)

pnpm build:desktop

Artifacts (typical): apps/desktop/src-tauri/target/release/bundle/msi/, nsis/.

Rust tests (engine + commands)

cd apps/desktop/src-tauri && cargo test

Distribution

Install from GitHub Releases (tag v*): desktop installers for Windows, macOS, and Linux plus per-OS CLI zips. No npm token required for end users.

Artifact Use
.msi / NSIS .exe Desktop (Windows)
.dmg Desktop (macOS, aarch64 from CI)
.deb / .AppImage Desktop (Linux)
deco-cli-*-*.zip Portable CLI (deco.cmd / ./deco; requires Node 20+)

Full guide: docs/distribution/github-releases.md · Install: docs/getting-started/install.md

Documentation

docs/README.md — navigation hub (encyclopedia)

Category Entry
Getting started Overview · Install · Quickstart
Product Features · Status · Safety · 1.0 manifest
Desktop / CLI User guide · CLI usage
Distribution GitHub Releases · Release process
Contract Scan contract · Changelog
Development Contributing · CI
Milestones M0–M8 Index

Also: PROJECT.md · ROADMAP.md · CHANGELOG.md

CI

About

Archived experiment: desktop + CLI disk cleanup for developer machines (node_modules, caches). Windows listed-tool junction migration only—not a general folder mover or game save migrator. Last release: v1.1.0.

Topics

Resources

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages