Checking The Installation – A Guide To Installing And Verifying Tartuf

You can install tartufo in the usual ways you would for a Python Package, or using docker to pull the latest tartufo docker image from Docker Hub.

Installation with pip:

pip install tartufo

Installation with docker:

docker pull godaddy/tartufo

If you would like to install the latest in-development version of tartufo, this can also be done with pip.

pip install -e git+ssh://git@github.com/godaddy/tartufo.git#egg=tartufo

Checking The Installation

When tartufo is installed, it inserts an eponymous command into your path. So if everything went well, the easiest way to verify your installation is to simply run that command:

Checking the pip installation:

tartufo --help

Checking the docker installation:

docker run godaddy/tartufo --help