Get Started

The OLP CLI allows you to access platform services from the command line. As opposed to the HERE platform portal graphic user interface, the OLP CLI offers a text-based interface and enables developers to implement automated actions on Platform services.

Table of Contents

Why Use the OLP CLI

The OLP CLI allows you to do the following:

System Requirements

The following operating systems are supported:

  • Windows 10
  • Linux (Ubuntu 16.04)
  • macOS Sierra or higher

The OLP CLI requires the Java Runtime Environment (JRE) version 1.8.0_91 or above.

Note: JRE Version

To determine the version installed on your machine, run the java -version command in a terminal window.

Use OLP CLI Installer

The installer is the recommended solution for Windows users. You can download the OLP CLI from the platform portal.

The installer takes care of setting up the PATH environment and informs you about a new version if you rerun the installer.

Use OLP CLI ZIP Archive

You can download the OLP CLI from the platform portal.

To make the OLP CLI accessible from the command line:

  • On Linux, add the full path to the folder with the olp file to your PATH environment variable and export it to the .bash_profile file, which is a hidden file that contains configurations scripts and environment variables, that runs when bash is invoked.
  • On Windows, add the full path to the folder with the olp.bat file to your PATH environment variable.

Now the OLP CLI is installed. To access it from the command line, type: olp [command].

Install the OLP CLI in Your CI/CD Environment

The recommended way to install the OLP CLI in a CI/CD environment is through Maven, as follows:

  1. Download and configure your repository credentials.

  2. Create an OLP_TOOLS environment variable that contains the path to where you want to download the OLP CLI:

    Linux
    Windows
    OLP_TOOLS=user/olp_tools
       mvn dependency:unpack -Dartifact=com.here.platform:cli_2.12:LATEST:zip -DoutputDirectory=$OLP_TOOLS
    set OLP_TOOLS=C:/user/olp_tools
       mvn dependency:unpack -Dartifact=com.here.platform:cli_2.12:LATEST:zip -DoutputDirectory=%OLP_TOOLS%

    Run the following commands if you want to install the OLP CLI less than or equal to the 9.3.9 version:

    Linux
    Windows
    OLP_TOOLS=user/olp_tools
       mvn dependency:unpack -Dartifact=com.here.platform:cli:LATEST:zip -DoutputDirectory=$OLP_TOOLS
    set OLP_TOOLS=C:/user/olp_tools
       mvn dependency:unpack -Dartifact=com.here.platform:cli:LATEST:zip -DoutputDirectory=%OLP_TOOLS%
  3. Add the directory with the OLP CLI to your PATH variable:

    Linux
    Windows
    export PATH="$PATH:$OLP_TOOLS"
    cd %OLP_TOOLS%
       set PATH=%cd%;%PATH%

    The newly updated PATH variable is only visible to all child processes.

Now OLP CLI is installed. To access it from the command line, type: olp [command].

You can integrate the OLP CLI with your CI/CD environment using automation scripts. For more information, see Scripting Tips.

Install an Older Version of the OLP CLI

We recommend to always use the latest version of the OLP CLI to stay up to date with the most recent HERE platform features. However, if, for some reason, you need an older version of the OLP CLI, use Maven to download it, as follows:

  1. Download and configure your repository credentials.
  2. Run the commands below. The OLP_CLI_VERSION parameter must be greater than the 9.3.9 version.

    Linux
    Windows
    OLP_CLI_DIR=<path/to/directory>
       OLP_CLI_VERSION=<desired-cli-version>
       mvn dependency:unpack -Dartifact=com.here.platform:cli_2.12:$OLP_CLI_VERSION:zip -DoutputDirectory=$OLP_CLI_DIR -Dmdep.overWriteReleases=true
    set OLP_CLI_DIR=<path/to/directory>
       set OLP_CLI_VERSION=<desired-cli-version>
       mvn dependency:unpack -Dartifact=com.here.platform:cli_2.12:%OLP_CLI_VERSION%:zip -DoutputDirectory=%OLP_CLI_DIR% -Dmdep.overWriteReleases=true

    Run the following command if you want to install the OLP CLI less than or equal to the 9.3.9 version:

    Linux
    Windows
    OLP_CLI_DIR=<path/to/directory>
       OLP_CLI_VERSION=<desired-cli-version>
       mvn dependency:unpack -Dartifact=com.here.platform:cli:$OLP_CLI_VERSION:zip -DoutputDirectory=$OLP_CLI_DIR -Dmdep.overWriteReleases=true
    set OLP_CLI_DIR=<path/to/directory>
       set OLP_CLI_VERSION=<desired-cli-version>
       mvn dependency:unpack -Dartifact=com.here.platform:cli:%OLP_CLI_VERSION%:zip -DoutputDirectory=%OLP_CLI_DIR% -Dmdep.overWriteReleases=true

    For the list of released CLI versions, see the docs.

results matching ""

    No results matching ""