mmussett/mashcli

Mashery Command Line utility

mashcli

This repository contains the source code for TIBCO Mashery CLI tool (mashcli).

Written in golang v1.9

Compiling from source

To build and install mashcli, simply run:

go install ./...

Supported platforms

mashcli was built and tested on Go v1.9 on OS X.

Getting Started

$ mashcli
NAME:
   mashcli - TIBCO Mashery - Command Line Interface

USAGE:
   mashcli [global options] command [command options] [arguments...]

VERSION:
   0.1.0

AUTHOR:
   Mark Mussett (mmussett@me.com)

COMMANDS:
     api                         Manage application package keys-related operations. For additional help, use 'mashcli applicationpackagekeys --help'
     applications, ap            Manage application-related operations for the current user. For additional help, use 'mashcli applications --help'
     applicationpackagekeys, ak  Manage application package keys-related operations. For additional help, use 'mashcli applicationpackagekeys --help'
     area, ar                    Manage application package keys-related operations. For additional help, use 'mashcli area --help'
     members, m                  Manage member-related operations. For additional help, use 'mashcli members --help'
     memberapplications, ma      Manage application-related operations for the current user. For additional help, use 'mashcli memberapplications --help'
     services, s                 Manage service-related operations for the current user. For additional help, use 'mashcli services --help'
     endpoints, e                Manage endpoint-related operations for the current user. For additional help, use 'mashcli endpoints --help'
     packages, pa                Manage package-related operations for the current user. For additional help, use 'mashcli packages --help'
     packagekeys, k              Manage package key-related operations. For additional help, use 'mashcli packagekeys --help'
     plans, pl                   Manage plan-related operations for the current user. For additional help, use 'mashcli plans --help'
     planservices, ps            Manage planservice-related operations for the current user. For additional help, use 'mashcli planservices --help'
     plandesigner, pd            Manage plan designer operations for the current user. For additional help, use 'mashcli plandesigner --help'
     config, c                   Configuration for the current user. For additional help, use 'mashcli config --help'
     help, h                     Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

COPYRIGHT:
   2017 Mark Mussett.

Setup

mashcli must be provided with your Mashery Area configuration before being able to work. Once provide mashcli will be able to authenticate and use the Mashery platform APIs.

mashcli stores Mashery Area configuration files in $HOME/.mashcli.

Each configuration files stores the parameters settings for a single Mashery Area.

By default mashcli will read Mashery Area configuration from mashcli.config unless overridden from the command line using the --area flag

Each configuration file contains a json object that follows the following format:

{
  "userid": "",
  "password": "",
  "apikey": "",
  "apikeysecret": "",
  "name": "",
  "area": "",
  "tm": ""
}

Example:

{
  "userid": "mmussett",
  "password": "pa55w0rd",
  "apikey": "s3st2bzysqcv1qcu2t5vz977",
  "apikeysecret": "8pYXg7HQXa",
  "name": "demo",
  "area": "c7e8e2d5-ff91-42eb-9885-10f2aa2cc3f5",
  "tm": "demo.api.mashery.com"
}

Adding your Mashery Area configuration

To create your area configuration, simply run:

$ mashcli config add

Follow on-screen prompts and provide the following following:

Configuration Name?
Enter a value (Default is mashcli): 

Area ID?
Enter a value:

Traffic Manager?
Enter a value:

API Key?
Enter a value: 

API Key Secret?
Enter a value: 

User ID?
Enter a value: 
 
User Password?
Enter a value: 

Commands

• api
• applications
• applicationpackagekeys
• area
• members
• memberapplications
• roles
• services
• endpoints
• packages
• packagekeys
• plans
• planservices
• plandesigner
• config
• help

api

• import

Usage:

mashcli api import [command options] filename PublicDomain

Options:

applications

• delete
• export
• import
• show
• showall

applications delete

Delete an Application in Mashery.

Usage:

mashcli applications delete [command options] ApplicationID

Command Options:

• --area value, -a value Area Configuration Name. If not provided defaults to mashcli.config

applications export

Export an Application specification from Mashery.

Usage:

mashcli applications export [command options] ApplicationID

Command Options:

• --area value, -a value Area Configuration Name. If not provided defaults to mashcli.config
• --filename value, -f value The export Filename for the Application Definition

Omission of the --filename option will output the definition to stdout.

Examples:

