conapps-cmx-cli
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

conapps-cmx-cli

Conapps CMX CLI

Version CircleCI Appveyor CI Codecov Downloads/week License

Usage

$ npm install -g conapps-cmx-cli
$ conapps-cmx COMMAND
running command...
$ conapps-cmx (-v|--version|version)
conapps-cmx-cli/1.2.0 darwin-x64 node-v10.3.0
$ conapps-cmx --help [COMMAND]
USAGE
  $ conapps-cmx COMMAND
...

Commands

conapps-cmx add-licences TENANT

Add licences to a tenant.

USAGE
  $ conapps-cmx add-licences TENANT

ARGUMENTS
  TENANT  Conapps CMX tenant to asign the new licences

OPTIONS
  -a, --ammount=ammount        (required) Ammount of licences to create
  -e, --endpoint=endpoint      [default: http://localhost:8989] DynamoDB endpoint.
  -e, --expiration=expiration  [default: never] Date of licence expiration
  -i, --interval=interval      [default: 100] Time between each DynamoDB call.
  -l, --local                  [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project        [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage            [default: development] Environment value.

EXAMPLES
  $ conapps-cmx add-licences TENANT \
     --ammount 10 \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

  $ conapps-cmx add-licences TENANT \
     --ammount 10 \
     --expiration 2019-07-06T22:59:33.870Z \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/add-licences.ts

conapps-cmx create-table TABLE

Creates one DynamoDB table.

USAGE
  $ conapps-cmx create-table TABLE

ARGUMENTS
  TABLE  Table to create. One of: MerakiLocations, KnownObservations, Observations, Profiles, Locations, APs, Tenants,
         Licences

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx create-table TABLE \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/create-table.ts

conapps-cmx create-tables

Creates all DynamoDB tables.

USAGE
  $ conapps-cmx create-tables

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx [COMMAND] \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/create-tables.ts

conapps-cmx create-tenant NAME ROOTUSERNAME

Create a new tenant.

USAGE
  $ conapps-cmx create-tenant NAME ROOTUSERNAME

ARGUMENTS
  NAME          Name of the tenant to create.

  ROOTUSERNAME  Username identifier of the root account for the tenant. Must be previously created through Cognito, or
                by using the "create-user" command.

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx create-tenant conatel "conatel|cjic46sth0000yqtcak2f6mgn" \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/create-tenant.ts

conapps-cmx create-user ATTRIBUTES

Create a new user.

USAGE
  $ conapps-cmx create-user ATTRIBUTES

ARGUMENTS
  ATTRIBUTES  User key/value pairs, separated with a comma (",")

OPTIONS
  -p, --project=project        [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage            [default: development] Environment value
  -u, --userPoolId=userPoolId  User Pool Id. Can be configured by setting the environment variable USER_POOL_ID

EXAMPLE
  $ conapps-cmx create-user \
    email=example@test.com,name="Example Name",tenant=conatel,role=admin

See code: src/commands/create-user.ts

conapps-cmx delete-table TABLE

Deletes one DynamoDB table.

USAGE
  $ conapps-cmx delete-table TABLE

ARGUMENTS
  TABLE  Table to delete. One of: MerakiLocations, KnownObservations, Observations, Profiles, Locations, APs, Tenants,
         Licences

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx delete-table TABLE \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/delete-table.ts

conapps-cmx delete-tables

Deletes all DynamoDB tables.

USAGE
  $ conapps-cmx delete-tables

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx [COMMAND] \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/delete-tables.ts

conapps-cmx help [COMMAND]

display help for conapps-cmx

USAGE
  $ conapps-cmx help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

conapps-cmx list-tables

Lists all DynamoDB tables.

USAGE
  $ conapps-cmx list-tables

OPTIONS
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.

EXAMPLE
  $ conapps-cmx [COMMAND] \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/list-tables.ts

conapps-cmx seed ENTITY

Seed random data to the database.

USAGE
  $ conapps-cmx seed ENTITY

ARGUMENTS
  ENTITY  Conapps CMX entity to seed. One of: merakiLocations, knownObservations, observations, profiles, locations,
          aps, tenants, licences

OPTIONS
  -a, --ammount=ammount    Ammount of random data to seed (value depends on entity).
  -e, --endpoint=endpoint  [default: http://localhost:8989] DynamoDB endpoint.
  -i, --interval=interval  [default: 100] Time between each DynamoDB call.
  -l, --local              [default: true] Interact with a local DynamoDB endpoint.
  -p, --project=project    [default: conatel-cmx] ConappsCMX project name.
  -s, --stage=stage        [default: development] Environment value.
  -t, --tenant=tenant      [default: development] Entity tenant.
  --max=max                Max ammount of seeds to create.
  --min=min                Min ammount of seeds to create.

EXAMPLES
  $ conapps-cmx seed ENTITY \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

  $ conapps-cmx seed ENTITY \
     --tenant conatel \
     --max 100 \
     --min 50 \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

  $ conapps-cmx seed ENTITY \
     --tenant conatel \
     --ammount 100 \
     --endpoint "http://localhost:8989" \
     --project conatel-cmx-dev \
     --stage staging

See code: src/commands/seed.ts

Dependencies (19)

Dev Dependencies (15)

Package Sidebar

Install

npm i conapps-cmx-cli

Weekly Downloads

3

Version

1.2.0

License

MIT

Unpacked Size

163 kB

Total Files

47

Last publish

Collaborators

  • guzmonne