Version: 1.3.14

Install Toolkit and view example reports

Follow the instructions below to learn how to install Certifai Toolkit and view the example reports in a local Console instance.


You have accepted the license agreement and downloaded the Toolkit .zip file to your local system.

Tutorial instructions

  1. Open a terminal window and set your context to the download location your Toolkit. (If you downloaded to your Download folder, you should move it. In the following example the is at the user-root mscott.)

    cd mscott
  2. Create a directory to work in. (e.g. certifai)

    mkdir certifai
  3. Unzip the into that directory.

    unzip -d certifai
  4. Set your context to inside the folder where the Toolkit was unzipped.

    cd certifai

    The contents of the Toolkit are described here.

  5. Create a virtual environment in which to run the Certifai CLI. See Toolkit prerequisites for the versions of python you can use.

    conda create -n certifai python=3.6
  6. Activate the newly created Certifai CLI environment.

    conda activate certifai
  7. Install the Certifai component packages. (This may take a couple of minutes to run.)

    pip install packages/all/*
  8. Install the CERTIFAI packages specific to your Python version. You should replace the python3.6 in the below command with the Python version you are using.

    pip install packages/python3.6/*
  9. Verify that the Certifai CLI and client libraries are installed successfully.

    certifai -h

    NOTE: A usage statement is displayed if the Certifai CLI has been installed successfully.

  10. Startup your console and point to the example reports that are provided in the

    certifai console examples/reports
  11. The Console is available at: http://localhost:8000. Copy this URL into a browser to view your scan result visualizations.

Learn more about navigating through the Console pages.