Skip to content
docs / projects / sweep / cli reference

Sweep CLI

Every command, argument and output field, in one place.

activereferencesource ↗

Synopsis

usageshell
sweep <command> <directory>

Commands

sweep preview <directory> scans and classifies the files, calculates their destinations, and reports the planned organization. It does not move files.

sweep run <directory> performs the organization. It creates category directories as needed and moves files to their calculated destinations.

BehaviorPreviewRun
scans and classifies filesyesyes
reports calculated destinationsyesyes
creates category directoriesnoyes
moves filesnoyes
move-time conflict checknoyes
reports moved and skipped countsnoyes

Arguments

directory is required. It is the directory to organize. User-home notation such as ~ is expanded. The path must exist and be a directory. Only files directly inside it are considered; subdirectories are ignored.

Note

The guide documents no flags. Options get their own table here once they exist.

Output

For each file, Sweep prints:

FieldValue
namefile name
categoryImages, Documents, Archives or Other
suffixlowercased final suffix
sizefile size
destinationcalculated target path

After the files it prints a summary:

FieldPrinted by
totalspreview and run
category countspreview and run
movedrun only
skippedrun only