Skip to content

MacOS installer tutorial

There are two ways to interact with the PEP system:

  • PEP Command Line Interface is an application which contains a command line interface (CLI) utility (pepcli), which can interact with the PEP system. With pepcli you can download and upload your data.
  • PEP Assessor is a Graphical User Interface (GUI) application that assessors use to upload data to the PEP system. With this application you cannot download data, and is thus only used by assessors.

The MacOS installer contains both applications, however, you can choose which one to install on your system. The details on how to install PEP on your local machine are described in this document.

Download the installer

  1. Download the right installer. There are different kinds of installers, depending on the project and environment, a table with the installers can be found on the main installation page.

  2. After the download is finished, click on 'Downloads' in the dock:

    Downloads

  3. This will open up the downloads stack, which should contain the downloaded PEPInstaller.pkg.zip. Click on the file to unzip it:

    Unzip

  4. This will create the file PEPInstaller.pkg. Double click on this file to start the installation:

    Start Installation

The installation

  1. The installation is performed through a Wizard with several steps. Each time, click on 'Continue' to proceed to the next step. If you choose another location to install PEP, make sure that you are allowed to run self-hosted software from that location.

    Installer Wizard

  2. In the next step you can choose whether to install PEP Assessor or pepcli. You can also choose to install both. Click on 'Continue' to proceed to the next step:

    Choose Installation

  3. The final step is to install the software. Click on 'Install' to install PEP on your system:

    Install

  4. This will ask for your password to install the software. Enter your credentials to continue.

    Password

  5. After this the installation is finished. You can close the installer, and move the installer to the trash bin:

    Finish \ Move to trash

Now PEP Command Line Interface and/or PEP Assessor are installed on your system. You can drag the applications to your dock for easy access.

Upgrading to a new version

Everytime you start up PEP Assessor or PEP Command Line Interface, it will check whether a new version is available. If this is the case, pepcli will ask you whether you want to install the update, and in PEP Assessor the screen colour changes and an 'Update/Bijwerken' button appears:

Update

Click on the button 'Update/Bijwerken' to update the software. The application will automatically restart after the update.

Scripting with pepcli

The PEP Command Line Interface application consists of the pepcli binary, wrapped in a shell script, which adds pepcli to your PATH variable for each session. To conveniently use the pepcli binary and/or pepLogon from outside of PEP Command Line Interface, add the binary to your .zshrc (for Z shell, MacOS default) or .bashrc (for Bash) file:

echo "export PATH=\$PATH:'/Applications/PEP Command Line Interface.app/Contents/MacOS'" >> ~/.zshrc

where /Applications/PEP Command Line Interface.app should be replaced with the actual path to your installed PEP Command Line Interface application. After adding this line to your .zshrc or .bashrc file, you can use the pepcli and pepLogon commands from the terminal and/or shell scripts.

See the PEP Command Line Interface documentation for more information on how to use pepcli.

Uninstall

To uninstall any PEP Application, just drag the application to the trash bin. This will remove the application from your system.