Command list

CleverMaps Shell is controlled solely by a set of predefined commands. These commands can be divided in 4 categories, or workflow states. All commands and parameters are case sensitive.

Each command can be further specified by parameters, which can have default values. Each parameter also has a "--" prefix, which is a technicality, and is not mentioned in the tables below, for the sake of readability.

Parameters with string type take string input as a value, if they are mentioned. Parameters with enum type have predefined enumeration of strings, which can be passed as a value. Parameters with boolean type can be passed either true, false or no value (=true).

Workflow states

  • Started - you have started the tool
  • Connected to server - you have successfully logged in to your account on a specific server
  • Opened project - you have opened a project you have access to
  • Opened dump - you have created a new dump, or opened an existing one

_create

_

Started state

login


Log in as a user to CleverMaps with correct credentials.

Parameter nameTypeOptionalityDescriptionConstraints

email

string
OPTIONAL
your email accountstored in credentials file
passwordstring
OPTIONAL
your passwordstored in credentials file
accessTokenstringOPTIONAL

generated CleverMaps access token

(see how to get one)

stored in config file
bearerTokenstringOPTIONALJWT token generated after signing with limited 1h validity
dumpDirectorystringOPTIONALdirectory where your dumps will be storedstored in config file
serverstring
OPTIONAL

server to connect to

default = https://secure.clevermaps.io

stored in config file
proxyHoststringOPTIONAL

proxy server hostname

stored in config file
proxyPortintegerOPTIONALproxy server portstored in config file
s3AccessKeyIdstringOPTIONAL

AWS S3 Access Key ID

required for S3 upload (loadCsv --s3Uri)

stored in config file
s3SecretAccessKeystringOPTIONAL

AWS S3 Secret Access Key

required for S3 upload (loadCsv --s3Uri)

stored in config file

setup

Store your config and credentials in a file so you don't have to specify them each time you log in.

Parameter nameTypeOptionalityDescriptionConstraints

email

string
OPTIONAL
your email accountstored in credentials file
passwordstring
OPTIONAL
your passwordstored in credentials file
accessTokenstringOPTIONAL

generated CleverMaps access token

(see how to get one)

stored in config file
serverstring
OPTIONAL

server to connect to

stored in config file
dumpDirectorystringOPTIONALdirectory where your dumps will be storedstored in config file
proxyHoststringOPTIONAL

proxy server hostname

stored in config file
proxyPortintegerOPTIONALproxy server portstored in config file
s3AccessKeyIdstringOPTIONAL

AWS S3 Access Key ID

required for S3 upload (loadCsv --s3Uri)

stored in config file
s3SecretAccessKeystringOPTIONAL

AWS S3 Secret Access Key

required for S3 upload (loadCsv --s3Uri)

stored in config file

Connected to server

openProject

Open a project and set as current.

Parameter nameTypeOptionalityDescriptionConstraints

project

string
REQUIRED
Project ID of project to be opened

listProjects

List all projects avaliable to you on the server.

Parameter nameTypeOptionalityDescriptionConstraints
verboseboolean
OPTIONAL
specifies if the output should be more verbose
shareenum
OPTIONAL
list projects by share type[demo, dimension, template]
organizationstringOPTIONALlist projects by organization (organization ID)

createProject

Create a new project and opens it.

Parameter nameTypeOptionalityDescriptionConstraints
titlestring
REQUIRED
title of the project
descriptionstring
OPTIONAL
description of the project. A description can be formatted by markdown syntax.
organizationstringOPTIONAL

ID of the organization which will become the owner of the project


editProject

Edit project properties.

Parameter nameTypeOptionalityDescriptionConstraints
projectstring
REQUIRED
Project ID of project to be edited
newTitlestringOPTIONALnew title of the project
newDescriptionstring
OPTIONAL
new description of the project
newStatusstringOPTIONALnew status of the project[enabled, disabled]
newOrganizationstringOPTIONALnew ID of the organization which will become the owner of the project

deleteProject

Delete an existing project.

Parameter nameTypeOptionalityDescriptionConstraints
projectstring
REQUIRED
Project ID of the project to be deleted

Opened project

importProject

Allows you to import either:

You can also import a part of a project with one of the parameters (dashboards, datasets, indicators, indicatorDrills, markers, markerSelectors, metrics, views). If you specify none of these parameters, the whole project will be imported. Everytime you specify a datasets parameter, corresponding data will be imported.

Before each import, validate command is called in the background. If there are any model validation violations in the source project, the import is stopped, unless you also provide the --force parameter.

