Twilio CLI Quickstart

The 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. Follow the installation instructions for your specific platform below.

Install Twilio CLI

Login to your Twilio account

In order to access your Twilio account, you need to provide your Twilio credentials to the CLI. This can be done by running this command:

twilio login

You 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 for future use. Visit general usage to learn more about using multiple profiles.

Install CLI autocomplete (bash or zsh only)

If you are running bash or zsh on Mac OS X or Linux, you can run one of the two commands below (as appropriate for the shell you are using):

twilio autocomplete bash

or

twilio autocomplete zsh

Follow the instructions provided to install command auto-complete for the CLI into your shell.

Exploring Twilio CLI

The best way to learn about what you can do with the CLI is to simply run the command:

twilio

When you do, you will get a list of the various topics and commands you can run. Topics are just groupings for more topics and commands, just like the folder structure on your file system.

> twilio
unleash the power of Twilio from your command prompt

VERSION
  twilio-cli/1.3.6 darwin-x64 node-v10.16.0

USAGE
  $ twilio [COMMAND]

COMMANDS
  api            advanced access to all of the Twilio APIs
  autocomplete   display autocomplete installation instructions
  feedback       provide feedback to the CLI team
  help           display help for twilio
  login          add credentials for an existing Twilio profile
  phone-numbers  manage Twilio phone numbers
  plugins        list installed plugins
  profiles       manage credentials for Twilio profile

See something that looks interesting? Just try running it:

twilio api

Since “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:list

If 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 --help

If you type a command, you might get an error if you haven’t provided all of 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:list

Send 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 the CLI, where should you go from here?

Explore plugins

The 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's 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:

More examples

We have a whole page full of examples of the various things you can do with the Twilio CLI.

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 feedback