@fonoster/ctl

ctl

Command-Line for for Fonoster

• ctl
• Usage
• Commands

Usage

$ npm install -g @fonoster/ctl
$ fonoster COMMAND
running command...
$ fonoster (-v|--version|version)
@fonoster/ctl/0.3.22 darwin-x64 node-v16.18.1
$ fonoster --help [COMMAND]
USAGE
  $ fonoster COMMAND
...

Commands

• fonoster agents:create
• fonoster agents:delete [REF]
• fonoster agents:get [REF]
• fonoster agents:list
• fonoster agents:update [REF]
• fonoster apps:create
• fonoster apps:delete [REF]
• fonoster apps:list
• fonoster apps:update [REF]
• fonoster auth:login
• fonoster auth:logout
• fonoster bug
• fonoster domains:create
• fonoster domains:delete [REF]
• fonoster domains:get [REF]
• fonoster domains:list
• fonoster domains:update [REF]
• fonoster feedback
• fonoster help [COMMAND]
• fonoster numbers:create
• fonoster numbers:delete [REF]
• fonoster numbers:get [REF]
• fonoster numbers:list
• fonoster numbers:update [REF]
• fonoster plugins
• fonoster plugins:inspect PLUGIN...
• fonoster plugins:install PLUGIN...
• fonoster plugins:link PLUGIN
• fonoster plugins:uninstall PLUGIN...
• fonoster plugins:update
• fonoster projects:create
• fonoster projects:delete [REF]
• fonoster projects:get [REF]
• fonoster projects:list
• fonoster projects:renew [REF]
• fonoster projects:use [REF]
• fonoster providers:create
• fonoster providers:delete [REF]
• fonoster providers:get [REF]
• fonoster providers:list
• fonoster providers:update [REF]
• fonoster secrets:create [NAME]
• fonoster secrets:delete [NAME]
• fonoster secrets:list

fonoster agents:create

create a new Fonoster Agent

USAGE
  $ fonoster agents:create

DESCRIPTION
  ...
     Create a new Fonoster Agent

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

fonoster agents:delete [REF]

delete a Fonoster Agent

USAGE
  $ fonoster agents:delete [REF]

ALIASES
  $ fonoster agents:del
  $ fonoster agents:rm

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

fonoster agents:get [REF]

get a Fonoster Agent

USAGE
  $ fonoster agents:get [REF]

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

fonoster agents:list

list all Fonoster Agents you have access to

USAGE
  $ fonoster agents:list

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

DESCRIPTION
  ...
     List all Fonoster Agents you have access to

ALIASES
  $ fonoster agents:ls

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

fonoster agents:update [REF]

update a Fonoster Agent

USAGE
  $ fonoster agents:update [REF]

DESCRIPTION
  ...
     Update a Fonoster Agent

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

fonoster apps:create

create a new Fonoster App

USAGE
  $ fonoster apps:create

DESCRIPTION
  ...
     Create a new Fonoster App

See code: dist/commands/apps/create.js

fonoster apps:delete [REF]

delete a Fonoster Application

USAGE
  $ fonoster apps:delete [REF]

ALIASES
  $ fonoster apps:del
  $ fonoster apps:rm

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

fonoster apps:list

list all Fonoster Apps you have access to

USAGE
  $ fonoster apps:list

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

DESCRIPTION
  ...
     List all Fonoster Apps you have access to

ALIASES
  $ fonoster apps:ls

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

fonoster apps:update [REF]

update a new Fonoster App

USAGE
  $ fonoster apps:update [REF]

DESCRIPTION
  ...
     Update a new Fonoster App

See code: dist/commands/apps/update.js

fonoster auth:login

log in to a Fonoster deployment

USAGE
  $ fonoster auth:login

See code: dist/commands/auth/login.js

fonoster auth:logout

log out from a fonoster deployment

USAGE
  $ fonoster auth:logout

See code: dist/commands/auth/logout.js

fonoster bug

start a bug report 🐞

USAGE
  $ fonoster bug

DESCRIPTION
  ...
     Opens github issues with a predefine bug template

See code: dist/commands/bug.js

fonoster domains:create

create a new Fonoster Domain

USAGE
  $ fonoster domains:create

DESCRIPTION
  ...
     Create a new Fonoster Domain

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

fonoster domains:delete [REF]

delete a Fonoster Domain

USAGE
  $ fonoster domains:delete [REF]

ALIASES
  $ fonoster domains:del
  $ fonoster domains:rm

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

fonoster domains:get [REF]

get a Fonoster Domain

USAGE
  $ fonoster domains:get [REF]

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

fonoster domains:list

list all Fonoster Domains you have access to

USAGE
  $ fonoster domains:list

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

DESCRIPTION
  ...
     List all Fonoster Domains you have access to

ALIASES
  $ fonoster domains:ls

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

fonoster domains:update [REF]

update a Fonoster Domain

USAGE
  $ fonoster domains:update [REF]

DESCRIPTION
  ...
     Update a Fonoster Domain

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

fonoster feedback

let us know how we're doing

USAGE
  $ fonoster feedback

DESCRIPTION
  ...
     Help us improve by providing some feedback

See code: dist/commands/feedback.js