During the import, the origin key is set to all metadata objects. This key indicates the original location of the object (server and the project). This has a special use in case of datasets & data import. import first takes a look at what datasets currently are in the project and compares them with datasets that are about to be imported. Datasets that are not present in the destination project will be imported automatically. In case of datasets that are present in the destination project, 3 cases might occur:

  • if they have the same name and origin, the dataset will not be imported
  • if they have the same name but different origin, a warning is shown and the dataset will not be imported
  • if a prefix is specified, all source datasets will be imported
Parameter nameTypeOptionalityDescriptionConstraints
serverstring
OPTIONAL

Hostname of the server from which the project will be imported

default = https://secure.clevermaps.io


projectstring
VARIES

Project ID of the project from which files will be imported

(info) either project or dump must be specified


dumpstringVARIES

ID of a project dump to be imported

(info) either project or dump must be specified


cascadeFromstringOPTIONAL

cascade import object and all objects it references

see usage examples below


prefixstringOPTIONALspecify a prefix for the metadata objects and data files
dashboardsbooleanOPTIONALimport dashboards only
datasetsbooleanOPTIONALimport datasets only
indicatorsbooleanOPTIONALimport indicators only
indicatorDrills
booleanOPTIONALimport indicator drills only
markersbooleanOPTIONALimport markers only
markerSelectorsbooleanOPTIONALimport marker selectors only
metricsbooleanOPTIONALimport metrics only
projectSettingsbooleanOPTIONALimport project settings only
sharesbooleanOPTIONAL

import shares only


viewsbooleanOPTIONAL

import views only


forcebooleanOPTIONAL

ignore source project validate errors and proceed with import anyway

skip failed dataset dumps (for projects with incomplete data)

default = false


skipDatabooleanOPTIONAL

skip data import

default = false


Usage examples:
Cascade import examples
// import all objects referenced from catchment_area_view including datasets & data
importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_view

// import all objects referenced from catchment_area_view except including datasets & data
importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_view --dashboards --exports --indicatorDrills --indicators --markerSelectors --markers --metrics --views

// import all objects referenced from catchment_area_dashboard
importProject --project djrt22megphul1a5 --server --cascadeFrom catchment_area_dashboard

// import all objects (datasets) referenced from baskets dataset - data model subset
importProject --project djrt22megphul1a5 --server --force --cascadeFrom baskets

importDatabase

Allows you to create datasets and import data from an external database.

This command reads the database metadata from which datasets are created, then imports the data and saves them as CSV files. You can choose to import either of which with --skipMetadata and --skipData parameters. Please note that this command does not create any other metadata objects than datasets. It's also possible to import only specific tables using the --tables parameter.

The database must be located on a running database server which is accessible under an URL. This can be on localhost, or anywhere on the internet. Valid credentials to the database are of course necessary.

So far, the command supports these database engines:

Parameter nameTypeOptionalityDescriptionConstraints
engineenum
REQUIRED

name of the database engine

[postgresql]
hoststring
REQUIRED

database server hostname

for local databases, use localhost


portintegerREQUIREDdatabase server port
schemastringOPTIONAL

name of the database schema

leave out if your engine does not support schemas, or the schema is public


databasestringREQUIREDname of the database
userstringREQUIREDuser name for login to the database
passwordstringREQUIREDuser's password
tablesarrayOPTIONAL

list of tables to import

leave out if you want to import all tables from the database

example = "orders,clients,stores"


skipDatabooleanOPTIONAL

skip data import

default = false


skipMetadatabooleanOPTIONAL

skip metadata import

default = false


Usage examples:
importDatabase --engine postgresql --host localhost --port 5432 --database my_db --user postgres --password test
importDatabase --engine postgresql --host 172.16.254.1 --port 6543 --schema my_schema --database my_db --user postgres --password test --tables orders,clients,stores

loadCsv

Load data from a CSV file into a specified dataset.

loadCsv also offers various CSV input settings. Your CSV file may contain specific features, like custom quote or separator characters. The parameters with the csv prefix allow you to configure the data load to fit these features, instead of transforming the CSV file to one specific format. Special cases include the csvNull and csvForceNull parameters.

  • csvNull allows you to specify a value, which will be interpreted as a null value
    • e.g. "false" or "_"
  • csvForceNull then specifies on which columns the custom null replacement should be enforced
    • e.g. "name,title,description"
Parameter nameTypeOptionalityDescriptionConstraints
filestring
VARIES

path to the CSV file

(info) one of file, s3Uri or url parameters must be specified


s3UristringVARIES

URI of an object on AWS S3 to upload (see examples below)

(info) one of file, s3Uri or url parameters must be specified


urlstringVARIES

HTTPS URL which contains a CSV file to be loaded into the dataset

(info) one of file, s3Uri or url parameters must be specified


datasetstring
REQUIRED
name of dataset into which the data should be loaded
modeenumREQUIRED

data load mode

incremental mode appends the data to the end of the table

full mode truncates the table and loads the table anew

[incremental, full]

csvHeader

booleanOPTIONAL

specifies if the CSV file to upload has a header

default = true


csvSeparatorcharOPTIONAL

specifies the CSV column separator character

default = ,


csvQuotecharOPTIONAL

specifies the CSV quote character

default = "


csvEscapecharOPTIONAL

specifies the CSV escape character

default = \


csvNullstringOPTIONALspecifies the replacement of custom CSV null values
csvForceNullenumOPTIONALspecifies which CSV columns should enforce the null replacement
verbosebooleanOPTIONAL

enables more verbose output

default = false


multipartbooleanOPTIONAL

enables multipart file upload (recommended for files larger than 2 GB)

default = false


gzipbooleanOPTIONAL

enables gzip compression

default = true


Usage examples:

Please note that your AWS S3 Access Key ID and Secret Access Key must be set using setup command first.

Load CSV from AWS S3
loadCsv --dataset orders --mode full --s3Uri s3://my-company/data/orders.csv --verbose
Load CSV from HTTPS URL
loadCsv --dataset orders --mode full --url http://www.example.com/download/orders.csv --verbose

dumpCsv

Dump data from a specified dataset into a CSV file. Creates new dump with dumped data.

Parameter nameTypeOptionalityDescriptionConstraints
directorystring
OPTIONAL
path to a directory where project's dump will be createdstored in config file
datasetstring
REQUIRED
name of the dataset do dump

dumpProject

Dump project data and metadata to a directory. If the dump if successfull, the current dump is opened.

Parameter nameTypeOptionalityDescriptionConstraints
directorystring
OPTIONAL
path to a directory to which the dump will be saved

stored in config file

skipMetadataboolean
OPTIONAL

skip metadata dump

default = false


skipDatabooleanOPTIONAL

skip data dump

default = false


forcebooleanOPTIONAL

skip failed dataset dumps (for projects with incomplete data)

default = false


nativeDatasetsOnlybooleanOPTIONAL

import only native datasets (without origin attribute)

default = false


listDumps

List all project dumps in a local directory.

Parameter nameTypeOptionalityDescriptionConstraints
directorystring
OPTIONAL
path to a parent directory of a specific project's dumps

stored in config file

openDump

Open a specific dump.

Parameter nameTypeOptionalityDescriptionConstraints
directorystring
OPTIONAL
path to a parent directory of a specific project's dumps

stored in config file

dumpstringOPTIONAL

open a specified dump (eg. 2019-01-01_12-00-00)

if not specified, latest dump is opened


truncateProject

Deletes all metadata and data from the project.

This command has no parameters.

validate

Validate the project's data model and data integrity.

Parameter nameTypeOptionalityDescriptionConstraints
projectstringOPTIONAL

project ID of other project which will be validated


skipModelstring
OPTIONAL

skip validations of the data model

default = false


skipDatastringOPTIONAL

skip validations of the data itself

default = false


Opened dump

addMetadata

Add new metadata object and upload it to the project. The file must be located in a currently opened dump, and in the correct directory.

If the --objectName parameter is not specified, addMetadata will add all new objects in the current dump.

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
OPTIONAL
name of the object (with or without .json extension)

Updating existing metadata objects

When modifying already added (uploaded) metadata objects use pushProject command for uploading modified objects to the project.

createMetadata

Create new metadata object.

(info) At this moment, only dataset type is supported. Datasets are generated from a provided CSV file.

Parameter nameTypeOptionalityDescriptionConstraints
typeenumREQUIREDtype of the object to create

[dataset]

objectNamestring
REQUIRED
name of the object to create
subtypeenumVARIES

name of the object copy (with or without .json extension)

required only for dataset type

[basic, geometryPoint, geometryPolygon]
filestringVARIES

path to the CSV file (located either in dump, or anywhere in the file system)

required only for dataset type


primaryKeystringVARIES

name of the CSV column that will be marked as primary key

required only for dataset type


geometrystringVARIES

name of the geometry key

required only for geometryPolygon subtype


