HERE CLI is a Node.js command-line interface to work with HERE APIs starting with HERE XYZ Hub APIs. Right now, it allows you to interact with HERE XYZ Hub to create and manage your Spaces, and easily upload and manage your datasets.
HERE CLI is built on Node.js, a cross-platform efficient language to write even complex, local applications.
To use the HERE CLI, you should have npm installed. The best way is to go to nodejs.org and install the appropriate package for your system (both 8.x LTS and 10.x Current should work). If you need help with this have a look at our CLI Introduction Guide.
Installing the CLI
To install the HERE CLI use the following command. Depending on your system, you might need elevated permissions (like sudo) to install globally.
npm install -g @here/cli
If all goes well, you can check if the CLI is installed correctly by just runnning
Configure HERE CLI
As the HERE CLI works with HERE APIs in the cloud, you need to configure your developer identity.
This only needs to be done once. Just run
here configure set to set the
For detailed information on getting a Developer account have a look at our Getting Started Guide.
The CLI currently support the following sub-commands:
- configure|c [set|verify|account] setup configuration for authentication - xyz|xs [list|create|upload] work with xyz spaces - transform|tf [csv2geo|shp2geo] convert from csv/shapefile to geojson - help [cmd] display help for [cmd]
Building the CLI
To develop the CLI further and add new features, first clone this repository and install the npm dependencies.
git clone https://github.com/heremaps/here-cli.git npm install
Normally as a user you would install the CLI with a
-g switch globally so that it can be
used outside of a package directory. To make development easier it makes more sense not to
that globally as that requires elevated permissions.
You should test and debug the commands by running the respective .js file. We use
npm commander to drive the command parsing and
execution. To get a good
understanding how it feels on the commandline use local linking to make the
available as executable commands:
Finally to package and distribute a new release (which we would do, not you) we update and tag the version followed by
npm pack ... npm deploy ...
When you add a new sub-command (as
bin/here-commandname.js) please make sure to also include the relevant documentation (as
If the command is interacting with a HERE service, please include a links to the relevant service documenation at developer.here.com.
Copyright (C) 2018 HERE Europe B.V.
This project is licensed under the MIT License - see the LICENSE file for details