npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@fonoster/ctl

v0.34.3

Published

Fonoster Control Tool

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

fonoster-ossfonoster-oss

Keywords

Readme

ctl

Command-Line for Fonoster

command-line tool Version Downloads/week License

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.

On the new platform: applications:* manage streams (your WebSocket server: URL, protocol, speech defaults as catalog ids, listeners, recording, fallback) and Autopilot agents (--agent); webhooks:* manage workspace webhooks and their delivery log; records:* search call records and download recordings and vCons; providers:* list the provider catalog and manage the workspace's vendor keys. See Try the new platform.

When connecting to your own instance of Fonoster, remember to use your endpoint when login in. If your install uses its generated certificate, trust it with --ca-file <path to its config/tls/ca.pem> (or FONOSTER_CA_FILE). The CLI always uses TLS.

Usage

$ npm install -g @fonoster/ctl
$ fonoster COMMAND
running command...
$ fonoster (--version)
@fonoster/ctl/0.27.0 darwin-arm64 node-v22.17.0
$ fonoster --help [COMMAND]
USAGE
  $ fonoster COMMAND
...

Commands

fonoster apikeys:create

create an API key for the active Workspace

USAGE
  $ fonoster apikeys:create [-e <value>] [-r <value>]

FLAGS
  -e, --expiration=<value>  API Key expiration time in days(e.g. 10d) or months(e.g. 10m)
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -r, --role=<value>        [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

fonoster apikeys:delete REF

delete an API key from the active Workspace

USAGE
  $ fonoster apikeys:delete REF 

ARGUMENTS
  REF  the ApiKey to delete from the Workspace

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete an API key from the active Workspace

EXAMPLES
  $ fonoster apikeys:delete

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

fonoster apikeys:list

display all API keys in the active Workspace

USAGE
  $ fonoster apikeys:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster apikeys:regenerate REF

generate a new access key secret for an API key

USAGE
  $ fonoster apikeys:regenerate REF 

ARGUMENTS
  REF  the Application to update

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  generate a new access key secret for an API key

EXAMPLES
  $ fonoster apikeys:regenerate

See code: dist/commands/apikeys/regenerate.js

fonoster applications:create

add a new Application to the active Workspace

USAGE
  $ fonoster applications:create [-f <value>] [-n <value>] [-u <value>] [--protocol fonoster|twilio] [-a <value>]
    [--voice <value>] [--language <value>] [--stt-model <value>] [--tts-model <value>] [--silence-timeout <value>]
    [--patience low|normal|high] [--audio-codec pcm16|pcmu] [--audio-rate <value>] [--fallback-app <value>]
    [--fallback-message <value>] [-l <value>...] [--clear-listeners] [--recording off|on|consent]

FLAGS
  -a, --agent=<value>             a YAML or JSON agent file; makes it an Autopilot agent (hosted by Fonoster)
  -f, --from-file=<value>         a YAML or JSON file with the Application (an `agent` key makes it an Autopilot
                                  agent)
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -l, --listener=<value>...       a listen-only socket: <wss-url>[,inbound|outbound|both] (repeatable, at most 4)
  -n, --name=<value>              the Application name
  -u, --url=<value>               the stream's WebSocket URL (ws:// or wss://)
      --audio-codec=<option>      audio frames for fonoster-protocol streams
                                  <options: pcm16|pcmu>
      --audio-rate=<value>        audio sample rate for fonoster-protocol streams: 8000, 16000 or 24000 (pcmu is 8000 only)
      --clear-listeners           remove the current listeners (update; combine with --listener to replace)
      --fallback-app=<value>      the Application to hand the call to when this app fails
      --fallback-message=<value>  what the caller hears when the app fails and no fallback app answers
      --protocol=<option>         the protocol the stream speaks
                                  <options: fonoster|twilio>
      --language=<value>          speech language (e.g. en-US)
      --patience=<option>         how long to wait before taking the turn
                                  <options: low|normal|high>
      --recording=<option>        the recording policy
                                  <options: off|on|consent>
      --silence-timeout=<value>   milliseconds of caller silence before a silence event
      --stt-model=<value>         STT model as a catalog id (e.g. deepgram/nova-3)
      --tts-model=<value>         TTS model as a catalog id (e.g. elevenlabs/eleven_flash_v2_5)
      --voice=<value>             TTS voice as a catalog id (e.g. deepgram/aura-2-thalia-en)

DESCRIPTION
  add a new Application to the active Workspace

EXAMPLES
  $ fonoster applications:create --name Bot --url wss://bot.example.com/session

  $ fonoster applications:create --name Bot --url wss://bot.example.com/media --protocol twilio

  $ fonoster applications:create --name Receptionist --agent agent.yaml --voice deepgram/aura-2-thalia-en

  $ fonoster applications:create --from-file app.yaml

  $ fonoster applications:create   # asks for the basics

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

fonoster applications:delete REF

delete an Application from the active Workspace

USAGE
  $ fonoster applications:delete REF 

ARGUMENTS
  REF  the Application to delete

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete an Application from the active Workspace

EXAMPLES
  $ fonoster applications:delete

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

fonoster applications:eval

experimental command to test an Autopilot agent

USAGE
  $ fonoster applications:eval -f <value> [-o pretty|json] [--output-file <value>]

FLAGS
  -f, --file=<value>         (required) path to test cases file (json, yaml, or yml)
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -o, --output=<option>      [default: pretty] output format
                             <options: pretty|json>
      --output-file=<value>  write JSON summary to this file (with pretty: also show streamed output)

DESCRIPTION
  experimental command to test an Autopilot agent

EXAMPLES
  $ fonoster applications:eval -f agent.json

  $ fonoster applications:eval -f agent.yaml

  $ fonoster applications:eval -f agent.yaml -o json

  $ fonoster applications:eval -f agent.yaml -o json --output-file results.json

See code: dist/commands/applications/eval.js

fonoster applications:get REF

retrieve details of an Application by reference

USAGE
  $ fonoster applications:get REF 

ARGUMENTS
  REF  The Application to show details about

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of an Application by reference

EXAMPLES
  $ fonoster applications:get <ref>

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

fonoster applications:list

display all Applications in the active Workspace

USAGE
  $ fonoster applications:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster applications:rotate-secret REF

issue a new signing secret for an Application (the old one stops working)

USAGE
  $ fonoster applications:rotate-secret REF 

ARGUMENTS
  REF  the Application whose secret to rotate

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  issue a new signing secret for an Application (the old one stops working)

EXAMPLES
  $ fonoster applications:rotate-secret <ref>

See code: dist/commands/applications/rotate-secret.js

fonoster applications:update [REF]

modify an Application (only the fields you pass change)

USAGE
  $ fonoster applications:update [REF] [-f <value>] [-n <value>] [-u <value>] [--protocol fonoster|twilio] [-a <value>]
    [--voice <value>] [--language <value>] [--stt-model <value>] [--tts-model <value>] [--silence-timeout <value>]
    [--patience low|normal|high] [--audio-codec pcm16|pcmu] [--audio-rate <value>] [--fallback-app <value>]
    [--fallback-message <value>] [-l <value>...] [--clear-listeners] [--recording off|on|consent]

ARGUMENTS
  [REF]  the Application to update (optional when `ref` is set in --from-file)

FLAGS
  -a, --agent=<value>             a YAML or JSON agent file; makes it an Autopilot agent (hosted by Fonoster)
  -f, --from-file=<value>         a YAML or JSON file with the Application (an `agent` key makes it an Autopilot
                                  agent)
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -l, --listener=<value>...       a listen-only socket: <wss-url>[,inbound|outbound|both] (repeatable, at most 4)
  -n, --name=<value>              the Application name
  -u, --url=<value>               the stream's WebSocket URL (ws:// or wss://)
      --audio-codec=<option>      audio frames for fonoster-protocol streams
                                  <options: pcm16|pcmu>
      --audio-rate=<value>        audio sample rate for fonoster-protocol streams: 8000, 16000 or 24000 (pcmu is 8000 only)
      --clear-listeners           remove the current listeners (update; combine with --listener to replace)
      --fallback-app=<value>      the Application to hand the call to when this app fails
      --fallback-message=<value>  what the caller hears when the app fails and no fallback app answers
      --protocol=<option>         the protocol the stream speaks
                                  <options: fonoster|twilio>
      --language=<value>          speech language (e.g. en-US)
      --patience=<option>         how long to wait before taking the turn
                                  <options: low|normal|high>
      --recording=<option>        the recording policy
                                  <options: off|on|consent>
      --silence-timeout=<value>   milliseconds of caller silence before a silence event
      --stt-model=<value>         STT model as a catalog id (e.g. deepgram/nova-3)
      --tts-model=<value>         TTS model as a catalog id (e.g. elevenlabs/eleven_flash_v2_5)
      --voice=<value>             TTS voice as a catalog id (e.g. deepgram/aura-2-thalia-en)

DESCRIPTION
  modify an Application (only the fields you pass change)

EXAMPLES
  $ fonoster applications:update <ref> --voice elevenlabs/rachel --patience high

  $ fonoster applications:update <ref> --agent agent.yaml

  $ fonoster applications:update <ref> --clear-listeners --listener wss://rec.example.com/ws,inbound

  $ fonoster applications:update --from-file app.yaml   # with `ref` in the file

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

fonoster bug

report a bug to the development team 🐞

USAGE
  $ fonoster bug

DESCRIPTION
  report a bug to the development team 🐞

EXAMPLES
  $ fonoster bug

See code: dist/commands/bug.js

fonoster feedback

provide feedback on your experience

USAGE
  $ fonoster feedback

DESCRIPTION
  provide feedback on your experience
  ...
  Help us improve by providing some feedback


EXAMPLES
  $ fonoster feedback

See code: dist/commands/feedback.js

fonoster mcp:configure

configure MCP client settings

USAGE
  $ fonoster mcp:configure [-c claude] [-w <value>]

FLAGS
  -c, --client=<option>    [default: claude] MCP client to configure
                           <options: claude>
  -w, --workspace=<value>  workspace reference

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

fonoster providers:catalog

list the provider catalog: the providers, models and voices apps can use (catalog ids)

USAGE
  $ fonoster providers:catalog [-k provider|model|voice] [-t stt|tts|llm]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -k, --kind=<option>  only this kind of item
                       <options: provider|model|voice>
  -t, --type=<option>  only this capability
                       <options: stt|tts|llm>

DESCRIPTION
  list the provider catalog: the providers, models and voices apps can use (catalog ids)

EXAMPLES
  $ fonoster providers:catalog

  $ fonoster providers:catalog --kind voice

  $ fonoster providers:catalog --kind model --type stt

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

fonoster providers:keys:delete PROVIDER

remove the Workspace's key for a vendor (calls fall back to the platform's key, if any)

