Installation and configuration

There are two possible ways of installing CleverMaps Shell - locally and using Docker.

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

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.

To run Shell locally, your machine must have the Java Development Kit, version 8+ installed. To check if you have JDK installed, open Terminal or cmd.exe and run this command. 

If you receive a version number back - you have installed JDK already and you can skip to the next step.

Otherwise, we recommend to download Java Development Kit - JDK 11 from Oracle:

• https://www.oracle.com/java/technologies/javase-jdk11-downloads.html

Choose the installation file according to your platform, and follow the installation instructions. You can also opt for the open source version - OpenJDK.

After you have successfully installed JDK, download the Shell executable file from this page. Navigate to the folder where you've downloaded the Shell, and run it using a script distributed with the executable .jar file. The script must be located in the same folder as the .jar file.

Where <path> is the path to the folder where you've downloaded Shell to.

Alternatively, run it directly using the java command:

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

Configuration

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 again, and then you'll receive your access key.

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

Log in using credentials

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

Your credentials and config files will be stored in your home folder in the .cleverMaps directory.

Docker installation

To run Shell in Docker, your machine must have the Docker container platform installed and running. You can get Docker here.

This image runs the lightweight Alpine Linux and already contains the Java Development Kit. It's always distributed with the latest version of Shell.

Where:

• --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

If you've already pulled the image and Shell tells you that you're using an old version during startup, update it by using:

Usage tips

Shell Docker images are hosted in this DockerHub repository.

There are some useful tricks, which will make the work with Shell much easier:

• reverse command search - using the Ctrl+R shortcut, you are able to search through your command history (stored in spring-shell.log file in the Shell working directory - not available for Docker installation)
  • Ctrl+R → type "k5" → openProject --project k5t8mf2a80tay2ng
• command completion - using the Tab key, Shell will finish the command/parameter, or list all available commands/parameters
  • lo → Tab → login
  • li → Tab → listProjects, listDumps → listP → Tab → listProjects
• command history - by pressing the Up and Down arrow keys, you can navigate through the command history

To learn more about Shell and the platform - please complete the CleverMaps tutorials. Detailed command description of Shell commands can be found in the command list article.