Page Comparison

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.

...

...

• --rm tells Docker to not persist the container for later use

• --name specifies the name of the container

• --pull a newest version of image if available

• --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 specifies the environment variables with credentials. Docker image accepts following environment variables:
  

  • CM_ACCESS_TOKEN - user access token for authentification

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

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

...