fonoster help [COMMAND]

display help for fonoster

USAGE
  $ fonoster help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

fonoster numbers:create

create a new Fonoster Number

USAGE
  $ fonoster numbers:create

DESCRIPTION
  ...
     Create a new Fonoster Number

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

fonoster numbers:delete [REF]

delete a Fonoster Number

USAGE
  $ fonoster numbers:delete [REF]

ALIASES
  $ fonoster numbers:del
  $ fonoster numbers:rm

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

fonoster numbers:get [REF]

get a Fonoster Number

USAGE
  $ fonoster numbers:get [REF]

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

fonoster numbers:list

list all Fonoster Numbers you have access to

USAGE
  $ fonoster numbers:list

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

DESCRIPTION
  ...
     List all Fonoster Numbers you have access to

ALIASES
  $ fonoster numbers:ls

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

fonoster numbers:update [REF]

update a Fonoster Number

USAGE
  $ fonoster numbers:update [REF]

DESCRIPTION
  ...
     Update a Fonoster Number

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

fonoster plugins

List installed plugins.

USAGE
  $ fonoster plugins

OPTIONS
  --core  Show core plugins.

EXAMPLE
  $ fonoster plugins

See code: @oclif/plugin-plugins

fonoster plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ fonoster plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

EXAMPLE
  $ fonoster plugins:inspect myplugin

See code: @oclif/plugin-plugins

fonoster plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ fonoster plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

OPTIONS
  -f, --force    Run 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
  $ fonoster plugins:add

EXAMPLES
  $ fonoster plugins:install myplugin 
  $ fonoster plugins:install https://github.com/someuser/someplugin
  $ fonoster plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

fonoster plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ fonoster 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
  $ fonoster plugins:link myplugin

See code: @oclif/plugin-plugins

fonoster plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fonoster plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

ALIASES
  $ fonoster plugins:unlink
  $ fonoster plugins:remove

See code: @oclif/plugin-plugins

fonoster plugins:update

Update installed plugins.

USAGE
  $ fonoster plugins:update

OPTIONS
  -h, --help     Show CLI help.
  -v, --verbose

See code: @oclif/plugin-plugins

fonoster projects:create

create a new Fonoster Project

USAGE
  $ fonoster projects:create

DESCRIPTION
  ...
     Create a new Fonoster Project

See code: dist/commands/projects/create.js

fonoster projects:delete [REF]

delete a Fonoster Project

USAGE
  $ fonoster projects:delete [REF]

ALIASES
  $ fonoster projects:del
  $ fonoster projects:rm

See code: dist/commands/projects/delete.js

fonoster projects:get [REF]

get a Fonoster Project

USAGE
  $ fonoster projects:get [REF]

See code: dist/commands/projects/get.js

fonoster projects:list

list all Fonoster Projects you have access to

USAGE
  $ fonoster projects:list

DESCRIPTION
  ...
     List all Fonoster Projects you have access to

ALIASES
  $ fonoster projects:ls

See code: dist/commands/projects/list.js

fonoster projects:renew [REF]

renew the credentials of a Fonoster Project

USAGE
  $ fonoster projects:renew [REF]

DESCRIPTION
  ...
     Renew the credentials of a Fonoster Project

See code: dist/commands/projects/renew.js

fonoster projects:use [REF]

set a default Fonoster Project

USAGE
  $ fonoster projects:use [REF]

DESCRIPTION
  ...
     Set a default Fonoster Project

See code: dist/commands/projects/use.js

fonoster providers:create

create a new Fonoster Provider (trunk)

USAGE
  $ fonoster providers:create

DESCRIPTION
  ...
     Create a new Fonoster Provider

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

fonoster providers:delete [REF]

delete a Fonoster Provider

USAGE
  $ fonoster providers:delete [REF]

ALIASES
  $ fonoster providers:del
  $ fonoster providers:rm

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

fonoster providers:get [REF]

get a Fonoster Provider

USAGE
  $ fonoster providers:get [REF]

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

fonoster providers:list

list all Fonoster Providers you have access to

USAGE
  $ fonoster providers:list

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

DESCRIPTION
  ...
     List all Fonoster Providers you have access to

ALIASES
  $ fonoster providers:ls

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

fonoster providers:update [REF]

update a Fonoster Provider

USAGE
  $ fonoster providers:update [REF]

DESCRIPTION
  ...
     Update a Fonoster Provider

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

fonoster secrets:create [NAME]

create a Fonoster secret.

USAGE
  $ fonoster secrets:create [NAME]

OPTIONS
  -h, --help                       show CLI help
  -l, --from-literal=from-literal  pass from literal
  -s, --from-stdin                 pass from stdin

See code: dist/commands/secrets/create.js

fonoster secrets:delete [NAME]

remove Fonoster secret

USAGE
  $ fonoster secrets:delete [NAME]

ALIASES
  $ fonoster secrets:del
  $ fonoster secrets:rm

See code: dist/commands/secrets/delete.js

fonoster secrets:list

list of the secrets you have access to

USAGE
  $ fonoster secrets:list

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

ALIASES
  $ fonoster secrets:ls

See code: dist/commands/secrets/list.js