There are two possible ways of installing CleverMaps Shell - locally and using Docker.
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. |
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.
We've encountered character encoding problems on Windows 7. It is recommended to use Windows 8 or higher. |
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.
Linux/Mac/Windows |
java -version |
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:
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.
Linux/Mac | Windows |
|
|
Where <path>
is the path to the folder where you've downloaded Shell to.
Alternatively, run it directly using the java
command:
Linux/Mac/Windows |
|
Where the actual name of the jar (can-shell-1.3.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.
To do that, run Shell and use the setup
command.
Linux/Mac |
|
Windows |
|
Your credentials and config files will be stored in your home folder in the .cleverMaps
directory.
Are you connecting through a proxy server? Set your proxy config using: |
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.
Linux/Mac |
|
Windows |
|
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/work
directory)C:\dumps
on Windows--env-file
specifies the path to an environment variables file-ti
allocates a terminal so you can directly interact with the container, and also keeps the standard input openclevermaps/shell:latest
is the name of the latest imageDepending on your Docker system configuration, you may be required to preface the In that case, all files saved to the directory you specified in |
If you've already pulled the image and Shell tells you that you're using an old version during startup, update it by using:
Linux/Mac/Windows |
|
Shell Docker images are hosted in this DockerHub repository.
There are some useful tricks, which will make the work with Shell much easier:
openProject --project k5t8mf2a80tay2ng
lo
→ Tab → login
li
→ Tab → listProjects
, listDumps
→ listP
→ Tab → listProjects
Having trouble with installation or configuration of CleverMaps Shell? Don't hesitate to contact us at support@clevermaps.io. |
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.