Install and setup the CLI
Fonoster's command-line tool will help you manage your Fonoster instances. From creating
Agents to deploying
Functions and more.
The command-line tool is available via NPM. Use the following steps to install the tool as a global command.
1. Open a new terminal
2. Type "npm -g install @fonoster/ctl"
3. Wait for the process to complete
Commands and subcommands
The command-line tool comes with built-in commands covering all main use cases and additional commands via plugins. Most commands are "collapsed" under a section. For example, the
agents sections contain the following commands:
agents:createcreates a new Agent resource
agents:deleteremoves an Agent from a Project
agents:getget information about an existing Agent
agents:listlist registered Agents
agents:updateupdates an Agent at the SIP Proxy subsystem
Authenticating the CLI
You can point the CLI to your own Fonoster instance or use our as a service option. To use the as-a-service option, follow the next steps:
1. Go to https://console.fonoster.io/ to get your credentials
2. Open a new terminal
3. Type the command "fonoster auth:login"
4. Login using your credentials
For detailed information about Fonoster's command-line interface, please visit the NPM page.