Marown/git-filter-repo
1
0
Fork 0
mirror of https://github.com/newren/git-filter-repo.git synced 2024-07-06 02:12:17 +02:00
Code Issues Packages Projects Releases Wiki Activity
31f00a9ff8
git-filter-repo/INSTALL.md
Elijah Newren 423b7d2c89 INSTALL: streamline a bit and guide folks to package managers 
Now that several package managers are packaging filter-repo (Debian and
Ubuntu seem to be the primary holdouts, but maybe treating Linux as
"covered" will pressure them to package it too), guide people to use
package managers for easy installation and streamline the wording.
Still keep the old instructions around, just move them later.

Signed-off-by: Elijah Newren <newren@gmail.com>
2020-05-18 09:25:11 -07:00

2.6 KiB
Raw Blame History

Installation via Package Manager

Installation is as easy as

$ PACKAGE_TOOL install git-filter-repo

for those using one of the following package managers to install software on their system:

Packaging status

This list covers at least Windows (Scoop), Mac OS X (Homebrew), and Linux (most the rest). Note that I do not curate this list (and have no interest in doing so); https://repology.org tracks who packages these versions.

Manual Installation

filter-repo only consists of a few files that need to be installed:

  • git-filter-repo

    This can be installed in the directory pointed to by git --exec-path, or placed anywhere in $PATH. This is the only thing needed for basic use.

    If your python3 executable is named "python" instead of "python3" (this particularly appears to affect a number of Windows users), then you'll also need to modify the first line of git-filter-repo to replace "python3" with "python".

  • git_filter_repo.py

    If you want to make use of one of the scripts in contrib/filter-repo-demos/, or want to write your own script making use of filter-repo as a python library, then you need to have a symlink to (or copy of) git-filter-repo named git_filter_repo.py in $PYTHONPATH.

  • git-filter-repo.1

    If you want git filter-repo --help to display the manpage, this needs to be copied into $MANDIR/man1/ where $MANDIR is some entry from $MANPATH. (Note that git filter-repo -h will show a more limited built-in set of instructions regardless of whether the manpage is installed.)

  • git-filter-repo.html

    The manpage is good enough for me and my systems, but an html-formatted version of the same page is provided for those who prefer it. Place it where ever you like; I have no idea where such a thing should go.

Installation via pip

For those who prefer to install python packages via pip, you merely need to run:

$ pip3 install git-filter-repo

Installation via Makefile

Installing should be doable by hand, but a Makefile is provided for those that prefer it. However, usage of the Makefile really requires overridding at least a couple of the directories with sane values, e.g.

$ make prefix=/usr pythondir=/usr/lib64/python3.8/site-packages install

Also, the Makefile will not edit the shebang line (the first line) of git-filter-repo if your python executable is not named "python3"; you'll still need to do that yourself.