Command-Line Interface (CLI) Quickstart
This Twilio product is currently available as a Beta release. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA. Learn more about beta product support.
twilio-cli allows you to manage your Twilio resources from your terminal or command prompt. Let’s get it installed and take a quick tour.
Install twilio-cli
Install using Homebrew
To install twilio-cli on macOS using Homebrew, run:
brew tap twilio/brew && brew install twilioInstall using Scoop
To install twilio-cli on Windows using Scoop, run PowerShell as an administrator and:
- Add the
twilio-cliBucket:
scoop bucket add twilio-scoop https://github.com/twilio/scoop-twilio-cli - Install the app:
scoop install twilio
Install using apt
To install twilio-cli on distributions such as Debian, Ubuntu, Linux Mint, and more using Advanced Package Tool (apt), run the following:
wget -qO- https://twilio-cli-prod.s3.amazonaws.com/twilio_pub.asc \
| sudo apt-key add -
sudo touch /etc/apt/sources.list.d/twilio.list
echo 'deb https://twilio-cli-prod.s3.amazonaws.com/apt/ /' \
| sudo tee /etc/apt/sources.list.d/twilio.list
sudo apt update
sudo apt install -y twilioRun the Docker image
To run the twilio-cli as a Docker image with an interactive bash shell, run:
docker run -it --rm twilio/twilio-cli bashConsult the dedicated twilio-cli Docker documentation for more details on usage.
Disclaimer
It’s strongly recommended to use one of the other installation methods if possible. An installation by npm does not auto-update, and uses your system’s version of Node.js, which may be older than the version Twilio develops twilio-cli against.
Install using npm
To globally install twilio-cli so that it can be used from any directory, use:
npm install -g twilio-cliRefer to the twilio-cli install and update documentation for more installation methods.
Login to your Twilio account
In order for twilio-cli to access your Twilio account and execute commands on your behalf, you need to log in and provide your Twilio credentials. This can be done by running:
twilio loginYou will be prompted for your Account SID and Auth Token, both of which you can find on the dashboard of your Twilio console.
This will create an API Key for you that will be stored securely and used to issue authenticated requests as you use twilio-cli. This secure API Key and your settings will be stored locally as a profile.
Refer to the general usage guide if you would like to use multiple accounts or profiles with twilio-cli on the same machine.
Install CLI autocomplete (bash or zsh only)
Autocomplete allows you to partially enter a parameter, command, or option, and either automatically complete the command or display suggestions for you. If you have autocomplete enabled, you can prompt twilio-cli for these suggestions by pressing the completion key (usually Tab in most shells).
Enable command autocomplete for twilio-cli by running the appropriate command for your shell:
twilio autocomplete bashtwilio autocomplete zshFollow the resulting instructions, and either restart your shell or open a new one to finish installing command autocomplete.
If suggestions are not appearing, double-check that you restarted your shell or opened a new instance since installing.
Exploring twilio-cli
The best way to learn about what you can do with twilio-cli is to just run the command:
twilioWhen you do, you will get a list of the various topics and commands available to run. Topics are groupings for more topics and commands, similar to the folder structure on your file system.
$ twilio
Unleash the power of Twilio from your command prompt. Visit https://twil.io/cli for documentation.
VERSION
twilio-cli/3.0.0 darwin-x64 node-v16.13.1
USAGE
$ twilio [COMMAND]
TOPICS
api advanced access to all of the Twilio APIs
config manage Twilio CLI configurations
debugger Show a list of log events generated for the account
email sends emails to single or multiple recipients using Twilio SendGrid
feedback provide feedback to the CLI team
phone-numbers manage Twilio phone numbers
plugins list available plugins for installation
profiles manage credentials for Twilio profiles
COMMANDS
autocomplete display autocomplete installation instructions
feedback provide feedback to the CLI team
help display help for twilio
login create a new profile to store Twilio Account credentials and configuration
plugins list installed plugins
update update the twilio CLISee something that looks interesting? Just try running it:
twilio apiSince api is a topic, you will actually be shown more topics and commands that are contained within that topic. Let’s say in the process of exploring, you stumbled upon this command:
twilio api:core:messages:listIf you run that command, it will list all of your SMS messages, which may be a lot. How can you filter them? Or, more generally, how can you discover what options a given CLI command provides? The answer is to add --help to the command like so:
twilio api:core:messages:list --helpIf you type a command, you might get an error if you haven’t provided all the required options. This is another situation where adding --help to the command can give you more information.
Examples
List your phone numbers
twilio phone-numbers:listSend a text message
twilio api:core:messages:create \
--from "+15017122661" \
--to "+15558675310" \
--body "I love you 3000"More examples
Please visit our examples page for a gallery of more examples.
What’s next?
Now that you’ve been introduced to twilio-cli, where should you go from here?
More examples
Please visit our examples page for more examples of the various things you can do with twilio-cli.
Explore plugins
twilio-cli can be extended via plugins. You can publish your own for the community, or make them private for your own (or your clients') business workflows. There are already a number of plugins available for you to extend your CLI.
General usage guide
Refer to our general usage guide to read more about a variety of CLI features:
Send us feedback
Finally, we’d love to hear from you. Any time you have feedback you’d like to send us, just run:
twilio feedbackNeed some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.