Fonoster Control Tool
npm install @fonoster/ctlctl
=================
Command-Line for Fonoster
Use this tool to manage your Fonoster resources from the command line. With this tool, you can create, update, and delete resources like Applications, Numbers, SIP Agents, and more.
> When connecting to your own instance of Fonoster, remember to use your endpoint when login in. Also, remember to use the --insecure flag when connecting to a server with no TLS.
sh-session
$ npm install -g @fonoster/ctl
$ fonoster COMMAND
running command...
$ fonoster (--version)
@fonoster/ctl/0.15.1 darwin-arm64 node-v22.14.0
$ fonoster --help [COMMAND]
USAGE
$ fonoster COMMAND
...
`
Commands
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* create an API key for the active Workspace
USAGE
$ fonoster apikeys:create [-i] [-e ] [-r ]FLAGS
-e, --expiration= API Key expiration time in days(e.g. 10d) or months(e.g. 10m)
-i, --insecure allow connections to a server with no TLS
-r, --role= [default: WORKSPACE_ADMIN] API Key role
DESCRIPTION
create an API key for the active Workspace
EXAMPLES
$ fonoster apikeys:create
_See code: dist/commands/apikeys/create.js_
delete an API key from the active Workspace
USAGE
$ fonoster apikeys:delete REF [-i]ARGUMENTS
REF the ApiKey to delete from the Workspace
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete an API key from the active Workspace
EXAMPLES
$ fonoster apikeys:delete
_See code: dist/commands/apikeys/delete.js_
display all API keys in the active Workspace
USAGE
$ fonoster apikeys:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all API keys in the active Workspace
EXAMPLES
$ fonoster apikeys:list
_See code: dist/commands/apikeys/list.js_
generate a new access key secret for an API key
USAGE
$ fonoster apikeys:regenerate REF [-i]ARGUMENTS
REF the Application to update
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
generate a new access key secret for an API key
EXAMPLES
$ fonoster apikeys:regenerate
_See code: dist/commands/apikeys/regenerate.js_
add a new Application to the active Workspace
USAGE
$ fonoster applications:create [-i] [-f ]FLAGS
-f, --from-file= create Application from YAML or JSON file
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new Application to the active Workspace
EXAMPLES
$ fonoster applications:create
_See code: dist/commands/applications/create.js_
delete an Application from the active Workspace
USAGE
$ fonoster applications:delete REF [-i]ARGUMENTS
REF the Application to delete
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete an Application from the active Workspace
EXAMPLES
$ fonoster applications:delete
_See code: dist/commands/applications/delete.js_
experimental command to test an Autopilot application
USAGE
$ fonoster applications:eval -f [-i]FLAGS
-f, --file= (required) path to test cases file (json, yaml, or yml)
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
experimental command to test an Autopilot application
EXAMPLES
$ fonoster applications:eval -f assistant.json
$ fonoster applications:eval -f assistant.yaml
_See code: dist/commands/applications/eval.js_
retrieve details of an Application by reference
USAGE
$ fonoster applications:get REF [-i]ARGUMENTS
REF The Application to show details about
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of an Application by reference
EXAMPLES
$ fonoster applications:get
_See code: dist/commands/applications/get.js_
display all Applications in the active Workspace
USAGE
$ fonoster applications:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all Applications in the active Workspace
EXAMPLES
$ fonoster applications:list
_See code: dist/commands/applications/list.js_
modify the configuration of an Application
USAGE
$ fonoster applications:update REF [-i] [-f ]ARGUMENTS
REF the Application to update
FLAGS
-f, --from-file= update Application from YAML or JSON file
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the configuration of an Application
EXAMPLES
$ fonoster applications:update
_See code: dist/commands/applications/update.js_
report a bug to the development team 🐞
USAGE
$ fonoster bugDESCRIPTION
report a bug to the development team 🐞
EXAMPLES
$ fonoster bug
_See code: dist/commands/bug.js_
provide feedback on your experience
USAGE
$ fonoster feedbackDESCRIPTION
provide feedback on your experience
...
Help us improve by providing some feedback
EXAMPLES
$ fonoster feedback
_See code: dist/commands/feedback.js_
configure MCP client settings
USAGE
$ fonoster mcp:configure [-c claude] [-w ]FLAGS
-c, --client=
DESCRIPTION
configure MCP client settings
EXAMPLES
$ fonoster mcp:configure --client claude
$ fonoster mcp:configure --client claude --workspace my-workspace
_See code: dist/commands/mcp/configure.js_
add a new Secret to the active Workspace
USAGE
$ fonoster secrets:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new Secret to the active Workspace
EXAMPLES
$ fonoster secrets:create
_See code: dist/commands/secrets/create.js_
delete a Secret from the active Workspace
USAGE
$ fonoster secrets:delete REF [-i]ARGUMENTS
REF the Secret reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete a Secret from the active Workspace
EXAMPLES
$ fonoster secrets:delete
_See code: dist/commands/secrets/delete.js_
retrieve details of a Secret by reference
USAGE
$ fonoster secrets:get REF [-i]ARGUMENTS
REF The Secret to show details about
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a Secret by reference
EXAMPLES
$ fonoster secrets:get
_See code: dist/commands/secrets/get.js_
display all Secrets in the active Workspace
USAGE
$ fonoster secrets:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all Secrets in the active Workspace
EXAMPLES
$ fonoster secrets:list
_See code: dist/commands/secrets/list.js_
modify the value or metadata of a Secret
USAGE
$ fonoster secrets:update REF [-i]ARGUMENTS
REF the Secret to update
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the value or metadata of a Secret
EXAMPLES
$ fonoster secrets:update
_See code: dist/commands/secrets/update.js_
create a new Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
create a new Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:create
_See code: dist/commands/sipnet/acls/create.js_
remove an Access Control List (ACL) from the Workspace
USAGE
$ fonoster sipnet:acls:delete REF [-i]ARGUMENTS
REF the ACL reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
remove an Access Control List (ACL) from the Workspace
EXAMPLES
$ fonoster sipnet:acls:delete
_See code: dist/commands/sipnet/acls/delete.js_
get a specific Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:get REF [-i]ARGUMENTS
REF The ACL reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
get a specific Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:get
_See code: dist/commands/sipnet/acls/get.js_
list all Access Control Lists (ACLs)
USAGE
$ fonoster sipnet:acls:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
list all Access Control Lists (ACLs)
EXAMPLES
$ fonoster sipnet:acls:list
_See code: dist/commands/sipnet/acls/list.js_
update an existing Access Control List (ACL)
USAGE
$ fonoster sipnet:acls:update REF [-i]ARGUMENTS
REF the ACL reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
update an existing Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:acls:update
_See code: dist/commands/sipnet/acls/update.js_
add a new SIP Agent to the network
USAGE
$ fonoster sipnet:agents:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new SIP Agent to the network
EXAMPLES
$ fonoster sipnet:agents:create
_See code: dist/commands/sipnet/agents/create.js_
delete a SIP Agent from the network
USAGE
$ fonoster sipnet:agents:delete REF [-i]ARGUMENTS
REF the Agent reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete a SIP Agent from the network
EXAMPLES
$ fonoster sipnet:agents:delete
_See code: dist/commands/sipnet/agents/delete.js_
retrieve details of a SIP Agent
USAGE
$ fonoster sipnet:agents:get REF [-i]ARGUMENTS
REF The Agent reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a SIP Agent
EXAMPLES
$ fonoster sipnet:agents:get
_See code: dist/commands/sipnet/agents/get.js_
display all SIP Agents in the network
USAGE
$ fonoster sipnet:agents:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all SIP Agents in the network
EXAMPLES
$ fonoster sipnet:agents:list
_See code: dist/commands/sipnet/agents/list.js_
add a new SIP Agent to the network
USAGE
$ fonoster sipnet:agents:update REF [-i]ARGUMENTS
REF the ACL reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new SIP Agent to the network
EXAMPLES
$ fonoster sipnet:agents:update
_See code: dist/commands/sipnet/agents/update.js_
initiate a call to a phone number or SIP URI
USAGE
$ fonoster sipnet:calls:create -f -t -a [-i] [-o ] [-c] [-m ]FLAGS
-a, --app-ref= (required) the reference to the application to use
-c, --track-call track the call
-f, --from= (required) the number to make the call from
-i, --insecure allow connections to a server with no TLS
-m, --metadata= a JSON object with metadata for the voice application (e.g. '{"name": "John Doe"}')
-o, --timeout= [default: 30] the call timeout
-t, --to= (required) the number to make the call to
DESCRIPTION
initiate a call to a phone number or SIP URI
EXAMPLES
$ fonoster sipnet:calls:create
_See code: dist/commands/sipnet/calls/create.js_
get a specific Access Control List (ACL)
USAGE
$ fonoster sipnet:calls:get REF [-i]ARGUMENTS
REF The ACL reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
get a specific Access Control List (ACL)
EXAMPLES
$ fonoster sipnet:calls:get
_See code: dist/commands/sipnet/calls/get.js_
display all calls made in the active Workspace
USAGE
$ fonoster sipnet:calls:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all calls made in the active Workspace
EXAMPLES
$ fonoster sipnet:calls:list
_See code: dist/commands/sipnet/calls/list.js_
add a new set of Credentials to the network
USAGE
$ fonoster sipnet:credentials:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new set of Credentials to the network
EXAMPLES
$ fonoster sipnet:credentials:create
_See code: dist/commands/sipnet/credentials/create.js_
delete a set of Credentials from the active Workspace
USAGE
$ fonoster sipnet:credentials:delete REF [-i]ARGUMENTS
REF the Credentials reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete a set of Credentials from the active Workspace
EXAMPLES
$ fonoster sipnet:credentials:delete
_See code: dist/commands/sipnet/credentials/delete.js_
retrieve details of a set of Credentials by reference
USAGE
$ fonoster sipnet:credentials:get REF [-i]ARGUMENTS
REF The Credentials reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a set of Credentials by reference
EXAMPLES
$ fonoster sipnet:credentials:get
_See code: dist/commands/sipnet/credentials/get.js_
display all Credentials in the active Workspace
USAGE
$ fonoster sipnet:credentials:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all Credentials in the active Workspace
EXAMPLES
$ fonoster sipnet:credentials:list
_See code: dist/commands/sipnet/credentials/list.js_
modify the values or metadata of a set of Credentials
USAGE
$ fonoster sipnet:credentials:update REF [-i]ARGUMENTS
REF the Credentials reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the values or metadata of a set of Credentials
EXAMPLES
$ fonoster sipnet:credentials:update
_See code: dist/commands/sipnet/credentials/update.js_
add a new Domain to the SIP network
USAGE
$ fonoster sipnet:domains:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new Domain to the SIP network
EXAMPLES
$ fonoster sipnet:domains:create
_See code: dist/commands/sipnet/domains/create.js_
delete a Domain from the active Workspace
USAGE
$ fonoster sipnet:domains:delete REF [-i]ARGUMENTS
REF the Domain reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete a Domain from the active Workspace
EXAMPLES
$ fonoster sipnet:domains:delete
_See code: dist/commands/sipnet/domains/delete.js_
retrieve details of a Domain by reference
USAGE
$ fonoster sipnet:domains:get REF [-i]ARGUMENTS
REF The Domain reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a Domain by reference
EXAMPLES
$ fonoster sipnet:domains:get
_See code: dist/commands/sipnet/domains/get.js_
display all Domains in the SIP network
USAGE
$ fonoster sipnet:domains:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all Domains in the SIP network
EXAMPLES
$ fonoster sipnet:domains:list
_See code: dist/commands/sipnet/domains/list.js_
modify the configuration of a Domain
USAGE
$ fonoster sipnet:domains:update REF [-i]ARGUMENTS
REF the Domain reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the configuration of a Domain
EXAMPLES
$ fonoster sipnet:domains:update
_See code: dist/commands/sipnet/domains/update.js_
add a new Number to the SIP network
USAGE
$ fonoster sipnet:numbers:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new Number to the SIP network
EXAMPLES
$ fonoster sipnet:numbers:create
_See code: dist/commands/sipnet/numbers/create.js_
delete a Number from the active Workspace
USAGE
$ fonoster sipnet:numbers:delete REF [-i]ARGUMENTS
REF the Numbers's reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
delete a Number from the active Workspace
EXAMPLES
$ fonoster sipnet:numbers:delete
_See code: dist/commands/sipnet/numbers/delete.js_
retrieve details of a Number by reference
USAGE
$ fonoster sipnet:numbers:get REF [-i]ARGUMENTS
REF the Number to show details about
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a Number by reference
EXAMPLES
$ fonoster sipnet:numbers:get
_See code: dist/commands/sipnet/numbers/get.js_
associate a Twilio number with a Fonoster Application
USAGE
$ fonoster sipnet:numbers:linkTwilioNumber [-i] [-b ] [-a ]FLAGS
-a, --access-control-list= [default: 165.22.7.155/32] the access control list to allow (use if running your
Fonoster instance)
-b, --outbound-uri-base= [default: pstn.fonoster.com] the uri to point twilio to for outbound calls (use if
running your Fonoster instance)
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
associate a Twilio number with a Fonoster Application
EXAMPLES
$ fonoster sipnet:numbers:linkTwilioNumber
_See code: dist/commands/sipnet/numbers/linkTwilioNumber.js_
display all Numbers in the active Workspace
USAGE
$ fonoster sipnet:numbers:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to return
DESCRIPTION
display all Numbers in the active Workspace
EXAMPLES
$ fonoster sipnet:numbers:list
_See code: dist/commands/sipnet/numbers/list.js_
modify the configuration of a Number
USAGE
$ fonoster sipnet:numbers:update REF [-i]ARGUMENTS
REF the Number to update
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the configuration of a Number
EXAMPLES
$ fonoster sipnet:numbers:update
_See code: dist/commands/sipnet/numbers/update.js_
add a new Trunk to the SIP network
USAGE
$ fonoster sipnet:trunks:create [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
add a new Trunk to the SIP network
EXAMPLES
$ fonoster sipnet:trunks:create
_See code: dist/commands/sipnet/trunks/create.js_
remove a Trunk from the active Workspace
USAGE
$ fonoster sipnet:trunks:delete REF [-i]ARGUMENTS
REF the Trunk's reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
remove a Trunk from the active Workspace
EXAMPLES
$ fonoster sipnet:trunks:delete
_See code: dist/commands/sipnet/trunks/delete.js_
retrieve details of a Trunk by reference
USAGE
$ fonoster sipnet:trunks:get REF [-i]ARGUMENTS
REF The Trunk's reference
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
retrieve details of a Trunk by reference
EXAMPLES
$ fonoster sipnet:trunks:get
_See code: dist/commands/sipnet/trunks/get.js_
display all Trunks in the active Workspace
USAGE
$ fonoster sipnet:trunks:list [-i] [-s ]FLAGS
-i, --insecure allow connections to a server with no TLS
-s, --page-size= [default: 1000] the number of items to show
DESCRIPTION
display all Trunks in the active Workspace
EXAMPLES
$ fonoster sipnet:trunks:list
_See code: dist/commands/sipnet/trunks/list.js_
modify the configuration of a Trunk
USAGE
$ fonoster sipnet:trunks:update REF [-i]ARGUMENTS
REF the Trunk to update
FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
modify the configuration of a Trunk
EXAMPLES
$ fonoster sipnet:trunks:update
_See code: dist/commands/sipnet/trunks/update.js_
display the name of the active Workspace
USAGE
$ fonoster workspaces:activeDESCRIPTION
display the name of the active Workspace
EXAMPLES
$ fonoster workspaces:active
_See code: dist/commands/workspaces/active.js_
display all linked Workspaces
USAGE
$ fonoster workspaces:listDESCRIPTION
display all linked Workspaces
EXAMPLES
$ fonoster workspaces:list
_See code: dist/commands/workspaces/list.js_
link a Workspace to the local environment
USAGE
$ fonoster workspaces:login [-i]FLAGS
-i, --insecure allow connections to a server with no TLS
DESCRIPTION
link a Workspace to the local environment
EXAMPLES
$ fonoster workspaces:login
_See code: dist/commands/workspaces/login.js_
unlink a Workspace from the local environment
USAGE
$ fonoster workspaces:logout REFARGUMENTS
REF the Workspace to unlink from
DESCRIPTION
unlink a Workspace from the local environment
EXAMPLES
$ fonoster workspaces:logout
_See code: dist/commands/workspaces/logout.js_
set a Workspace as the default
USAGE
$ fonoster workspaces:use REFARGUMENTS
REF The Workspace to unlink from
DESCRIPTION
set a Workspace as the default
EXAMPLES
$ fonoster workspaces:use
_See code: dist/commands/workspaces/use.js_