Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

montra-via-cli

0.1.10 • Public • Published

montra-via

VIA CLI

oclif Version Downloads/week License

Usage

$ npm install -g montra-via-cli
$ via COMMAND
running command...
$ via (-v|--version|version)
montra-via-cli/0.1.10 win32-x64 node-v10.16.0
$ via --help [COMMAND]
USAGE
  $ via COMMAND
...

Commands

via auth0 [FILE]

describe the command here

USAGE
  $ via auth0 [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

via bms:bms [FILE]

describe the command here

USAGE
  $ via bms:bms [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

via bms:test [FILE]

describe the command here

USAGE
  $ via bms:test [FILE]

OPTIONS
  -e, --env=env                [default: prod] target api environment to use
  -o, --output=json|table|csv  [default: table] set output format
  --help                       show CLI help

via core:sync

Force synchronization of all BMS and VSA records with VIA

USAGE
  $ via core:sync

OPTIONS
  -e, --env=env  [default: prod] target api environment to use
  --help         show CLI help

via core:ticket

List Tickets

USAGE
  $ via core:ticket

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --help                            show CLI help
  --loglevel=error|warn|info|debug

EXAMPLES
  via ticket --$select=id,auth0Id,name,email --$top=1  -o json --env=local
  via ticket --env=qa --$filter="substringof('atl',email)"

via core:ticket:activeCounts

Active Ticket Counts (all accounts)

USAGE
  $ via core:ticket:activeCounts

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --help                            show CLI help
  --loglevel=error|warn|info|debug

EXAMPLES
  via core:ticket:activeCount 
  via core:ticket:activeCount --env=qa --$filter="substringof('atl',email)"

via crypto:create

Encode a string value, using the supplied encryption key

USAGE
  $ via crypto:create

OPTIONS
  -d, --data=data  data to encrypt
  -e, --env=env    [default: prod] target api environment to use
  -k, --key=key    shared encryption key
  --help           show CLI help

EXAMPLE
  via crypto:create --data="client_id" --key="client_secret"

via crypto:decode

Decode a string value, using the supplied (original) encryption key

USAGE
  $ via crypto:decode

OPTIONS
  -d, --data=data  (required) data to encrypt
  -e, --env=env    [default: prod] target api environment to use
  -k, --key=key    (required) shared encryption key
  --help           show CLI help

EXAMPLE
  via crypto:decode --data="I6CV7U3j63K8xFoOwcHP2Wn8+B7TSpoPs" --key="client_secret"

via hello [FILE]

describe the command here

USAGE
  $ via hello [FILE]

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -f, --force
  -h, --help                        show CLI help
  -n, --name=name                   name to print
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --loglevel=error|warn|info|debug

EXAMPLE
  $ via hello hello world from ./src/hello.ts!

via help [COMMAND]

display help for via

USAGE
  $ via help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

via tenant

Manage VIA Tenants

USAGE
  $ via tenant

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --help                            show CLI help
  --loglevel=error|warn|info|debug

EXAMPLES
  via tenant --$select=name,description,contactName,isActive --$top=10  -o json --env=prod
  via tenant --env=qa --$filter="substringof('atl',email)"

via tenant:create

Ensure a Tenant mapping exists for all active Companies

USAGE
  $ via tenant:create

OPTIONS
  -e, --env=env  [default: prod] target api environment to use
  --force        Force Sync of BMS Accounts (Companies) prior to mapping

EXAMPLES
  via tenant:create --env=dev --force
  via tenant:create

via user

Manage VIA Users

USAGE
  $ via user

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --help                            show CLI help
  --loglevel=error|warn|info|debug

EXAMPLES
  via user --$select=id,auth0Id,name,email --$top=1  -o json --env=local
  via user --env=qa --$filter="substringof('atl',email)"

via user:add FILE

Add VIA portal user access, data file contains array user entries.

USAGE
  $ via user:add FILE

ARGUMENTS
  FILE
      user data list (json)
           example:
           [{
             "tenant":"ANISA",
             "firstName":"demoUser",
             "lastName":"Anisa",
             "email": "demoUser@anisa.com",
             "nickname": "demo Anisa",
             "roles":"Administrator, User",
             "password": "xxx",
             "features":"Ticket, Device, Admin"
           }]

OPTIONS
  -b, --$orderBy=$orderBy           order columns
  -c, --confirm                     Suppress prompts for confirmation
  -e, --env=env                     [default: prod] target api environment to use
  -f, --$filter=$filter             oDatav4 style of where clause
  -o, --output=json|table|csv       [default: table] set output format
  -s, --$select=$select             [default: *] field names to return
  -t, --$top=$top                   [default: 100] limit number of rows
  --$expand=$expand                 expand relationship members
  --help                            show CLI help
  --loglevel=error|warn|info|debug

EXAMPLES
  current dir: C:\projects\montra.io\vsts\via-cli
  $ via user:add .\addUser.json --env=prod

via user:delete EMAIL

Delete user by email from Auth0 and VIA portal

USAGE
  $ via user:delete EMAIL

ARGUMENTS
  EMAIL  user email

OPTIONS
  -e, --env=env  [default: prod] target api environment to use
  --help         show CLI help

via user:reset EMAIL

Send Password rest email/link to user (via Auth0 / mailgun)

USAGE
  $ via user:reset EMAIL

ARGUMENTS
  EMAIL  user email

OPTIONS
  -e, --env=env  [default: prod] target api environment to use
  --help         show CLI help

Keywords

Install

npm i montra-via-cli

DownloadsWeekly Downloads

1

Version

0.1.10

License

MIT

Unpacked Size

82.9 kB

Total Files

59

Last publish

Collaborators

  • avatar