Documentation Not Clear

[justinhandley]

Hi There - before I run this, I feel a bit nervous - what is the scope of running this? Is it in the directory you are in? Is it recursive? I need to replace a word potentially used in many places, but only in one folder and it's subdirectories - is that achievable?

Also, is it possible to do a 'file name only' replace, or will it always do words inside files as well as their names?

[beeman]

Hi, thanks for the issue! I agree the documentation is poor, very open to PR's :).

As a general tip, don't run any automated tool on a branch that's not clean, meaning if you have uncommitted changes. That way it's trivial to a) spot what changes are made and b) to revert them.

Also, there is a --dry flag that will show you what changes it will make.

It's currently only recursive and will always change content (not file name only option).

For quickly changing filenames for now you're probably better off by using Finder in macOS:

This brings up a popup for doing the renaming: