...
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 no type (-) are passed no valuesboolean 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
...
Log in as a user with correct credentials.
| Parameter name | Type | Optionality | Description | Constraints |
|---|
email
| string | | your email account | stored |
in setup
...
setup
Store your config and credentials in a file so you don't have to specify them each time you log in.
| Parameter name | Type | Optionality | Description | Constraints | email | Constraints |
|---|
email
| string | | your email account | stored in credentials file |
password | string | | your password | stored in credentials file |
accessToken | string | | generated CleverMaps access token (see how to get one) | stored in config file |
server | string | | your email account server to connect to | stored in credentials file config file |
passworddumpDirectory | string | | your passworddirectory where your dumps will be stored | stored in credentials config file |
serverproxyHost | string | | proxy server | to connect tohostname | stored in config file |
dumpDirectoryproxyPort | stringinteger | | directory where your dumps will be storedproxy server port | stored in config file |
proxyHosts3AccessKeyId | string | proxy server hostname | AWS S3 Access Key ID required for S3 upload (loadCsv --s3Uri) | stored in config file |
proxyPorts3SecretAccessKey | integerstring | proxy server port | AWS S3 Secret Access Key required for S3 upload (loadCsv --s3Uri) | stored in config file |
Connected to server
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
verbose | -boolean | | specifies if the output should be more verbose |
|
share | enum | | list projects by share | [demo, dimension] |
organization | string | | list projects by organization (organization ID) |
|
...
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
server | string | | specifies if the output should be more verbose default = https://secure.clevermaps.io |
|
project | string | | id of the project to import  either project or dump must be specified
|
|
dump | string | | id of the dump to import either project or dump must be specified |
|
cascadeFrom | string | | cascade import object and all objects it references see usage examples below |
|
prefix | string | | specify a prefix for the metadata objects and data files |
|
force | -boolean | | force the import even if there are model violations in the source project |
|
dashboards | -boolean | | import dashboards only |
|
datasets | -boolean | | import datasets only |
|
indicators | -boolean | | import indicators only |
|
indicatorDrills
| -boolean | | import indicator drills only |
|
markers | -boolean | | import markers only |
|
markerSelectors | -boolean | | import marker selectors only |
|
metrics | -boolean | | import metrics only |
|
projectSettings | -boolean | | import project settings only |
|
shares | -boolean | | import shares only |
|
views | -boolean | | import views only |
|
force | -boolean | | ignore source project validate errors and proceed with import anyway skip failed dataset dumps (for projects with incomplete data) |
|
skipData | boolean | | skip data import |
|
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
directory | string | | directory to which the dump will be saved | stored in config file |
skipMetadata | -boolean | | skip metadata dump |
|
skipData | -boolean | | skip data dump |
|
force | -boolean | | skip failed dataset dumps (for projects with incomplete data) |
|
...
| Parameter name | Type | Optionality | Description | Constraints |
|---|
skipMetadata | -boolean | | skip metadata push |
|
skipData | -boolean | | skip data push |
|
skipValidate | -boolean | | skip the run of validate after push |
|
force | boolean | | force metadata push when there's a share breaking change |
|
verbose
| boolean | | enables more verbose output default = false | [true, false] |
multipart | boolean | | enables multipart file upload (recommended for files larger than 2 GB) default = true | [true, false] |
gzip | boolean | | enables gzip compression default = true | [true, false]
|
...