USAGE
  $ fonoster providers:keys:delete PROVIDER 

ARGUMENTS
  PROVIDER  the provider id

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  remove the Workspace's key for a vendor (calls fall back to the platform's key, if any)

EXAMPLES
  $ fonoster providers:keys:delete deepgram

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

fonoster providers:keys:list

list the vendors the Workspace has its own key for (keys are never shown)

USAGE
  $ fonoster providers:keys:list 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  list the vendors the Workspace has its own key for (keys are never shown)

EXAMPLES
  $ fonoster providers:keys:list

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

fonoster providers:keys:set PROVIDER

set the Workspace's own key for a speech or LLM vendor (replaces any previous key)

USAGE
  $ fonoster providers:keys:set PROVIDER [--key <value>]

ARGUMENTS
  PROVIDER  the provider id (see providers:catalog --kind provider)

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
      --key=<value>  the vendor key (omit to type it without echo)

DESCRIPTION
  set the Workspace's own key for a speech or LLM vendor (replaces any previous key)

EXAMPLES
  $ fonoster providers:keys:set deepgram            # asks for the key

  $ fonoster providers:keys:set elevenlabs --key $ELEVENLABS_API_KEY

See code: dist/commands/providers/keys/set.js

fonoster records:download REF

save a call's recording (WAV), vCon (JSON) or signed vCon (JWS) to a file