$ mashcli applications export d985067d-1568-4152-94f7-82acdbf4537d
{
 "id": "d985067d-1568-4152-94f7-82acdbf4537d",
 "created": "2017-12-12T14:06:45Z",
 "updated": "2017-12-14T10:03:43Z",
 "username": "mashclitest",
 "name": "mashclitest_application",
 "description": "mashcli test",
 "type": "WEB_WIDGET",
 "commercial": true,
 "ads": true,
 "adsSystem": "mashclitest",
 "usageModel": "OPEN_VERY_WIDE",
 "tags": "mashcli",
 "notes": "mashcli",
 "howDidYouHear": "mashcli",
 "preferredProtocol": "REST",
 "preferredOutput": "JSON",
 "externalId": "mashcli",
 "uri": "http://mashcli",
 "status": "draft",
 "isPackaged": true,
 "oauthRedirectUri": "http://mashcli"
}

$ mashcli applications export -f out.json d985067d-1568-4152-94f7-82acdbf4537d

applications import

Import an Application specification in to Mashery. Should be used to only update an existing Application. If you need to create a new Application from specification please use [memberapplications import] command.

Usage:

mashcli applications import [command options]

Command Options:

• --area value, -a value Area Configuration Name. If not provided defaults to mashcli.config
• --filename value, -f value The import Filename for the Application Definition

applications show

Show a specific Application in Mashery.

Usage:

mashcli applications show [command options]

Options:

• --area value, -a value Area Configuration Name. If not provided defaults to mashcli.config
• --output value, -o value Output format value 'table' or 'json'. Default is 'table'

Examples:

$ mashcli applications show bd096f15-dad4-4318-b2ba-09ba6b1cf831
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+
|                  ID                  | EXTERNAL ID |           NAME            | DESCRIPTION  |  USERNAME   | STATUS |    TYPE     | COMMERCIAL | RUNS ADVERTS |     USAGE      | PROTOCOL | OUTPUT |       CREATED       |       UPDATED       |
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+
| bd096f15-dad4-4318-b2ba-09ba6b1cf831 |             | Weather Application       |              | mmussett    | draft  |             | OFF        | OFF          |                |          |        | 2017-09-15T08:44:01 | 2017-09-15T08:44:01 |
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+

applications showall

Show a list of all known Applications in Mashery.

Usage:

mashcli applications showall [command options]

Options:

• --area value, -a value Area Configuration Name. If not provided defaults to mashcli.config
• --filter value, -f value Filter expression as colon-separated name/value pair i.e -filter 'name:Basic'
• --output value, -o value Output format value 'table' or 'json'. Default is 'table'

Examples:

$ mashcli applications showall
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+
|                  ID                  | EXTERNAL ID |           NAME            | DESCRIPTION  |  USERNAME   | STATUS |    TYPE     | COMMERCIAL | RUNS ADVERTS |     USAGE      | PROTOCOL | OUTPUT |       CREATED       |       UPDATED       |
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+
| bd096f15-dad4-4318-b2ba-09ba6b1cf831 |             | Weather Application       |              | mmussett    | draft  |             | OFF        | OFF          |                |          |        | 2017-09-15T08:44:01 | 2017-09-15T08:44:01 |
| ff6e6a14-1e42-4b25-a474-b013704a86ca |             | ACME Application          |              | mmussett    | draft  |             | OFF        | OFF          |                |          |        | 2017-12-08T10:10:21 | 2017-12-08T10:10:21 |
+--------------------------------------+-------------+---------------------------+--------------+-------------+--------+-------------+------------+--------------+----------------+----------+--------+---------------------+---------------------+

$ mashcli applications showall -output json
[
    {
        "id": "bd096f15-dad4-4318-b2ba-09ba6b1cf831",
        "created": "2017-09-15T08:44:01Z",
        "updated": "2017-09-15T08:44:01Z",
        "username": "mmussett",
        "name": "Weather Application",
        "status": "draft",
        "isPackaged": true
    },
    {
        "id": "ff6e6a14-1e42-4b25-a474-b013704a86ca",
        "created": "2017-12-08T10:10:21Z",
        "updated": "2017-12-08T10:10:21Z",
        "username": "mmussett",
        "name": "ACME Application",
        "status": "draft",
        "isPackaged": true
    }
]

$ mashcli applications showall -filter 'username:mmussett'
+--------------------------------------+-------------+---------------------------+-------------+----------+--------+------+------------+--------------+-------+----------+--------+---------------------+---------------------+
|                  ID                  | EXTERNAL ID |           NAME            | DESCRIPTION | USERNAME | STATUS | TYPE | COMMERCIAL | RUNS ADVERTS | USAGE | PROTOCOL | OUTPUT |       CREATED       |       UPDATED       |
+--------------------------------------+-------------+---------------------------+-------------+----------+--------+------+------------+--------------+-------+----------+--------+---------------------+---------------------+
| bd096f15-dad4-4318-b2ba-09ba6b1cf831 |             | Weather Application       |             | mmussett | draft  |      | OFF        | OFF          |       |          |        | 2017-09-15T08:44:01 | 2017-09-15T08:44:01 |
| ff6e6a14-1e42-4b25-a474-b013704a86ca |             | ACME Application          |             | mmussett | draft  |      | OFF        | OFF          |       |          |        | 2017-12-08T10:10:21 | 2017-12-08T10:10:21 |
+--------------------------------------+-------------+---------------------------+-------------+----------+--------+------+------------+--------------+-------+----------+--------+---------------------+---------------------+