csvSeparatorcharOPTIONAL

specifies the CSV column separator character

default = ,


csvQuotecharOPTIONAL

specifies the CSV quote character

default = "


csvEscapecharOPTIONAL

specifies CSV escape character

default = \


Usage examples:
createMetadata --type dataset --subtype basic --objectName "baskets" --file "baskets.csv" --primaryKey "basket_id"
createMetadata --type dataset --subtype geometryPoint --objectName "shops" --file "shops.csv" --primaryKey "shop_id"
createMetadata --type dataset --subtype geometryPolygon --objectName "district" --geometry "districtgeojson" --file "district.csv" --primaryKey "district_code"

removeMetadata

Remove a metadata object from the project and from the dump. The file must be located in a currently opened dump, and must not be new.

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
VARIES

name of the object (with or without .json extension)

(info) one of objectName, objectId or orphanObjects parameters must be specified


objectIdstringVARIESID of the object
orphanObjectsbooleanVARIES

prints a sequence of removeMetadata commands to delete orphan metadata objects

orphan object is an object not referenced from any of the project's views, or visible anywhere else in the app


renameMetadata

Rename a metadata object in a local dump and on the server. If the object is referenced in some other objects by URI (/rest/projects/$projectId/md/{objectType}?name=), the references will be renamed as well.

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
REQUIRED
current name of the object (with or without .json extension)
newNamestringREQUIREDnew name of the object (with or without .json extension)

copyMetadata

Create a copy of an object existing in a currently opened dump.

This command unwraps the object from a wrapper, renames it and removes generated common syntax keys. If the objectName and newName arguments are the same, the object is unwrapped only.

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
REQUIRED
current name of the object (with or without .json extension)
newNamestringREQUIREDname of the object copy (with or without .json extension)

pushProject

Upload all modified files (data & metadata) to the project.

This command basically wraps the functionality of loadCsv. It collects all modified metadata to upload, and performs full load of CSV files.

Parameter nameTypeOptionalityDescriptionConstraints
skipMetadataboolean
OPTIONAL

skip metadata push

default = false


skipDatabooleanOPTIONAL

skip data push

default = false


skipValidatebooleanOPTIONAL

skip the run of validate after push

default = false


forcebooleanOPTIONAL

force metadata push when there's a share breaking change

default = false


verbose


booleanOPTIONAL

enables more verbose output

default = false


multipartbooleanOPTIONAL

enables multipart file upload (recommended for files larger than 2 GB)

default = false


gzipbooleanOPTIONAL

enables gzip compression

default = true


status

Check the status of a currently opened dump against the project on the server.

This command detects files which have been locally or remotely changed, and also detects files which have a syntax error or constraint violations.

When --remote is used command only displays metadata content on the server.

Parameter nameTypeOptionalityDescriptionConstraints
remoteboolean
OPTIONAL

list metadata content on the server

default = false


applyDiff

Create and apply metadata diff between two live projects.

This command compares all metadata objects of the currently opened project and project specified in the --sourceProject command, and applies changes to the currently opened dump. Metadata objects in dump can be either:

  • added (completely new objects that aren't present in currently opened project)
  • modified
  • deleted (deleted objects not present in the sourceProject)

When the command finishes, you can review the changes applied to the dump using either status or diff comands. The command then tells you to perform specific subsequent steps. This can be one of (or all) these commands:

  • addMetadata (to add the new objects)
  • pushProject (to push the changes in modified objects)
  • removeMetadata (to remove the deleted objects - a command list which must be copypasted to Shell is generated (info))
Parameter nameTypeOptionalityDescriptionConstraints
sourceProjectstring
REQUIRED
Project ID of the source project
objectTypesarrayOPTIONAL

list of object types to be compared

example = "views,indicators,metrics"


diff

Compare local metadata objects with those in project line by line.

If the --objectName parameter is not specified, all wrapped modifed objects are compared.

Parameter nameTypeOptionalityDescriptionConstraints
objectNamestring
OPTIONAL
name of a single object to compare (with or without .json extension)

The command outputs sets of changes - "deltas" done in each object. Each object can have multiple deltas, which are followed by header with syntax:

/{objectType}/{objectName}.json
[ A1 A2 | B1 B2 ]
...

Where:
A1 = start delta line number in the dump file
A2 = end delta line number in the dump file
B1 = start delta line number in the remote file
B2 = end delta line number in the remote file

Specific output example:

Which means lines 82-85 in the dump object have been added (+) in favor of lines 82-85, which have been removed () from the remote object.