https://github.com/mparticle/mparticle-cli

Description A Command Line Interface for mParticle Services
https://github.com/mparticle/mparticle-cli

Last synced: 10 months ago
JSON representation

Description A Command Line Interface for mParticle Services

Host: GitHub
URL: https://github.com/mparticle/mparticle-cli
Owner: mParticle
Created: 2020-01-28T21:07:15.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-07-12T04:13:43.000Z (almost 3 years ago)
Last Synced: 2025-08-08T19:54:07.317Z (10 months ago)
Language: TypeScript
Size: 600 KB
Stars: 2
Watchers: 5
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING

Awesome Lists containing this project

README

# mParticle CLI

mParticle Command Line Interface

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/mp.svg)](https://npmjs.org/package/mp)
[![Build Status](https://travis-ci.com/mParticle/mparticle-cli.svg?branch=master)](https://travis-ci.com/mParticle/mparticle-cli)

* [mParticle CLI](#mparticle-cli)
* [Usage](#usage)
* [Commands](#commands)

# Usage

## DEMO Usage

- Clone the repo and `cd` into the directory
- `npm install`
- `npm link`

Run `mp`

### Unlink when you're done

Run `npm unlink` in the directory. This will remove the link to `mp`.

Note: Ignore the usage section below. That's for when we get into production)

## Production Usage

`npm -g install @mparticle/cli`

```sh-session
$ npm install -g @mparticle/cli
$ mp COMMAND
running command...
$ mp (-v|--version|version)
@mparticle/cli/1.0.8 darwin-x64 node-v11.14.0
$ mp --help [COMMAND]
USAGE
$ mp COMMAND
...
```

# Commands

* [`mp autocomplete [SHELL]`](#mp-autocomplete-shell)
* [`mp help [COMMAND]`](#mp-help-command)
* [`mp planning:batches:validate`](#mp-planningbatchesvalidate)
* [`mp planning:data-plan-versions:create`](#mp-planningdata-plan-versionscreate)
* [`mp planning:data-plan-versions:delete`](#mp-planningdata-plan-versionsdelete)
* [`mp planning:data-plan-versions:fetch`](#mp-planningdata-plan-versionsfetch)
* [`mp planning:data-plan-versions:update`](#mp-planningdata-plan-versionsupdate)
* [`mp planning:data-plans:create`](#mp-planningdata-planscreate)
* [`mp planning:data-plans:delete`](#mp-planningdata-plansdelete)
* [`mp planning:data-plans:fetch`](#mp-planningdata-plansfetch)
* [`mp planning:data-plans:fetch-all`](#mp-planningdata-plansfetch-all)
* [`mp planning:data-plans:update`](#mp-planningdata-plansupdate)
* [`mp planning:events:validate`](#mp-planningeventsvalidate)

## `mp autocomplete [SHELL]`

display autocomplete installation instructions

```
USAGE
$ mp autocomplete [SHELL]

ARGUMENTS
SHELL shell type

OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)

EXAMPLES
$ mp autocomplete
$ mp autocomplete bash
$ mp autocomplete zsh
$ mp autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.5/src/commands/autocomplete/index.ts)_

## `mp help [COMMAND]`

display help for mp

```
USAGE
$ mp help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `mp planning:batches:validate`

Validates Event Batches

```
USAGE
$ mp planning:batches:validate

OPTIONS
-o, --outFile=outFile (optional) Output file for results (defaults to standard output)
--batch=batch Batch as Stringified JSON
--batchFile=batchFile Path to saved JSON file of a Batch
--clientId=clientId Client ID for Platform API
--clientSecret=clientSecret Client Secret for Platform API
--config=config mParticle Config JSON File
--dataPlan=dataPlan Data Plan as Stringified JSON
--dataPlanFile=dataPlanFile Path to saved JSON file of a Data Plan
--dataPlanVersion=dataPlanVersion Data Plan Version Document as Stringified JSON
--dataPlanVersionFile=dataPlanVersionFile Path to saved JSON file of a Data Plan Version
--logLevel=error|warn|info|debug|silent [default: info] Log Level
--serverMode Validate using mParticle Server-side validation
--versionNumber=versionNumber Data Plan Version Number
--workspaceId=workspaceId mParticle Workspace ID

DESCRIPTION
Data Plans are comprised of one or more Version Documents and are used to validate a Batch.

A Data Plan Version can be directly referenced by using either the --dataPlanVersion or --dataPlanVersionFile flags
Otherwise, a --dataPlan or --dataPlanFile must be accompanied by a --versionNumber.

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:b:val

EXAMPLES
$ mp planning:batches:validate --batch=[BATCH] --dataPlan=[DATA_PLAN] --versionNumber=[VERSION_NUMBER]
$ mp planning:batches:validate --batch=[BATCH] --dataPlanVersion=[DATA_PLAN_VERSION]
$ mp planning:batches:validate --batchFile=/path/to/batch --dataPlanFile=/path/to/dataplan
--versionNumber=[VERSION_NUMBER]
$ mp planning:batches:validate --batchFile=/path/to/batch --dataPlanVersion=/path/to/dataplanversion
```

_See code: [src/commands/planning/batches/validate.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/batches/validate.ts)_

## `mp planning:data-plan-versions:create`

Creates a Data Plan Version and uploads to mParticle

```
USAGE
$ mp planning:data-plan-versions:create

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

A Version Document can be fetched by using your account credentials and a --versionNumber and --dataPlanId.

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dpv:create

EXAMPLE
$ mp planning:data-plan-versions:create --workspaceId=[WORKSPACE_ID] --dataPlanId=[DATA_PLAN_ID]
--dataPlan=[DATA_PLAN]
```

_See code: [src/commands/planning/data-plan-versions/create.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plan-versions/create.ts)_

## `mp planning:data-plan-versions:delete`

Deletes a Data Plan Version and uploads to mParticle

```
USAGE
$ mp planning:data-plan-versions:delete

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

A Version Document can be fetched by using your account credentials and a --versionNumber and --dataPlanId.

Note: Delete will NOT read dataPlanId or versionNumber from config as a precaution to prevent accidental deletion
of records

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dpv:delete

EXAMPLE
$ mp planning:data-plan-versions:delete --workspaceId=[WORKSPACE_ID] --dataPlanId=[DATA_PLAN_ID]
--versionNumber=[VERSION_NUMBER]
```

_See code: [src/commands/planning/data-plan-versions/delete.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plan-versions/delete.ts)_

## `mp planning:data-plan-versions:fetch`

Fetches a Data Plan Version

```
USAGE
$ mp planning:data-plan-versions:fetch

DESCRIPTION
Data Plan Versions are a subset of Data Plans and are used to validate batches.

A Version Document can be fetched by using your account credentials and a --versionNumber and --dataPlanId.

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dpv:fetch

EXAMPLE
$ mp planning:data-plan-versions:fetch --dataPlanId=[DATA_PLAN_ID] --versionNumber=[VERSION_NUMBER]
--workspaceId=[WORKSPACE_ID]
```

_See code: [src/commands/planning/data-plan-versions/fetch.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plan-versions/fetch.ts)_

## `mp planning:data-plan-versions:update`

Updates a Data Plan Version and uploads to mParticle

```
USAGE
$ mp planning:data-plan-versions:update

ALIASES
$ mp plan:dpv:update

EXAMPLE
$ mp planning:data-plan-versions:update --workspaceId=[WORKSPACE_ID] --dataPlanId=[DATA_PLAN_ID]
--versionNumber=[VERSION_NUMBER] --dataPlanVersion=[DATA_PLAN_VERSION]
```

_See code: [src/commands/planning/data-plan-versions/update.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plan-versions/update.ts)_

## `mp planning:data-plans:create`

Creates a Data Plan and uploads to mParticle

```
USAGE
$ mp planning:data-plans:create

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

A Data Plan can be fetched using your account credentials and using a valid --dataPlanId

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dp:create

EXAMPLE
$ mp planning:data-plan:create --workspaceId=[WORKSPACE_ID] --dataPlan=[DATA_PLAN]
```

_See code: [src/commands/planning/data-plans/create.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plans/create.ts)_

## `mp planning:data-plans:delete`

Deletes a Data Plan and uploads to mParticle

```
USAGE
$ mp planning:data-plans:delete

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

A Data Plan can be fetched using your account credentials and using a valid --dataPlanId

Note: Delete will NOT read dataPlanId from config as a precaution to prevent accidental deletion of records

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dp:delete

EXAMPLE
$ mp planning:data-plan:delete --workspaceId=[WORKSPACE_ID] --dataPlanId=[DATA_PLAN_ID]
```

_See code: [src/commands/planning/data-plans/delete.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plans/delete.ts)_

## `mp planning:data-plans:fetch`

Fetches a Data Plan

```
USAGE
$ mp planning:data-plans:fetch

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

A Data Plan can be fetched using your account credentials and using a valid --dataPlanId

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dp:fetch

EXAMPLE
$ mp planning:data-plan:fetch --dataPlanId=[DATA_PLAN_ID] --workspaceId=[WORKSPACE_ID]
```

_See code: [src/commands/planning/data-plans/fetch.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plans/fetch.ts)_

## `mp planning:data-plans:fetch-all`

Fetches All Data Plans

```
USAGE
$ mp planning:data-plans:fetch-all

OPTIONS
-o, --outFile=outFile (optional) Output file for results (defaults to standard output)
-s, --split Split Data Plans into Data Plan Version files
--clientId=clientId Client ID for Platform API
--clientSecret=clientSecret Client Secret for Platform API
--config=config mParticle Config JSON File
--logLevel=error|warn|info|debug|silent [default: info] Log Level
--outPath=outPath Output path for split files
--workspaceId=workspaceId mParticle Workspace ID

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions.

All of your Data Plans will be fetched using your account credentials
and saved with the filename format of: ..json

For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:dp:fetchAll

EXAMPLE
$ mp planning:data-plan:fetch-all --workspaceId=[WORKSPACE_ID]
```

_See code: [src/commands/planning/data-plans/fetch-all.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plans/fetch-all.ts)_

## `mp planning:data-plans:update`

Updates a Data Plan and uploads to mParticle

```
USAGE
$ mp planning:data-plans:update

ALIASES
$ mp plan:dp:update

EXAMPLE
$ mp planning:data-plan:update --workspaceId=[WORKSPACE_ID] --dataPlanId=[DATA_PLAN_ID] --dataPlan=[DATA_PLAN]
```

_See code: [src/commands/planning/data-plans/update.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/data-plans/update.ts)_

## `mp planning:events:validate`

Validates an Event

```
USAGE
$ mp planning:events:validate

OPTIONS
-o, --outFile=outFile (optional) Output file for results (defaults to standard output)
--clientId=clientId Client ID for Platform API
--clientSecret=clientSecret Client Secret for Platform API
--config=config mParticle Config JSON File
--dataPlan=dataPlan Data Plan as Stringified JSON
--dataPlanFile=dataPlanFile Path to saved JSON file of a Data Plan
--dataPlanVersion=dataPlanVersion Data Plan Version Document as Stringified JSON
--dataPlanVersionFile=dataPlanVersionFile Path to saved JSON file of a Data Plan Version
--event=event Event as Stringified JSON
--eventFile=eventFile Path to saved JSON file of an Event
--logLevel=error|warn|info|debug|silent [default: info] Log Level
--serverMode Validate using mParticle Server-side validation
--translateEvents Translate minified event into standard event
--versionNumber=versionNumber Data Plan Version Number
--workspaceId=workspaceId mParticle Workspace ID

DESCRIPTION
Data Plans are comprised of one or more Data Plan Versions and are used to validate an Event.

A Data Plan Version can be directly referenced by using either the --dataPlanVersion or --dataPlanVersionFile flags
Otherwise, a --dataPlan or --dataPlanFile must be accompanied by a --versionNumber.
For more information, visit: https://github.com/mParticle/mparticle-cli

ALIASES
$ mp plan:e:val

EXAMPLES
$ mp planning:events:validate --event=[EVENT] --dataPlan=[DATA_PLAN] --versionNumber=[VERSION_NUMBER]
$ mp planning:events:validate --event=[EVENT] --dataPlanVersion=[DATA_PLAN_VERSION]
$ mp planning:events:validate --event=[EVENT] --dataPlanVersion=[DATA_PLAN_VERSION] --translateEvents
$ mp planning:events:validate --eventFile=/path/to/event --dataPlanFile=/path/to/dataplan
--versionNumber=[VERSION_NUMBER]
$ mp planning:events:validate --eventFile=/path/to/event --dataPlanVersionFile=/path/to/dataplanversion
$ mp planning:events:validate --eventFile=/path/to/event --dataPlanVersionFile=/path/to/dataplanversion
--translateEvents
```

_See code: [src/commands/planning/events/validate.ts](https://github.com/mParticle/mparticle-cli/blob/v1.0.8/src/commands/planning/events/validate.ts)_

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mparticle/mparticle-cli

Awesome Lists containing this project

README