Installation

Dependencies

git-secret relies on two dependencies: git and gpg. Download and install them before using this project. git-secret is tested to work with:

git version 2.7.0
gpg (GnuPG) 1.4.20

Supported platforms

git-secret works with Mac OS X >= 10.9, Ubuntu >= 14.04, Debian >= 8.3, and Fedora / CentOS. You can check the full list here. You can add your platform to this list, if all the tests pass for you. Cygwin support is planned.

Installation process

There are several ways to install git-secret:


Homebrew

brew install git-secret


deb package

You can find the deb repository here. Pre-requirements: make sure you have installed apt-transport-https and ca-certificates

sudo sh -c "echo 'deb https://gitsecret.jfrog.io/artifactory/git-secret-deb git-secret main' >> /etc/apt/sources.list"
wget -qO - 'https://gitsecret.jfrog.io/artifactory/api/gpg/key/public' | sudo apt-key add -
sudo apt-get update && sudo apt-get install -y git-secret

# Testing, that it worked:
git secret --version


rpm package

You can find the rpm repository here.

wget https://raw.githubusercontent.com/sobolevn/git-secret/master/utils/rpm/git-secret.repo -O git-secret-rpm.repo
# Inspect what's inside! You can also enable `gpg` check on repo level.
sudo mv git-secret-rpm.repo /etc/yum.repos.d/
sudo yum install -y git-secret

# Testing, that it worked:
git secret --version


Alpine

You can find the apk repository here. See list of supported architectures here

sh -c "echo 'https://gitsecret.jfrog.io/artifactory/git-secret-apk/all/main'" >> /etc/apk/repositories
wget -O /etc/apk/keys/git-secret-apk.rsa.pub 'https://gitsecret.jfrog.io/artifactory/api/security/keypair/public/repositories/git-secret-apk'
apk add --update --no-cache git-secret

# Testing, that it worked:
git secret --version


Arch Linux

The Arch way to install git-secret is to use the directions for “Installing Packages” at Arch User Repository Documentation along with the PKGBUILD file from the git-secret Arch Linux Package

You can also install from the AUR using your helper of choice by installing the package git-secret, for example using yay

yay -S git-secret

Manual

git clone https://github.com/sobolevn/git-secret.git git-secret
cd git-secret && make build
PREFIX="/usr/local" make install

Note that you can install to any prefix in your PATH