@fonos/ctl

ctl

Command-Line for for Fonos

• Usage
• Commands

Usage

$ npm install -g @fonos/ctl
$ fonos COMMAND
running command...
$ fonos (-v|--version|version)
@fonos/ctl/0.0.9 darwin-x64 node-v14.4.0
$ fonos --help [COMMAND]
USAGE
  $ fonos COMMAND
...

Commands

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

fonos agents:create

creates a new agent resource

USAGE
  $ fonos agents:create

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

See code: dist/commands/agents/create.ts

fonos agents:delete [REF]

remove agent from a Fonos deployment

USAGE
  $ fonos agents:delete [REF]

ALIASES
  $ fonos agents:del
  $ fonos agents:rm

See code: dist/commands/agents/delete.ts

fonos agents:get [REF]

get information about an existing agent

USAGE
  $ fonos agents:get [REF]

See code: dist/commands/agents/get.ts

fonos agents:list

list registered agents

USAGE
  $ fonos agents:list

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

DESCRIPTION
  ...
     List the registered agents

ALIASES
  $ fonos agents:ls

See code: dist/commands/agents/list.ts

fonos agents:update [REF]

updates a agent at the SIP Proxy subsystem

USAGE
  $ fonos agents:update [REF]

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

See code: dist/commands/agents/update.ts

fonos apps:delete [NAME]

removes application

USAGE
  $ fonos apps:delete [NAME]

ALIASES
  $ fonos apps:del
  $ fonos apps:rm

See code: dist/commands/apps/delete.ts

fonos apps:deploy

deploys application to a Fonos instance

USAGE
  $ fonos apps:deploy

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

See code: dist/commands/apps/deploy.ts

fonos apps:get [NAME]

get information about an existing application

USAGE
  $ fonos apps:get [NAME]

DESCRIPTION
  ...
     Obtain information about an application

See code: dist/commands/apps/get.ts

fonos apps:init

creates a new empty application

USAGE
  $ fonos apps:init

DESCRIPTION
  ...
     Extra documentation goes here

See code: dist/commands/apps/init.ts

fonos apps:list

list registered applications

USAGE
  $ fonos apps:list

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

DESCRIPTION
  ...
     List the registered applications

ALIASES
  $ fonos apps:ls

See code: dist/commands/apps/list.ts

fonos domains:create

creates a new domain resource

USAGE
  $ fonos domains:create

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

See code: dist/commands/domains/create.ts

fonos domains:delete [REF]

remove a domain from a Fonos deployment

USAGE
  $ fonos domains:delete [REF]

ALIASES
  $ fonos domains:del
  $ fonos domains:rm

See code: dist/commands/domains/delete.ts

fonos domains:get [REF]

get information about an existing domain

USAGE
  $ fonos domains:get [REF]

See code: dist/commands/domains/get.ts

fonos domains:list

list registered domains

USAGE
  $ fonos domains:list

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

DESCRIPTION
  ...
     List the registered domains

ALIASES
  $ fonos domains:ls

See code: dist/commands/domains/list.ts

fonos domains:update [REF]

updates a domain at the SIP Proxy subsystem

USAGE
  $ fonos domains:update [REF]

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

See code: dist/commands/domains/update.ts

fonos help [COMMAND]

display help for fonos

USAGE
  $ fonos help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

fonos login

authenticates current station

USAGE
  $ fonos login

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

See code: dist/commands/login.ts

fonos logout

revoke crendentials to current station

USAGE
  $ fonos logout

See code: dist/commands/logout.ts

fonos numbers:create

creates a new number resource

USAGE
  $ fonos numbers:create

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

See code: dist/commands/numbers/create.ts

fonos numbers:delete [REF]

remove a number from a Fonos deployment

USAGE
  $ fonos numbers:delete [REF]

ALIASES
  $ fonos numbers:del
  $ fonos numbers:rm

See code: dist/commands/numbers/delete.ts

fonos numbers:get [REF]

get information about an existing number

USAGE
  $ fonos numbers:get [REF]

See code: dist/commands/numbers/get.ts

fonos numbers:list

list registered numbers

USAGE
  $ fonos numbers:list

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

DESCRIPTION
  ...
  List the registered numbers

ALIASES
  $ fonos numbers:ls

See code: dist/commands/numbers/list.ts

fonos numbers:update [REF]

updates a number at the SIP Proxy subsystem

USAGE
  $ fonos numbers:update [REF]

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

See code: dist/commands/numbers/update.ts

fonos providers:create

creates a new provider resource

USAGE
  $ fonos providers:create

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

See code: dist/commands/providers/create.ts

fonos providers:delete [REF]

removes a provider from a Fonos deployment

USAGE
  $ fonos providers:delete [REF]

ALIASES
  $ fonos providers:del
  $ fonos providers:rm

See code: dist/commands/providers/delete.ts

fonos providers:get [REF]

get information about an existing provider

USAGE
  $ fonos providers:get [REF]

See code: dist/commands/providers/get.ts

fonos providers:list

list registered providers

USAGE
  $ fonos providers:list

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

DESCRIPTION
  ...
     List the registered providers

ALIASES
  $ fonos providers:ls

See code: dist/commands/providers/list.ts

fonos providers:update [REF]

updates a provider at the SIP Proxy subsystem

USAGE
  $ fonos providers:update [REF]

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

See code: dist/commands/providers/update.ts