USAGE
  $ fonoster records:download REF [-p recording|vcon|signed] [-o <value>] [--version <value>] [--original]

ARGUMENTS
  REF  the call (callRef)

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -o, --output=<value>   the file to write (default <call-ref>.<ext>)
  -p, --part=<option>    [default: recording] what to download
                         <options: recording|vcon|signed>
      --original         the unredacted record (owner or admin)
      --version=<value>  a record version (default latest)

DESCRIPTION
  save a call's recording (WAV), vCon (JSON) or signed vCon (JWS) to a file

EXAMPLES
  $ fonoster records:download <call-ref>                 # <call-ref>.wav

  $ fonoster records:download <call-ref> --part vcon -o call.json

  $ fonoster records:download <call-ref> --part signed   # verifiable JWS

See code: dist/commands/records/download.js

fonoster records:get REF

show the summary of a call record (use records:download for the files)

USAGE
  $ fonoster records:get REF [--version <value>] [--original]

ARGUMENTS
  REF  the call (callRef)

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
      --original         the unredacted record (owner or admin)
      --version=<value>  a record version (default latest)

DESCRIPTION
  show the summary of a call record (use records:download for the files)

EXAMPLES
  $ fonoster records:get <call-ref>

  $ fonoster records:get <call-ref> --original --version 1

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

