ctl
Command-Line for for Fonos
Usage
$ npm install -g @fonos/ctl
$ fonos COMMAND
running command...
$ fonos (-v|--version|version)
@fonos/ctl/0.2.11 darwin-x64 node-v14.16.0
$ fonos --help [COMMAND]
USAGE
$ fonos COMMAND
...
Commands
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.js
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.js
fonos agents:get [REF]
get information about an existing agent
USAGE
$ fonos agents:get [REF]
See code: dist/commands/agents/get.js
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.js
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.js
fonos auth:login
log in to a fonos deployment
USAGE
$ fonos auth:login
See code: dist/commands/auth/login.js
fonos auth:logout
log out from a fonos deployment
USAGE
$ fonos auth:logout
See code: dist/commands/auth/logout.js
fonos bug
start a bug report 🐞
USAGE
$ fonos bug
DESCRIPTION
...
Opens github issues with a predefine bug template
See code: dist/commands/bug.js
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.js
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.js
fonos domains:get [REF]
get information about an existing domain
USAGE
$ fonos domains:get [REF]
See code: dist/commands/domains/get.js
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.js
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.js
fonos feedback
let'us know how we're doing
USAGE
$ fonos feedback
DESCRIPTION
...
Help us improve by providing some feedback
See code: dist/commands/feedback.js
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 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.js
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.js
fonos numbers:get [REF]
get information about an existing number
USAGE
$ fonos numbers:get [REF]
See code: dist/commands/numbers/get.js
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.js
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.js
fonos plugins
list installed plugins
USAGE
$ fonos plugins
OPTIONS
--core show core plugins
EXAMPLE
$ fonos plugins
See code: @oclif/plugin-plugins
fonos plugins:inspect PLUGIN...
displays installation properties of a plugin
USAGE
$ fonos plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] plugin to inspect
OPTIONS
-h, --help show CLI help
-v, --verbose
EXAMPLE
$ fonos plugins:inspect myplugin
See code: @oclif/plugin-plugins
fonos plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ fonos plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ fonos plugins:add
EXAMPLES
$ fonos plugins:install myplugin
$ fonos plugins:install https://github.com/someuser/someplugin
$ fonos plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
fonos plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ fonos plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ fonos plugins:link myplugin
See code: @oclif/plugin-plugins
fonos plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ fonos plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ fonos plugins:unlink
$ fonos plugins:remove
See code: @oclif/plugin-plugins
fonos plugins:update
update installed plugins
USAGE
$ fonos plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
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.js
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.js
fonos providers:get [REF]
get information about an existing provider
USAGE
$ fonos providers:get [REF]
See code: dist/commands/providers/get.js
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.js
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.js