This software is in pre-release status and not currently supported. We are looking for community feedback on what type of CLI tool would be the most useful for Twilio users.
sudo apt-get install libsecret-1-dev
sudo yum install libsecret-devel
sudo pacman -S libsecret
Eventually, the plan is to have self-contained packages for *nix systems and an installer for Windows with no need for manually installing prerequisites.
npm install -g twilio-cli
./bin/runfrom the repo directory to run the CLI.
which is an alias for:
twilio project:add -p default
This is for caching your credentials for your existing Twilio account (aka Project) locally. Note, while you are prompted for your Account SID and Auth Token, these are not saved. An API Key is created (look for "Twilio CLI on [hostname]" in the console) and stored in your system's keychain.
Lists all available commands.
Lists all your phone numbers. (
number is a shorthand alias for the full resource name,
--help to any command to get help (e.g.
twilio number:list --help)
You can set a webhook on a phone number like so:
twilio number:update [PN sid or E.164] --sms-url http://url
That sets the primary SMS url. There are also options for setting the voice url, fallback url's, and methods for each. Run
twilio number:update --help for a full list of options.
When you set a webhook, if you specify a URL that uses the host name of
127.0.0.1, the Twilio CLI will automatically create an ngrok tunnel for you and set your webhook to the new ngrok URL. For example:
twilio number:update [PN sid or E.164] --sms-url http://localhost:5000/handle_sms
All command output is sent to
stdout (whereas logging messages are sent to
By default, the output is formatted in human readable form in a columnar format like so:
SID Phone Number Friendly Name PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +1209242XXXX SIP testing PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +1646887XXXX Congress hotline PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +1209337XXXX DAVID'S TWILIO CONTACT
list commands will allow you to specify a
--properties option to specify which columns you'd like to display. For example, to display only the Phone Number and SMS Url columns, you would pass
--properties "phoneNumber, smsUrl".
Note that currently, the column names must match the JSON property names in the Twilio API.
On any command, you can add
-o json to change the output format to JSON. When you choose JSON, the command will send the entire API response to
stdout as JSON. You can then pipe to tools like jq to parse the JSON.
To change the output format to tab separated values (TSV), add
-o tsv to the command line. This format is useful for loading into spreadsheets or for other machine processing. Like the default, columnar output format, you can use the
--properties option to specify which columns you would like included.
All debug, informational, warning, and error information is sent to
stderr. This is so it can be easily separated from the command output. You can decide what level of logging you'd like by using the
-l option. The valid levels of logging messages are
To store credentials for multiple projects, you can use a shorthand "project id" which is just an easy to remember, short string to identify the project. (If you've used
git before, it's like the name you assign to a remote like "origin".)
When you run
twilio login, it stores your credentials under a project called
default. This is the project that will be used for all subsequent commands.
To add a second project after the default project, you can run
twilio login -p my_other_proj (using whatever identifier you'd like in place of
my_other_proj). Then, when you run subsequent commands, just include the
-p my_other_proj in the command (e.g.
twilio number:list -p my_other_proj).
Please file a GitHub issue in this repository for any feedback you may have.