fonoster records:list

search the call records (vCon) of the active Workspace, newest first

USAGE
  $ fonoster records:list [--after <value>] [--before <value>] [--number <value>] [--app <value>] [--status
    <value>] [-s <value>] [-t <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>   [default: 50] the number of items to show
  -t, --page-token=<value>  the token for the next page (printed after a full page)
      --after=<value>       started at or after (ISO date/time)
      --app=<value>         calls handled by this Application
      --before=<value>      started before (ISO date/time)
      --number=<value>      calls from or to this number
      --status=<value>      record status (e.g. sealed, failed)

DESCRIPTION
  search the call records (vCon) of the active Workspace, newest first

EXAMPLES
  $ fonoster records:list

  $ fonoster records:list --after 2026-10-01 --number +17853178070

  $ fonoster records:list --app <app-ref> --status failed

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

fonoster secrets:create

add a new Secret to the active Workspace

USAGE
  $ fonoster secrets:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new Secret to the active Workspace

EXAMPLES
  $ fonoster secrets:create

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

fonoster secrets:delete REF

delete a Secret from the active Workspace

USAGE
  $ fonoster secrets:delete REF 

ARGUMENTS
  REF  the Secret reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a Secret from the active Workspace

EXAMPLES
  $ fonoster secrets:delete

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

fonoster secrets:get REF

retrieve details of a Secret by reference

USAGE
  $ fonoster secrets:get REF 

ARGUMENTS
  REF  The Secret to show details about

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a Secret by reference

EXAMPLES
  $ fonoster secrets:get

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

fonoster secrets:list

display all Secrets in the active Workspace

USAGE
  $ fonoster secrets:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster secrets:update REF

modify the value or metadata of a Secret

USAGE
  $ fonoster secrets:update REF 

ARGUMENTS
  REF  the Secret to update

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  modify the value or metadata of a Secret

EXAMPLES
  $ fonoster secrets:update

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

fonoster sipnet:acls:create

create a new Access Control List (ACL)

USAGE
  $ fonoster sipnet:acls:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  create a new Access Control List (ACL)

EXAMPLES
  $ fonoster sipnet:acls:create

See code: dist/commands/sipnet/acls/create.js

fonoster sipnet:acls:delete REF

remove an Access Control List (ACL) from the Workspace

USAGE
  $ fonoster sipnet:acls:delete REF 

ARGUMENTS
  REF  the ACL reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  remove an Access Control List (ACL) from the Workspace

EXAMPLES
  $ fonoster sipnet:acls:delete

See code: dist/commands/sipnet/acls/delete.js

fonoster sipnet:acls:get REF

get a specific Access Control List (ACL)

USAGE
  $ fonoster sipnet:acls:get REF 

ARGUMENTS
  REF  The ACL reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  get a specific Access Control List (ACL)

EXAMPLES
  $ fonoster sipnet:acls:get

See code: dist/commands/sipnet/acls/get.js

fonoster sipnet:acls:list

list all Access Control Lists (ACLs)

USAGE
  $ fonoster sipnet:acls:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:acls:update REF

update an existing Access Control List (ACL)

USAGE
  $ fonoster sipnet:acls:update REF 

ARGUMENTS
  REF  the ACL reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  update an existing Access Control List (ACL)

EXAMPLES
  $ fonoster sipnet:acls:update

See code: dist/commands/sipnet/acls/update.js

fonoster sipnet:agents:create

add a new SIP Agent to the network

USAGE
  $ fonoster sipnet:agents:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new SIP Agent to the network

EXAMPLES
  $ fonoster sipnet:agents:create

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

fonoster sipnet:agents:delete REF

delete a SIP Agent from the network

USAGE
  $ fonoster sipnet:agents:delete REF 

ARGUMENTS
  REF  the Agent reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a SIP Agent from the network

EXAMPLES
  $ fonoster sipnet:agents:delete

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

fonoster sipnet:agents:get REF

retrieve details of a SIP Agent

USAGE
  $ fonoster sipnet:agents:get REF 

ARGUMENTS
  REF  The Agent reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a SIP Agent

EXAMPLES
  $ fonoster sipnet:agents:get

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

fonoster sipnet:agents:list

display all SIP Agents in the network

USAGE
  $ fonoster sipnet:agents:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:agents:update REF

add a new SIP Agent to the network

USAGE
  $ fonoster sipnet:agents:update REF 

ARGUMENTS
  REF  the ACL reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new SIP Agent to the network

EXAMPLES
  $ fonoster sipnet:agents:update

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

fonoster sipnet:calls:create

place an outbound call to a phone number or SIP URI and follow its status

USAGE
  $ fonoster sipnet:calls:create -f <value> -t <value> -a <value> [-o <value>] [-m <value>] [-d]

FLAGS
  -a, --app-ref=<value>   (required) the Application that handles the call
  -d, --detach            print the call ref and return without following the status
  -f, --from=<value>      (required) the number to make the call from
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -m, --metadata=<value>  a JSON object the app receives with the session (e.g. '{"name": "John Doe"}')
  -o, --timeout=<value>   [default: 30] seconds to wait for an answer
  -t, --to=<value>        (required) the number or SIP URI to call

DESCRIPTION
  place an outbound call to a phone number or SIP URI and follow its status

EXAMPLES
  $ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref>

  $ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref> --detach

  $ fonoster sipnet:calls:create -f +17853178070 -t +18287854037 -a <app-ref> -m '{"name":"Jane"}'

See code: dist/commands/sipnet/calls/create.js

fonoster sipnet:calls:get REF

get a specific Access Control List (ACL)

USAGE
  $ fonoster sipnet:calls:get REF 

ARGUMENTS
  REF  The ACL reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  get a specific Access Control List (ACL)

EXAMPLES
  $ fonoster sipnet:calls:get

See code: dist/commands/sipnet/calls/get.js

fonoster sipnet:calls:list

display all calls made in the active Workspace

USAGE
  $ fonoster sipnet:calls:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:credentials:create

add a new set of Credentials to the network

USAGE
  $ fonoster sipnet:credentials:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new set of Credentials to the network

EXAMPLES
  $ fonoster sipnet:credentials:create

See code: dist/commands/sipnet/credentials/create.js

fonoster sipnet:credentials:delete REF

delete a set of Credentials from the active Workspace

USAGE
  $ fonoster sipnet:credentials:delete REF 

ARGUMENTS
  REF  the Credentials reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a set of Credentials from the active Workspace

EXAMPLES
  $ fonoster sipnet:credentials:delete

See code: dist/commands/sipnet/credentials/delete.js

fonoster sipnet:credentials:get REF

retrieve details of a set of Credentials by reference

USAGE
  $ fonoster sipnet:credentials:get REF 

ARGUMENTS
  REF  The Credentials reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a set of Credentials by reference

EXAMPLES
  $ fonoster sipnet:credentials:get

See code: dist/commands/sipnet/credentials/get.js

fonoster sipnet:credentials:list

display all Credentials in the active Workspace

USAGE
  $ fonoster sipnet:credentials:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:credentials:update REF

modify the values or metadata of a set of Credentials

USAGE
  $ fonoster sipnet:credentials:update REF 

ARGUMENTS
  REF  the Credentials reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  modify the values or metadata of a set of Credentials

EXAMPLES
  $ fonoster sipnet:credentials:update

See code: dist/commands/sipnet/credentials/update.js

fonoster sipnet:domains:create

add a new Domain to the SIP network

USAGE
  $ fonoster sipnet:domains:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new Domain to the SIP network

EXAMPLES
  $ fonoster sipnet:domains:create

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

fonoster sipnet:domains:delete REF

delete a Domain from the active Workspace

USAGE
  $ fonoster sipnet:domains:delete REF 

ARGUMENTS
  REF  the Domain reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a Domain from the active Workspace

EXAMPLES
  $ fonoster sipnet:domains:delete

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

fonoster sipnet:domains:get REF

retrieve details of a Domain by reference

USAGE
  $ fonoster sipnet:domains:get REF 

ARGUMENTS
  REF  The Domain reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a Domain by reference

EXAMPLES
  $ fonoster sipnet:domains:get

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

fonoster sipnet:domains:list

display all Domains in the SIP network

USAGE
  $ fonoster sipnet:domains:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:domains:update REF

modify the configuration of a Domain

USAGE
  $ fonoster sipnet:domains:update REF 

ARGUMENTS
  REF  the Domain reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  modify the configuration of a Domain

EXAMPLES
  $ fonoster sipnet:domains:update

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

fonoster sipnet:numbers:create

add a new Number to the SIP network

USAGE
  $ fonoster sipnet:numbers:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new Number to the SIP network

EXAMPLES
  $ fonoster sipnet:numbers:create

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

fonoster sipnet:numbers:delete REF

delete a Number from the active Workspace

USAGE
  $ fonoster sipnet:numbers:delete REF 

ARGUMENTS
  REF  the Numbers's reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a Number from the active Workspace

EXAMPLES
  $ fonoster sipnet:numbers:delete

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

fonoster sipnet:numbers:get REF

retrieve details of a Number by reference

USAGE
  $ fonoster sipnet:numbers:get REF 

ARGUMENTS
  REF  the Number to show details about

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a Number by reference

EXAMPLES
  $ fonoster sipnet:numbers:get

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

fonoster sipnet:numbers:linkTwilioNumber

associate a Twilio number with a Fonoster Application

USAGE
  $ fonoster sipnet:numbers:linkTwilioNumber [-b <value>] [-a <value>]

FLAGS
  -a, --access-control-list=<value>  [default: 165.22.7.155/32] the access control list to allow (use if running your
                                     Fonoster instance)
  -b, --outbound-uri-base=<value>    the host Twilio sends calls to, under which the trunk's inbound URI is made
                                     (default: pstn.<the server's domain>)
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  associate a Twilio number with a Fonoster Application

EXAMPLES
  $ fonoster sipnet:numbers:linkTwilioNumber

See code: dist/commands/sipnet/numbers/linkTwilioNumber.js

fonoster sipnet:numbers:list

display all Numbers in the active Workspace

USAGE
  $ fonoster sipnet:numbers:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:numbers:update REF

modify the configuration of a Number

USAGE
  $ fonoster sipnet:numbers:update REF 

ARGUMENTS
  REF  the Number to update

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  modify the configuration of a Number

EXAMPLES
  $ fonoster sipnet:numbers:update

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

fonoster sipnet:trunks:create

add a new Trunk to the SIP network

USAGE
  $ fonoster sipnet:trunks:create 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  add a new Trunk to the SIP network

EXAMPLES
  $ fonoster sipnet:trunks:create

See code: dist/commands/sipnet/trunks/create.js

fonoster sipnet:trunks:delete REF

remove a Trunk from the active Workspace

USAGE
  $ fonoster sipnet:trunks:delete REF 

ARGUMENTS
  REF  the Trunk's reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  remove a Trunk from the active Workspace

EXAMPLES
  $ fonoster sipnet:trunks:delete

See code: dist/commands/sipnet/trunks/delete.js

fonoster sipnet:trunks:get REF

retrieve details of a Trunk by reference

USAGE
  $ fonoster sipnet:trunks:get REF 

ARGUMENTS
  REF  The Trunk's reference

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a Trunk by reference

EXAMPLES
  $ fonoster sipnet:trunks:get

See code: dist/commands/sipnet/trunks/get.js

fonoster sipnet:trunks:list

display all Trunks in the active Workspace

USAGE
  $ fonoster sipnet:trunks:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [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

fonoster sipnet:trunks:update REF

modify the configuration of a Trunk

USAGE
  $ fonoster sipnet:trunks:update REF 

ARGUMENTS
  REF  the Trunk to update

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  modify the configuration of a Trunk

EXAMPLES
  $ fonoster sipnet:trunks:update

See code: dist/commands/sipnet/trunks/update.js

fonoster webhooks:create

subscribe an HTTPS endpoint to Workspace events

USAGE
  $ fonoster webhooks:create -u <value> -e
    call.started|call.ended|call.failed|call_record.sealed|provider.deprecated... 

FLAGS
  -e, --event=<option>...  (required) an event to receive (repeatable): call.started, call.ended, call.failed,
                           call_record.sealed, provider.deprecated
                           <options: call.started|call.ended|call.failed|call_record.sealed|provider.deprecated>
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -u, --url=<value>        (required) the endpoint that receives the events (https://)

DESCRIPTION
  subscribe an HTTPS endpoint to Workspace events

EXAMPLES
  $ fonoster webhooks:create --url https://example.com/hooks -e call.ended -e call_record.sealed

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

fonoster webhooks:delete REF

delete a Webhook from the active Workspace

USAGE
  $ fonoster webhooks:delete REF 

ARGUMENTS
  REF  the Webhook to delete

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  delete a Webhook from the active Workspace

EXAMPLES
  $ fonoster webhooks:delete <ref>

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

fonoster webhooks:deliveries [REF]

show the delivery log (all Webhooks, or one)

USAGE
  $ fonoster webhooks:deliveries [REF] [-s <value>]

ARGUMENTS
  [REF]  only this Webhook's deliveries

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [default: 50] the number of items to show

DESCRIPTION
  show the delivery log (all Webhooks, or one)

EXAMPLES
  $ fonoster webhooks:deliveries

  $ fonoster webhooks:deliveries <webhook-ref> -s 20

See code: dist/commands/webhooks/deliveries.js

fonoster webhooks:get REF

retrieve details of a Webhook by reference

USAGE
  $ fonoster webhooks:get REF 

ARGUMENTS
  REF  the Webhook to show details about

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  retrieve details of a Webhook by reference

EXAMPLES
  $ fonoster webhooks:get <ref>

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

fonoster webhooks:list

display all Webhooks in the active Workspace

USAGE
  $ fonoster webhooks:list [-s <value>]

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -s, --page-size=<value>  [default: 1000] the number of items to show

DESCRIPTION
  display all Webhooks in the active Workspace

EXAMPLES
  $ fonoster webhooks:list

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

fonoster webhooks:resend REF

send a delivery again (same event id, so receivers can dedupe)

USAGE
  $ fonoster webhooks:resend REF 

ARGUMENTS
  REF  the delivery to resend (see webhooks:deliveries)

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  send a delivery again (same event id, so receivers can dedupe)

EXAMPLES
  $ fonoster webhooks:resend <delivery-ref>

See code: dist/commands/webhooks/resend.js

fonoster webhooks:rotate REF

issue a new signing secret for a Webhook (the old one keeps working for a while)

USAGE
  $ fonoster webhooks:rotate REF 

ARGUMENTS
  REF  the Webhook whose secret to rotate

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  issue a new signing secret for a Webhook (the old one keeps working for a while)

EXAMPLES
  $ fonoster webhooks:rotate <ref>

See code: dist/commands/webhooks/rotate.js

fonoster webhooks:update REF

change a Webhook's URL or events (--event replaces the list)

USAGE
  $ fonoster webhooks:update REF [-u <value>] [-e
    call.started|call.ended|call.failed|call_record.sealed|provider.deprecated...]

ARGUMENTS
  REF  the Webhook to update

FLAGS
  -e, --event=<option>...  an event to receive (repeatable): call.started, call.ended, call.failed, call_record.sealed,
                           provider.deprecated
                           <options: call.started|call.ended|call.failed|call_record.sealed|provider.deprecated>
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)
  -u, --url=<value>        the new endpoint

DESCRIPTION
  change a Webhook's URL or events (--event replaces the list)

EXAMPLES
  $ fonoster webhooks:update <ref> -e call.started -e call.ended

  $ fonoster webhooks:update <ref> --url https://example.com/new

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

fonoster workspaces:active

display the name of the active Workspace

USAGE
  $ fonoster workspaces:active

DESCRIPTION
  display the name of the active Workspace

EXAMPLES
  $ fonoster workspaces:active

See code: dist/commands/workspaces/active.js

fonoster workspaces:list

display all linked Workspaces

USAGE
  $ fonoster workspaces:list

DESCRIPTION
  display all linked Workspaces

EXAMPLES
  $ fonoster workspaces:list

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

fonoster workspaces:login

link a Workspace to the local environment

USAGE
  $ fonoster workspaces:login 

FLAGS
      --ca-file=<value>  a PEM file of certificate authorities to trust (default: FONOSTER_CA_FILE)

DESCRIPTION
  link a Workspace to the local environment

EXAMPLES
  $ fonoster workspaces:login

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

fonoster workspaces:logout REF

unlink a Workspace from the local environment

USAGE
  $ fonoster workspaces:logout REF

ARGUMENTS
  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

fonoster workspaces:use REF

set a Workspace as the default

USAGE
  $ fonoster workspaces:use REF

ARGUMENTS
  REF  The Workspace to unlink from

DESCRIPTION
  set a Workspace as the default

EXAMPLES
  $ fonoster workspaces:use

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