You may obtain an offline copy of this guide from our package server. You can also build the documentation yourself.

Installing

To obtain git-teleport, clone this repository to any directory you own.

cd ~   # or another suitable location
git clone -b master https://gitlab.com/git-teleport/git-teleport.git

Alternatively, you may also download a git-teleport tarball from our releases page.

Add git-teleport to your $PATH by running:

cd git-teleport
./bin/git-teleport setup --path

This will add git-teleport to your ~/.bashrc file.

If you prefer to do this manually, add a line like the following to ~/.bashrc or a file that is sourced by it, such as ~/.bash_aliases:

PATH="${PATH}:$HOME/git-teleport/bin"

Either way, this change will take effect for the next shell you start. Run

source ~/.bashrc

to make it take effect immediately for the current shell.

If you can run

git teleport

then you are all set!

System Requirements

git-teleport is portable to most operating systems which have Git and bash installed. It runs out of your home directory; no special privileges or compilers are required. We recommend:

  • git >= 1.8.3
  • bash >= 4.2

which should be satisfied by most distributions which are CentOS 7 and newer.

Linux

  • Some very minimal installations, like containers, are missing binaries for find and cmp. These are usually available as packages named findutils and diffutils. Most desktops will have these programs installed.

  • If your /home directory is mounted with the noexec option, you will need to find somewhere else to install git-teleport.

Windows

  • git-teleport is tested against the current version of Git for Windows in Chocolatey. You must run git-teleport commands from the "Git Bash" prompt.

Building Documentation

HTML-formatted documentation may be built by running

mdbook build

from the repository root. Your workstation must have mdbook installed. Documentation will be output to share/git-teleport/html by default.

Running the Unit Tests

To verify that git-teleport will function correctly on your system, you may run

./test/run.sh

to run the unit tests.

If any test fails, and you are sure your system meets the above dependencies, please submit a bug report on Gitlab.