Skip to content

jonathan-tipper/Sweep-Inspector

Repository files navigation

sweep

sweep is a safe, local-first folder inspection tool.

It helps you understand clutter in folders such as Downloads or Desktop without moving, renaming, copying, or deleting anything.

Install

Install the sweep command locally:

cargo install --path .

This installs the binary to:

~/.cargo/bin/sweep

If sweep is not found after installing, load Cargo's environment:

source "$HOME/.cargo/env"

Build without installing:

cargo build --release

The release binary is written to:

target/release/sweep

Usage

Inspect a folder:

sweep inspect ~/Downloads

Generate Markdown and JSON reports:

sweep inspect ~/Downloads --markdown ~/Desktop/downloads-report.md --json ~/Desktop/downloads-report.json

Find duplicate candidates:

sweep duplicates ~/Downloads
sweep duplicates ~/Downloads --hash

List large or old files:

sweep large ~/Downloads --over 500mb
sweep old ~/Downloads --older-than 90d

Summarise file types:

sweep types ~/Downloads

Safety

The MVP is read-only.

It does not:

  • move files
  • rename files
  • copy source files
  • delete files
  • follow symlinks by default
  • scan recursively by default
  • scan sensitive paths by default
  • make network calls

Every terminal and Markdown report ends with:

No files changed.

About

Simple Rust CLI that scans messy folders and produces a report.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages