search

trinhminhtriet / rmrfrs

🧹 rmrfrs is a powerful filesystem cleaning tool designed to optimize storage by identifying and removing unnecessary files within known project structures.
MIT License
48 stars 2 forks source link

Suggestion: Documentation improvements #4

Closed izelnakri closed 1 day ago

izelnakri commented 3 days ago

Hi there,

I recently had to clear up space in my hard drive after 4 years and come across your interesting project. One issue I have(even before daring to install/try out the software) is whether confirmation text and which files/folders will get deleted before they get deleted if I run these commands:

rmrfrs code/my_project code/my_project_2 # or even:
rmrfrs --older 3M

I think this issue must be indicated in the documentation whether files get deleted immediately or there is a prompt warning.

Maybe even a recovery system could be useful in case of wrong press of a button ;)

Thank you for working on & sharing a useful tool :)

trinhminhtriet commented 1 day ago

@izelnakri

Thanks for your suggestion. I updated the README with arg --help as below:

rmrfrs --help

rmrfrs recursively cleans project directories

Usage: rmrfrs [OPTIONS] [DIRS]...

Arguments:
  [DIRS]...  The directories to examine. Current directory will be used if DIRS is omitted

Options:
  -I, --ignored-dirs <IGNORED_DIRS>  Directories to ignore. Will also prevent recursive traversal within
  -q, --quiet...                     Quiet mode. Won't output to the terminal. -qq prevents all output
  -a, --all                          Clean all found projects without confirmation
  -L, --follow-symlinks              Follow symbolic links
  -s, --same-filesystem              Restrict directory traversal to the root filesystem
  -o, --older <OLDER>                Only directories with a file last modified n units of time ago will be looked at. Ex: 20d. Units are m: minutes, h: hours, d: days, w: weeks, M: months and y: years [default: 0d]
      --completions <GENERATOR>      Generates completions for the specified shell [possible values: bash, elvish, fish, powershell, zsh]
  -d, --default                      If there is no input, defaults to yes
  -h, --help                         Print help (see more with '--help')

I hope it's helpful to you. I will keep developing it better.

Regards, Triet.