Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. To install it locally, you have to:
    1. Install Java Development Kit - JDK
    2. Download Shell .jar file
    3. Run it in cmd.exe or Terminal
  2. To install using Docker:
    1. Download and install the Docker platform
    2. Pull the latest Shell image
    3. Run it in a Docker container

In both cases, you will need a CleverMaps account first. Sign up to CleverMaps using social login (Facebook, LinkedIn, Google) will not provide you the credentials that are used to log in to Shell. To create your own CleverMaps projects, you have to sign up using an email address and a password. Sign up here.

Local installation

CleverMaps Shell runs in Terminal on Unix systems (Linux, Mac OS) and in cmd.exe on Windows systems. If you're not familiar with these tools, we recommend to complete a basic usage tutorial on the web.



cd <path>

java -jar ./can-shell-1.34.0-RELEASE-exec.jar

Where the actual name of the jar (can-shell-1.34.0-RELEASE-exec.jar) may be different - depends on the version you've downladed.


After you have successfully started Shell, we recommend you to set up your config and credentials, so you don't have to enter them each time you log in.

You can log in using either credentials, or access token (recommended).

Log in using access token

First, log in to to application and on the Project page, hover your profile name and select Generate access token. You will be prompted to log in . To do thatagain, and then you'll receive your access key.

Image Added

Then run Shell and use the setup command to setup your access token.


setup --accessToken XbkadJ2ZcUd5_gRi5AjJoKwy3w6Jp5ctBacCCfhUbxQ

Log in using credentials


Please note that if you created a CleverMaps account using social login (Facebook, Google) you will not be able to use the same credentials you use for these services. In this case, you will have to generate an access token. See the previous section.

To log in using credentials, run Shell and use the setup command to setup your email and password.


setup --email --password SECRET_PW --dumpDirectory /home/john/CleverMaps


setup --email --password SECRET_PW --dumpDirectory C:\Users\john\CleverMaps


  • --rm tells Docker to not persist the container for later use
  • --name specifies the name of the container
  • --volume bind mounts a volume, where /tmp/dumps is the local directory the image will use, and /work is the path inside of the container
    • all dumped metadata and data will be located here (though Shell will indicate that the files were dumped to the /work directory)
    • you can specify whatever path you want, e.g.: C:\dumps on Windows
  • --env-file specifies the path to an environment variables file
    • in our case this is the credentials file with your email and password we've created in the Configuration section above
  • -ti allocates a terminal so you can directly interact with the container, and also keeps the standard input open
  • clevermaps/shell:latest is the name of the latest image