applicationpackagekeys

• showall

applicationpackagekeys show

area

• backup
• restore

area backup

area restore

members

• add
• delete
• export
• import
• setstatus
• show
• showall

members add

members delete

members export

members import

members setstatus

members show

members showall

memberapplications

• add
• export
• import
• showall

memberapplications add

memberapplications export

memberapplications import

services

• add
• clone
• delete
• export
• import
• show
• show all

services add

Add a Service to Mashery.

Usage:

mashcli services add [command options] Name

Command Options:

• --description value, -d value Describe your service
• --version value, -v value Version identifier
• --area value, -a value Area Configuration Name
• --qps value, -q value Aggregate QPS (default: 0)

Examples:

$ mashcli services add "Weather Service"
{
    "id": "e2f7jf556pa3pdjj6fevjkv8",
    "created": "2018-01-17T20:43:59.000+0000",
    "name": "Weather Service",
    "updated": "2018-01-17T20:43:59.350+0000"
}

services clone

Clone an existing Service in Mashery.

Usage:

mashcli services clone [command options]

Command Options:

• --area value, -a value Area Configuration Name

Examples:

$ mashcli services clone e2f7jf556pa3pdjj6fevjkv8
{
    "id": "rygcyvq3sk2uxgg3pk42kx85",
    "created": "2018-01-17T20:45:42.000+0000",
    "crossdomainPolicy": "\u003c?xml version=\"1.0\"?\u003e\n\u003c!DOCTYPE cross-domain-policy SYSTEM \"http://www.macromedia.com/xml/dtds/cross-domain-policy.dtd\"\u003e\n\u003ccross-domain-policy\u003e\n   \u003callow-access-from domain=\"*\"/\u003e\n\u003c/cross-domain-policy\u003e",
    "editorHandle": "mmussett",
    "name": "Weather Service",
    "revisionNumber": 2,
    "updated": "2018-01-17T20:45:42.494+0000",
    "version": "1.0"
}

services delete

services export

services import

services show

services showall

Show a list of all known Mashery Services.

Usage:

mashcli services showall [command options] [arguments...]

Command Options:

• --area value, -a value Area Configuration Name
• --filter value, -f value Filter expression as colon-separated name/value pair i.e -filter version:1.0
• --name value, -n value Filter on name matching pattern i.e. -name test
• --output value, -o value Output format table or json)

Examples:

$ mashcli services showall
+--------------------------+--------------------------------------------------+--------------------------------+----------+------------------+---------------------+---------------------+
|        SERVICE ID        |                       NAME                       |          DESCRIPTION           | AGG  QPS |     VERSION      |       CREATED       |       UPDATED       |
+--------------------------+--------------------------------------------------+--------------------------------+----------+------------------+---------------------+---------------------+
| 9dyupurdkktfwstmrw3z45vg | Swagger Petstore                                 |                                |        0 | 1.0.0            | 2018-01-05T14:19:14 | 2018-01-05T14:19:14 |
+--------------------------+--------------------------------------------------+--------------------------------+----------+------------------+---------------------+---------------------+

$ mashcli services showall -output json
[
    {
        "id": "9dyupurdkktfwstmrw3z45vg",
        "created": "2018-01-05T14:19:14.000+0000",
        "crossdomainPolicy": "\u003c?xml version=\"1.0\"?\u003e\n\u003c!DOCTYPE cross-domain-policy SYSTEM \"http://www.macromedia.com/xml/dtds/cross-domain-policy.dtd\"\u003e\n\u003ccross-domain-policy\u003e\n   \u003callow-access-from domain=\"*\"/\u003e\n\u003c/cross-domain-policy\u003e",
        "editorHandle": "mmussett",
        "name": "Swagger Petstore",
        "revisionNumber": 2,
        "updated": "2018-01-05T14:19:14.000+0000",
        "version": "1.0.0"
    }
]

