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.
The OLP CLI allows you to do the following:
Create, retrieve, and manage catalogs and layers. In a typical use case, you can create a catalog, add a layer to this catalog, and later publish data to that layer.
Create, retrieve, and manage local catalogs and layers. In a typical use case, you can create a local catalog, add a layer to this catalog, or create a local copy of a catalog hosted on the platform.
Publish data to and retrieve data from catalogs. You can ingest test data from a file to a layer and later retrieve that data.
Retrieve and manage permissions of catalogs and schemas. You can get a list of catalogs that match some regular expression and update permissions on those catalogs.
Create, manage, and run pipelines. You can create a catalog that is usable for the Data Processing Library and run a compiler JAR package in a pipeline. Then, you can clean up all the previously created objects after execution.
Manage projects, project resources, and project access. You can group your HERE platform resources, including catalogs, schemas, and pipelines, in a project to enable access control for different stages of production.
Manage applications. You can manage applications and your application's access/API keys.
Work with HERE Location Services running on the HERE platform. You can look up location services and view the details of a specific service, including its base URL and detailed description.
Create and manage groups. You can set up the environment for a new project by creating a group, adding an app, and obtaining credentials.
Manage your credentials profiles. You can define multiple profiles to use different credentials for different projects.
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.
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.
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
olpfile to your
PATHenvironment variable and export it to the
.bash_profilefile, 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.batfile to your
Now the OLP CLI is installed. To access it from the command line, type:
The recommended way to install the OLP CLI in a CI/CD environment is through Maven, as follows:
Download and configure your repository credentials.
OLP_TOOLSenvironment variable that contains the path to where you want to download the OLP CLI:LinuxWindows
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%
Add the directory with the OLP CLI to your
cd %OLP_TOOLS% set PATH=%cd%;%PATH%
The newly updated
PATHvariable is only visible to all child processes.
Now OLP CLI is installed. To access it from the command line, type:
You can integrate the OLP CLI with your CI/CD environment using automation scripts. For more information, see Scripting Tips.
For the terms and conditions covering this documentation, see the HERE Documentation License.
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:
- Download and configure your repository credentials.
- Run the commands below. LinuxWindows
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.