...
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 |
|
If you receive a version number back - you have installed JDK already and you can skip to the next step.
...
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.5.3-RELEASE-exec.jar) may be different - depends on the version you've downloaded.
...
Then run Shell and use the setup command to setup your access token.
Linux/Mac/Windows |
|
Your credentials and config files will be stored in your home folder in the .cleverMaps directory.
| Info |
|---|
Are you connecting through a proxy server? Set your proxy config using: |
Log in using credentials (deprecated)
| Info |
|---|
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.
...
Linux/Mac
...
setup --email john@example.com --password SECRET_PW --dumpDirectory /home/john/CleverMaps
...
Windows
...
setup --email john@example.com --password SECRET_PW --dumpDirectory C:\Users\john\CleverMaps
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.
Linux/Mac |
|
Windows |
|
Where:
--rmtells Docker to not persist the container for later use--namespecifies the name of the container--pulla newest version of image if available--volumebind mounts a volume, where/tmp/dumpsis the local directory the image will use, and/workis the path inside of the containerall dumped metadata and data will be located here (though Shell will indicate that the files were dumped to the
/workdirectory)you can specify whatever path you want, e.g.:
C:\dumpson Windows
--envspecifies the environment variables with credentials. Docker image accepts following environment variables:CM_ACCESS_TOKEN- user access token for authentificationauthenticationAWS_ACCESS_KEY_ID- AWS access key (required only for loading CSV files from AWS S3)AWS_SECRET_ACCESS_KEY- AWS secret key (required only for loading CSV files from AWS S3)
-tiallocates a terminal so you can directly interact with the container, and also keeps the standard input openclevermaps/shell:latestis the name of the latest image
| Info |
|---|
Info for Linux/Mac OSDepending on your Docker system configuration, you may be required to preface the In that case, all files saved to the directory you specified in |
...