clevermaps/shell repository overview

⁠Overview

CleverMaps Shell is a command line interface tool designed for the management of the CleverMaps.io⁠ platform. It allows you to create and manage various aspects of a CleverMaps project, primarily its data and metadata.

⁠Run a Docker image

To start a Docker image of CleverMaps shell use docker run on Linux:

docker run --rm --name cm-shell --volume /tmp/dumps:/work:z --env CM_ACCESS_TOKEN=8HZP...WE -ti clevermaps/shell:latest

or docker run on Windows:

docker run --rm --name cm-shell --volume C:\dumps:/work:z --env CM_ACCESS_TOKEN=8HZP...WE -ti clevermaps/shell:latest

⁠Parameters

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

⁠CleverMaps Shell Documentation

See CleverMaps Developer Documentation⁠ for a complete quide how to run and use CleverMaps Shell.