@mappr/cli
v0.0.6
Published
Mappr CLI library
Downloads
176
Keywords
Readme
cli
Mappr CLI library
Usage
$ npm install -g @mappr/cli
$ mappr COMMAND
running command...
$ mappr (-v|--version|version)
@mappr/cli/0.0.6 darwin-x64 node-v12.16.3
$ mappr --help [COMMAND]
USAGE
$ mappr COMMAND
...
Commands
mappr application
mappr application:create
mappr config
mappr dataset
mappr dataset:create
mappr dataset:delete
mappr dataset:list
mappr dataset:update
mappr describe
mappr help [COMMAND]
mappr iconset
mappr iconset:create
mappr iconset:delete
mappr iconset:list
mappr login
mappr logout
mappr mediaset
mappr mediaset:create
mappr mediaset:delete
mappr mediaset:list
mappr project
mappr project:create
mappr project:delete
mappr project:list
mappr project:select
mappr register
mappr reset
mappr tasks
mappr tasks:AbstractTaskCommand
mappr tasks:cancel
mappr tasks:list
mappr tasks:logs
mappr tasks:remove
mappr application
Manages your Mappr Applications
USAGE
$ mappr application
DESCRIPTION
To create a new Mappr Application use -> mappr application:create
mappr application:create
Manages your Mappr Applications
USAGE
$ mappr application:create
DESCRIPTION
This command will clone a starter Mappr application into the current working directory and configure it to work with
the development server.
Note: This command needs authentication.
EXAMPLE
$ mappr application:create
mappr config
Returns path to the Mappr CLI config file
USAGE
$ mappr config
DESCRIPTION
This command will look for the current .mapprrc file and print out the full path to it.
Typically the file will be located in your system's Home directory.
But it is also possible to override the main RC file with another one inside your working directory or with command
line arguments and env variables.
EXAMPLE
$ mappr config
/Users/systemuser/.mapprrc
mappr dataset
Manages your Mappr Datasets
USAGE
$ mappr dataset
DESCRIPTION
...
Create dataets: mappr dataset:create
List dataets: mappr dataset:list
Delete dataets: mappr dataset:delete
GraphQL API url: https://api.mappr.xyz/playground
mappr dataset:create
Create new Dataset by given name, projectId, and GEO-data.
USAGE
$ mappr dataset:create
DESCRIPTION
Note: This command needs authentication.
EXAMPLE
$ mappr dataset:create
mappr dataset:delete
Delete existing Dataset by given datasetId
USAGE
$ mappr dataset:delete
DESCRIPTION
This command delete Dataset by ID for the project that mentioned.
Note: This command needs authentication.
EXAMPLE
$ mappr dataset:delete
mappr dataset:list
List all existing Datasets by given ProjectId
USAGE
$ mappr dataset:list
DESCRIPTION
This command returns the list of all Dataset available for the project that mentioned.
For each Dataset it will print out its ID and Name.
Note: This command needs authentication.
EXAMPLE
$ mappr dataset:list
Dataset ID Indexes
────────── ────────────
dataset-1 []
dataset-2 [ 'localisation -> simple', 'q__fr -> simple' ]
mappr dataset:update
Create new Dataset by given name, projectId, and GEO-data.
USAGE
$ mappr dataset:update
DESCRIPTION
Note: This command needs authentication.
EXAMPLE
$ mappr dataset:create
mappr describe
Displays complete help for Mappr CLI in a structured way
USAGE
$ mappr describe
mappr help [COMMAND]
display help for mappr
USAGE
$ mappr help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
mappr iconset
Manages your Mappr Iconsets
USAGE
$ mappr iconset
DESCRIPTION
...
Create iconsets: mappr iconset:create
List iconsets: mappr iconset:list
Delete iconsets: mappr iconset:delete
To play around our GraphQL API and check docs visit: https://api.mappr.xyz/playground
mappr iconset:create
Create new Iconset by given name, projectId, and icons.
USAGE
$ mappr iconset:create
DESCRIPTION
Note: This command needs authentication.
EXAMPLE
$ mappr iconset:create
mappr iconset:delete
Delete existing Iconset by given IconsetId
USAGE
$ mappr iconset:delete
DESCRIPTION
This command delete Iconset by ID for the project that mentioned.
Note: This command needs authentication.
EXAMPLE
$ mappr iconset:delete
mappr iconset:list
List all existing Iconsets by given ProjectId
USAGE
$ mappr iconset:list
DESCRIPTION
This command returns the list of all Iconset available for the project that mentioned.
For each Iconset it will print out its ID and Name.
Note: This command needs authentication.
EXAMPLE
$ mappr iconset:list
Iconset ID Iconset Name
────────── ────────────
icon-1 IconSet 1
icon-2 IconSet 2
mappr login
Logs into your Mappr account
USAGE
$ mappr login
OPTIONS
-p, --password=password your password
-u, --username=username your username
DESCRIPTION
This command loggs you into the Mappr CLI with your account.
Note: This command needs pre-registered Mappr account. Create one with the "mappr register" command.
EXAMPLES
$ mappr login -e john_doe -p your-password
✔ Logged in! Now you can continue using Mappr CLI!
$ mappr login --username john_doe --password your-password
✔ Logged in! Now you can continue using Mappr CLI!
$ mappr login
> What is your username? john_doe
> What is your password? *******
✔ Logged in! Now you can continue using Mappr CLI!
mappr logout
Logs out of your Mappr account
USAGE
$ mappr logout
DESCRIPTION
This command will log out from Mappr CLI and clear the contents of the .mapprrc file.
EXAMPLE
$ mappr logout
✔ Logged out!
mappr mediaset
Manages your Mappr Mediasets
USAGE
$ mappr mediaset
DESCRIPTION
...
Create mediaets: mappr mediaset:create
List mediaets: mappr mediaset:list
Delete mediaets: mappr mediaset:delete
GraphQL API url: https://api.mappr.xyz/playground
mappr mediaset:create
Create new Mediaset by given name, projectId, and GDrive url.
USAGE
$ mappr mediaset:create
DESCRIPTION
Note: This command needs authentication.
EXAMPLE
$ mappr mediaset:create
mappr mediaset:delete
Delete existing Mediaset by given mediasetId
USAGE
$ mappr mediaset:delete
DESCRIPTION
This command delete Mediaset by ID for the project that mentioned.
Note: This command needs authentication.
EXAMPLE
$ mappr mediaset:delete
mappr mediaset:list
List all existing Mediasets by given ProjectId
USAGE
$ mappr mediaset:list
DESCRIPTION
This command returns the list of all Mediaset available for the project that mentioned.
For each Mediaset it will print out its ID and Name.
Note: This command needs authentication.
EXAMPLE
$ mappr mediaset:list
Mediaset ID Url
────────── ────────────
mediaset-1 url
mediaset-2 url
mappr project
Manages your Mappr Projects
USAGE
$ mappr project
DESCRIPTION
To create a new Project use -> mappr project:create
To list all Projects use -> mappr project:list
To delete a Project use -> mappr project:delete
To define the current project use -> mappr project:select
To play around our GraphQL API and check docs visit: https://api.mappr.xyz/playground
mappr project:create
Initialise new Mappr project
USAGE
$ mappr project:create
OPTIONS
-p, --projectName=project-name new project name
DESCRIPTION
This command will create a new project in your Mappr account with the given name.
EXAMPLES
$ mappr project:create -p 'My New Project'
Initialised. Use this access key to work with your project: new-project-token
$ mappr project:create --projectName 'My New Project 2'
Initialised. Use this access key to work with your project: new-project-2-token
$ mappr project:create
> What is your project name? Project 3
Initialised. Use this access key to work with your project: new-project-3-token
mappr project:delete
Delete a project with given ID
USAGE
$ mappr project:delete
OPTIONS
-p, --projectId=project-id the Project ID to delete
DESCRIPTION
This command will delete one of your projects with provided project ID.
Note: This command needs authentication.
EXAMPLES
$ mappr project:delete -p project-1-id
Deleted the project with ID: project-1-id
$ mappr project:delete --projectId project-2-id
Deleted the project with ID: project-2-id
$ mappr project:delete
> What is your project ID? project-3-id
Deleted the project with ID: project-3-id
mappr project:list
List all existing projects
USAGE
$ mappr project:list
DESCRIPTION
This command returns the list of all projects available for the logged in user.
For each project it will print out its ID, Name and Access Token.
Note: This command needs authentication.
EXAMPLE
$ mappr project:list
Project ID Project Name Access Token
────────── ──────────── ────────────
proj-1 Project 1 proj-1-token
proj-2 Project 2 proj-2-token
mappr project:select
Select a current project to work with.
USAGE
$ mappr project:select
DESCRIPTION
This command prompts to choose from one of the existing projects in your account which will be set as the current
project in the CLI.
All other commands that are associated with a project will automatically work with the selected one.
Note: This command needs authentication.
EXAMPLE
$ mappr project:select
mappr register
Creates a new Mappr account
USAGE
$ mappr register
OPTIONS
-e, --email=email your email address
-n, --name=name your name
-p, --password=password your password
-u, --username=username your unique username
DESCRIPTION
This commands creates a new Mappr user for you with provided credentials.
It will also automatically log you into Mappr CLI after successful registration.
EXAMPLES
$ mappr register -e [email protected] -p your-password -n 'John Doe'
✔ Done! You are now logged into your Mappr account!
$ mappr register --email [email protected] --password your-password
✔ Done! You are now logged into your Mappr account!
$ mappr register
> What is your email address? [email protected]
> What is your password? *******
> What is your name? Jon Doe
✔ Done! You are now logged into your Mappr account!
mappr reset
Resets your password
USAGE
$ mappr reset
OPTIONS
-e, --email=email your email address
-i, --id=id your user ID
-p, --newPassword=newPassword your password
DESCRIPTION
This command reseting yourpassword of your Mappr account.
Note: This command needs pre-registered Mappr account. Create one with the "mappr register" command.
EXAMPLES
$ mappr reset -e [email protected] -p your-new-password
then you can do:
$ mappr login
> What is your email address? [email protected]
> What is your new password? *******
✔ Password reseted! Now you can continue using Mappr CLI!
mappr tasks
Manages long-running tasks associated with the project.
USAGE
$ mappr tasks
DESCRIPTION
- mappr tasks:list - list of all tasks associated with the current project
and the corresponding information (like task start/end time and status)
- mappr tasks:logs - shows logs for a specific task
- mappr tasks:remove - removes information about the specified task
(only for finished tasks)
- mappr tasks:stop - stops the currently running task
To play around our GraphQL API and check docs visit: https://api.mappr.xyz/playground
mappr tasks:AbstractTaskCommand
USAGE
$ mappr tasks:AbstractTaskCommand
mappr tasks:cancel
Removes a selected task
USAGE
$ mappr tasks:cancel
DESCRIPTION
Removes a selected task
EXAMPLE
$ mappr tasks:remove
mappr tasks:list
Gives list of tasks associated with the specified project ID.
USAGE
$ mappr tasks:list
DESCRIPTION
Gives list of tasks associated with the specified project ID.
EXAMPLE
$ mappr tasks:list
mappr tasks:logs
USAGE
$ mappr tasks:logs
DESCRIPTION
EXAMPLE
$ mappr tasks:list
mappr tasks:remove
Removes a selected task
USAGE
$ mappr tasks:remove
DESCRIPTION
Removes a selected task
EXAMPLE
$ mappr tasks:remove