$ mashcli services showall -name Order*
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+
|        SERVICE ID        |        NAME         |         DESCRIPTION          | AGG  QPS |     VERSION      |       CREATED       |       UPDATED       |
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+
| vvtxed3rkx86nda3k3tdhq5v | Order API           |                              |        0 |              1.0 | 2017-09-15T09:34:50 | 2017-09-15T09:37:57 |
| q9eus5ub73xx5k8zqejrj9z5 | Order API           |                              |        0 |              1.0 | 2018-01-04T11:32:34 | 2018-01-04T11:32:34 |
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+

$ mashcli services showall -name Order*
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+
|        SERVICE ID        |        NAME         |         DESCRIPTION          | AGG  QPS |     VERSION      |       CREATED       |       UPDATED       |
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+
| vvtxed3rkx86nda3k3tdhq5v | Order API           |                              |        0 |              1.0 | 2017-09-15T09:34:50 | 2017-09-15T09:37:57 |
| q9eus5ub73xx5k8zqejrj9z5 | Order API           |                              |        0 |              1.0 | 2018-01-04T11:32:34 | 2018-01-04T11:32:34 |
+--------------------------+---------------------+------------------------------+----------+------------------+---------------------+---------------------+

$ mashcli services showall --filter "version:1.0" -name ACME*
+--------------------------+----------------------+----------------------------------+----------+------------------+---------------------+---------------------+
|        SERVICE ID        |         NAME         |           DESCRIPTION            | AGG  QPS |     VERSION      |       CREATED       |       UPDATED       |
+--------------------------+----------------------+----------------------------------+----------+------------------+---------------------+---------------------+
| vx6f3xyyr99sahfwkbvw82dm | ACME                 |                                  |        0 |              1.0 | 2017-05-16T19:15:21 | 2017-07-17T11:58:19 |
| gykda32cdzsu257fyju9x52m | ACME OAuth           |                                  |       10 |              1.0 | 2017-08-04T08:42:50 | 2017-11-13T22:24:12 |
+--------------------------+----------------------+----------------------------------+----------+------------------+---------------------+---------------------+

show service

Show service Usage:

mashcli services show [command options] ID

Options:

• --area value, -a value Area Configuration Name
• --output value, -o value Output format table or json

Example

$ mashcli services show 9dyupurdkktfwstmrw3z45vg
+--------------------------+------------------+-------------+----------+---------+---------------------+---------------------+
|        SERVICE ID        |       NAME       | DESCRIPTION | AGG  QPS | VERSION |       CREATED       |       UPDATED       |
+--------------------------+------------------+-------------+----------+---------+---------------------+---------------------+
| 9dyupurdkktfwstmrw3z45vg | Swagger Petstore |             |        0 | 1.0.0   | 2018-01-05T14:19:14 | 2018-01-05T14:19:14 |
+--------------------------+------------------+-------------+----------+---------+---------------------+---------------------+

$ mashcli services show 9dyupurdkktfwstmrw3z45vg -output json
{
    "id": "9dyupurdkktfwstmrw3z45vg",
    "created": "2018-01-05T14:19:14.000+0000",
    "crossdomainPolicy": "\u003c?xml version=\"1.0\"?\u003e\n\u003c!DOCTYPE cross-domain-policy SYSTEM \"http://www.macromedia.com/xml/dtds/cross-domain-policy.dtd\"\u003e\n\u003ccross-domain-policy\u003e\n   \u003callow-access-from domain=\"*\"/\u003e\n\u003c/cross-domain-policy\u003e",
    "editorHandle": "mmussett",
    "name": "Swagger Petstore",
    "revisionNumber": 2,
    "updated": "2018-01-05T14:19:14.000+0000",
    "version": "1.0.0"
}

endpoints

• add
• clone
• delete
• export
• import
• show
• showall

endpoints add

endpoints clone

endpoints delete

endpoints export

endpoints import

endpoints show

endpoints showall

packages

• add
• clone
• delete
• export
• import
• show
• showall

packages add

packages clone

packages delete

packages export

packages import

packages show

packages showall

packagekeys

• delete
• export
• import
• setrates
• setstatus
• show
• showall

packagekeys delete

packagekeys export

packagekeys import

packagekeys setrates

packagekeys setstatus

packagekeys show

packagekeys showall

plans

• add
• clone
• delete
• export
• import
• setkeyprops
• setratelimits
• setstatus
• show
• showall

plans add

plans clone

plans delete

plans export

plans import

plans setkeyprops

plans setratelimits

plans setstatus

plans show

plans showall

planservices

• show
• showall

planservices show

planservices showall

plandesigner

• add
• delete

plandesigner add

plandesigner delete

config

• show
• add

config show

config add

Library and Framework Credits

This application uses a lot of great open source libraries.

• cli
• sling
• tablewriter
• go-input
• go-logging

License

The MIT License (MIT)

Copyright (c) 2017-2018 Mark Mussett

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.