@yaps/ctl v0.0.5

ctl

Command-Line for for YAPS

• Usage
• Commands

Usage

$ npm install -g @yaps/ctl
$ yaps COMMAND
running command...
$ yaps (-v|--version|version)
@yaps/ctl/0.0.5 darwin-x64 node-v10.19.0
$ yaps --help [COMMAND]
USAGE
  $ yaps COMMAND
...

Commands

• yaps agents:create
• yaps agents:delete [REF]
• yaps agents:get [REF]
• yaps agents:list
• yaps agents:update [REF]
• yaps apps:delete [NAME]
• yaps apps:deploy
• yaps apps:get [NAME]
• yaps apps:init
• yaps apps:list
• yaps domains:create
• yaps domains:delete [REF]
• yaps domains:get [REF]
• yaps domains:list
• yaps domains:update [REF]
• yaps help [COMMAND]
• yaps login
• yaps logout
• yaps numbers:create
• yaps numbers:delete [REF]
• yaps numbers:get [REF]
• yaps numbers:list
• yaps numbers:update [REF]
• yaps providers:create
• yaps providers:delete [REF]
• yaps providers:get [REF]
• yaps providers:list
• yaps providers:update [REF]

yaps agents:create

creates a new agent resource

USAGE
  $ yaps agents:create

DESCRIPTION
  ...
  Creates a new Agent in the SIP Proxy subsystem

See code: src/commands/agents/create.js

yaps agents:delete [REF]

remove agent from a YAPS deployment

USAGE
  $ yaps agents:delete [REF]

ALIASES
  $ yaps agents:del
  $ yaps agents:rm

See code: src/commands/agents/delete.js

yaps agents:get [REF]

get information about an existing agent

USAGE
  $ yaps agents:get [REF]

See code: src/commands/agents/get.js

yaps agents:list

list registered agents

USAGE
  $ yaps agents:list

OPTIONS
  -s, --size=size  [default: 25] agent of result per page

DESCRIPTION
  ...
  List the registered agents

ALIASES
  $ yaps agents:ls

See code: src/commands/agents/list.js

yaps agents:update [REF]

updates a agent at the SIP Proxy subsystem

USAGE
  $ yaps agents:update [REF]

DESCRIPTION
  ...
  Updates a agent at the SIP Proxy subsystem

See code: src/commands/agents/update.js

yaps apps:delete [NAME]

removes application

USAGE
  $ yaps apps:delete [NAME]

ALIASES
  $ yaps apps:del
  $ yaps apps:rm

See code: src/commands/apps/delete.js

yaps apps:deploy

deploys application to a YAPS instance

USAGE
  $ yaps apps:deploy

DESCRIPTION
  ...
  Run this command from the app root to deploy to YAPS.

See code: src/commands/apps/deploy.js

yaps apps:get [NAME]

get information about an existing application

USAGE
  $ yaps apps:get [NAME]

DESCRIPTION
  ...
  Obtain information about an application

See code: src/commands/apps/get.js

yaps apps:init

creates a new empty application

USAGE
  $ yaps apps:init

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/apps/init.js

yaps apps:list

list registered applications

USAGE
  $ yaps apps:list

OPTIONS
  -s, --size=size  [default: 25] number of result per page

DESCRIPTION
  ...
  List the registered applications

ALIASES
  $ yaps apps:ls

See code: src/commands/apps/list.js

yaps domains:create

creates a new domain resource

USAGE
  $ yaps domains:create

DESCRIPTION
  ...
  Creates a new Domain in the SIP Proxy subsystem

See code: src/commands/domains/create.js

yaps domains:delete [REF]

remove domain from a YAPS deployment

USAGE
  $ yaps domains:delete [REF]

ALIASES
  $ yaps domains:del
  $ yaps domains:rm

See code: src/commands/domains/delete.js

yaps domains:get [REF]

get information about an existing domain

USAGE
  $ yaps domains:get [REF]

See code: src/commands/domains/get.js

yaps domains:list

list registered domains

USAGE
  $ yaps domains:list

OPTIONS
  -s, --size=size  [default: 25] number of result per page

DESCRIPTION
  ...
  List the registered domains

ALIASES
  $ yaps domains:ls

See code: src/commands/domains/list.js

yaps domains:update [REF]

updates a domain at the SIP Proxy subsystem

USAGE
  $ yaps domains:update [REF]

DESCRIPTION
  ...
  Updates a domain at the SIP Proxy subsystem

See code: src/commands/domains/update.js

yaps help [COMMAND]

display help for yaps

USAGE
  $ yaps help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

yaps login

authenticates current station

USAGE
  $ yaps login

OPTIONS
  -f, --file=file  json file with access credentials

See code: src/commands/login.js

yaps logout

revoke crendentials to current station

USAGE
  $ yaps logout

See code: src/commands/logout.js

yaps numbers:create

creates a new number resource

USAGE
  $ yaps numbers:create

DESCRIPTION
  ...
  Creates a new Number in the SIP Proxy subsystem

See code: src/commands/numbers/create.js

yaps numbers:delete [REF]

remove number from a YAPS deployment

USAGE
  $ yaps numbers:delete [REF]

ALIASES
  $ yaps numbers:del
  $ yaps numbers:rm

See code: src/commands/numbers/delete.js

yaps numbers:get [REF]

get information about an existing number

USAGE
  $ yaps numbers:get [REF]

See code: src/commands/numbers/get.js

yaps numbers:list

list registered numbers

USAGE
  $ yaps numbers:list

OPTIONS
  -s, --size=size  [default: 25] number of result per page

DESCRIPTION
  ...
  List the registered numbers

ALIASES
  $ yaps numbers:ls

See code: src/commands/numbers/list.js

yaps numbers:update [REF]

updates a number at the SIP Proxy subsystem

USAGE
  $ yaps numbers:update [REF]

DESCRIPTION
  ...
  Updates a number at the SIP Proxy subsystem

See code: src/commands/numbers/update.js

yaps providers:create

creates a new provider resource

USAGE
  $ yaps providers:create

DESCRIPTION
  ...
  Creates a new Provider in the SIP Proxy subsystem

See code: src/commands/providers/create.js

yaps providers:delete [REF]

remove provider from a YAPS deployment

USAGE
  $ yaps providers:delete [REF]

ALIASES
  $ yaps providers:del
  $ yaps providers:rm

See code: src/commands/providers/delete.js

yaps providers:get [REF]

get information about an existing provider

USAGE
  $ yaps providers:get [REF]

See code: src/commands/providers/get.js

yaps providers:list

list registered providers

USAGE
  $ yaps providers:list

OPTIONS
  -s, --size=size  [default: 25] provider of result per page

DESCRIPTION
  ...
  List the registered providers

ALIASES
  $ yaps providers:ls

See code: src/commands/providers/list.js

yaps providers:update [REF]

updates a provider at the SIP Proxy subsystem

USAGE
  $ yaps providers:update [REF]

DESCRIPTION
  ...
  Updates a provider at the SIP Proxy subsystem

See code: src/commands/providers/update.js