@ -44,40 +44,44 @@ filter-repo requires:
# How do I install it?
git-filter-repo is a single-file python script, which was done to make
installation for basic use on many systems trivial: just place the
script into your $PATH.
` git-filter-repo` is a single-file python script, which was done to make
installation for basic use on many systems trivial: just place that
file into your $PATH.
See [INSTALL.md ](INSTALL.md ) for things beyond basic usage or special
cases. The more involved instructions are only needed if you
* are working with a python3 executable named something other than "python3"
* want to install documentation (beyond the builtin docs shown with -h)
* want to run some of the [contrib ](contrib/filter-repo-demos/ ) examples
* want to create your own python filtering scripts using filter-repo as a
module/library
cases. The more involved instructions are only needed if one of the
following apply:
* you do not find the above comment about trivial installation intuitively
obvious
* you are working with a python3 executable named something other than
"python3"
* you want to install documentation (beyond the builtin docs shown with -h)
* you want to run some of the [contrib ](contrib/filter-repo-demos/ ) examples
* you want to create your own python filtering scripts using filter-repo as
a module/library
# How do I use it?
See the [user
manual](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html).
For comprehensive documentation:
* see the [user manual ](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html )
* alternative formating of the user manual is available on various
external sites
([example](https://www.mankier.com/1/git-filter-repo)), for those
that don't like the htmlpreview.github.io layout, though it may
only be up-to-date as of the latest release
If you prefer learning from examples:
* the [simple example ](#simple-example-with-comparisons ) below may
be of interest
* the user manual has an extensive [examples
section](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html#EXAMPLES)
* there is a [cheat sheet for converting filter-branch
commands](Documentation/converting-from-filter-branch.md#cheat-sheet-conversion-of-examples-from-the-filter-branch-manpage),
which covers every example from the filter-branch manual
* there is a [cheat sheet for converting BFG Repo Cleaner
commands](Documentation/converting-from-bfg-repo-cleaner.md#cheat-sheet-conversion-of-examples-from-bfg),
which covers every example from the BFG website
External sites also have [alternative formats of the user
manual](https://www.mankier.com/1/git-filter-repo) available, at least
for the most recent release. This also may be beneficial if
htmlpreview.github.io starts hitting load limits.
* the [simple example ](#simple-example-with-comparisons ) below may
be of interest
* the user manual has an extensive [examples
section](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html#EXAMPLES)
# Why filter-repo instead of other alternatives?