Skip to content

Installation

This guide shows how to install the git-system-follower CLI. git-system-follower can be installed either source, or from pre-built python package.

git-system-follower is python package, you can install it with any python package manager.

Note

git-system-follower only supports Linux, it can run on Windows or macOS, but officially Windows and macOS are not supported

From PyPI

If you prefer to use git-system-follower as a standalone CLI tool instead of integrating its functionality into your Python packages, uv tool is the recommended installation method.

For more details, see the uv tool documentation.

Recommended: By uv

Before proceeding, make sure uv is installed. See the uv installation guide

Then, install git-system-follower with: 

uv tool install qubership-git-system-follower

However, you may want to install git-system-follower as a python package so that you can, for example, use it inside your own python packages

You can also do this with uv: 

# create & activate virtual env
uv venv .venv && source .venv/bin/activate

# install git-system-follower
uv pip install qubership-git-system-follower

However, if uv is not a suitable option, use pip instead.

Standard: By pip 
# create & activate virtual env
python -m venv .venv && source .venv/bin/activate 

# Install git-system-follower
pip install qubership-git-system-follower

From Source

Building git-system-follower from source is slightly more work

# create & activate virtual env
python -m venv .venv && source .venv/bin/activate

# Clone git repository
git clone https://github.com/Netcracker/qubership-git-system-follower.git

# Install git-system-follower
pip install -e qubership-git-system-follower/

Additional git-system-follower configuration

Enabling shell autocompletion

git-system-follower supports command autocompletion in Bash, Zsh, and Fish, which will save you a lot of time when typing commands.

Enter into the virtual environment where you have git-system-follower installed. If you used uv tool install to install, you do not need to enter in anywhere, git-system-follower commands are available in your system

  1. Generate and save script:
    Save the script somewhere: 

    _GSF_COMPLETE=bash_source gsf > ~/.gsf-complete.bash

    Source the file in ~/.bashrc: 

    . ~/.gsf-complete.bash

  2. Via eval:
    However, there is another way, via eval. Add this to ~/.bashrc: 

    eval "$(_GSF_COMPLETE=bash_source gsf)"

    Warning

    Using eval means that the command is invoked and evaluated every time a shell is started, which can delay shell responsiveness. To speed it up, write the generated script to a file, then source that (1st option)

  1. Generate and save script:
    Save the script somewhere: 

    _GSF_COMPLETE=zsh_source gsf > ~/.gsf-complete.zsh

    Source the file in ~/.zshrc: 

    . ~/.gsf-complete.zsh

  2. Via eval:
    However, there is another way, via eval. Add this to ~/.zshrc: 

    eval "$(_GSF_COMPLETE=zsh_source gsf)"

    Warning

    Using eval means that the command is invoked and evaluated every time a shell is started, which can delay shell responsiveness. To speed it up, write the generated script to a file, then source that (1st option)

  1. Via completions file:
    Save the script to ~/.config/fish/completions/gsf.fish: 

    _GSF_COMPLETE=fish_source gsf > ~/.config/fish/completions/gsf.fish

  2. Via source command:
    However, there is another way. Add this to ~/.config/fish/completions/gsf.fish: 

    _GSF_COMPLETE=fish_source gsf | source
    This is the same file used for the activation script method above. For Fish it’s probably always easier to use that method.

Note

For autocompletion, git-system-follower uses the built-in functionality of the click library