Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 3.03 KB

README.md

File metadata and controls

75 lines (52 loc) · 3.03 KB

rmstale

Build Chocolatey codecov Quality Gate Status

rmstale is a tool to remove stale files recursively below a given directory.
Files and folders older than a defined period are removed.

Some examples for use:

  • Set on a schedule to clear old files from your temporary directories.
  • Set on a schedule to remove downloaded files from your downloads directory.

Install instructions

Install with Chocolatey

choco install rmstale

Install with Winget

winget install danstis.rmstale

Install rmstale manually

  1. From the GitHub releases page download the latest binary for your operating system.
  2. Place the downloaded file into your desired location.

Usage instructions

Command line flags

Flag Description
-a, --age Period in days before an item is considered stale
-d, --dry-run Runs the process in dry-run mode, no files will be removed.
-e, --extension Filter files for a defined file extension
-p, --path Path to a folder to process
-v, --version Displays the version of rmstale that is currently running
-y, --confirm Allows for processing without confirmation prompt, useful for scheduling

Usage examples

>: rmstale --version

rmstale v1.6.0
>: rmstale --age 14 --path c:\temp
WARNING: Will remove files and folders recursively below 'c:\temp' older than 14 days. Continue?: y

-Removing 'C:\Temp\amc2E40.tmp.LOG1'...
-Removing 'C:\Temp\amc2E40.tmp.LOG2'...
-Removing 'C:\Temp\amc306D.tmp.LOG1'...
-Removing 'C:\Temp\amc306D.tmp.LOG2'...
-Removing 'C:\Temp\amc308D.tmp.LOG1'...

GitHub project

Feedback, Issues, Bugs and Contribution to this tool are welcome.
For Bugs/Issues/Feature requests, please create an issue on the GitHub issues page.

Want to contribute? Great:

  • Fork the repo using the Fork button at the top right of the GitHub repo.
  • Clone the repo to your development machine, note the dependencies for this project are as follows:
    • Go version 1.19 or above
  • Create a new branch for the feature that you want to contribute.
  • Develop your new feature as you see fit.
  • Once you have a working copy of your code, create a pull request against this project.