@fonos/ctl

Command-Line for Fonos

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@fonos/ctl
5,228250.2.11a year ago2 years agoMinified + gzip package size for @fonos/ctl in KB

Readme

ctl
Command-Line for for Fonos
oclif Version Downloads/week License
Usage
```sh-session $ 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 ...
<!-- usagestop -->

# Commands

<!-- commands -->
* [`fonos agents:create`](#fonos-agentscreate)
* [`fonos agents:delete [REF]`](#fonos-agentsdelete-ref)
* [`fonos agents:get [REF]`](#fonos-agentsget-ref)
* [`fonos agents:list`](#fonos-agentslist)
* [`fonos agents:update [REF]`](#fonos-agentsupdate-ref)
* [`fonos auth:login`](#fonos-authlogin)
* [`fonos auth:logout`](#fonos-authlogout)
* [`fonos bug`](#fonos-bug)
* [`fonos domains:create`](#fonos-domainscreate)
* [`fonos domains:delete [REF]`](#fonos-domainsdelete-ref)
* [`fonos domains:get [REF]`](#fonos-domainsget-ref)
* [`fonos domains:list`](#fonos-domainslist)
* [`fonos domains:update [REF]`](#fonos-domainsupdate-ref)
* [`fonos feedback`](#fonos-feedback)
* [`fonos help [COMMAND]`](#fonos-help-command)
* [`fonos numbers:create`](#fonos-numberscreate)
* [`fonos numbers:delete [REF]`](#fonos-numbersdelete-ref)
* [`fonos numbers:get [REF]`](#fonos-numbersget-ref)
* [`fonos numbers:list`](#fonos-numberslist)
* [`fonos numbers:update [REF]`](#fonos-numbersupdate-ref)
* [`fonos plugins`](#fonos-plugins)
* [`fonos plugins:inspect PLUGIN...`](#fonos-pluginsinspect-plugin)
* [`fonos plugins:install PLUGIN...`](#fonos-pluginsinstall-plugin)
* [`fonos plugins:link PLUGIN`](#fonos-pluginslink-plugin)
* [`fonos plugins:uninstall PLUGIN...`](#fonos-pluginsuninstall-plugin)
* [`fonos plugins:update`](#fonos-pluginsupdate)
* [`fonos providers:create`](#fonos-providerscreate)
* [`fonos providers:delete [REF]`](#fonos-providersdelete-ref)
* [`fonos providers:get [REF]`](#fonos-providersget-ref)
* [`fonos providers:list`](#fonos-providerslist)
* [`fonos providers:update [REF]`](#fonos-providersupdate-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.js](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.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.js](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/index.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/inspect.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/install.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/link.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/uninstall.ts)_

## `fonos plugins:update`

update installed plugins
USAGE $ fonos plugins:update
OPTIONS -h, --help show CLI help -v, --verbose
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.1/src/commands/plugins/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.js](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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](https://github.com/fonoster/fonos/blob/v0.2.11/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