ayoisaiah / f2

F2 is a cross-platform command-line tool for batch renaming files and directories quickly and safely. Written in Go!
https://f2.freshman.tech
MIT License
866 stars 38 forks source link

try/demo/dryrun command line argument #68

Closed hgkamath closed 6 months ago

hgkamath commented 6 months ago

Firstly, thank you to the developer(s) of open-source tool f2

Describe your feature request

It's helpful to have a --try / --test / --demo / --dryrun / --setdryrun=on command line argument, that enables a dryrun mode. In dryrun mode the command f2 just executes in a way so as to not do any actual rename operation but only prints the output that shows what the command would do if it were running for real.

hgkamath commented 6 months ago

I was reading the wiki again, and maybe I misunderstood.
I was very hesitant to try running the f2 command when I filed the issue.

It says that argument -x is to "Commit the renaming operation to the filesystem." link. So now what I understand is that the default mode of f2 without giving the -x argument is to do a dry-run. After this execution, if one is happy with the indicated changes then one may run the command again with the -x argument to really effect the renaming operations to the filesystem.

Perhaps, this should be clearly articulated up-near-the top in the github-README, wiki and/or in the output of the --help command line argument.

If so, then this issue may be closed, as already resolved.

hgkamath commented 6 months ago

closing the issue