In order to utilize the CLI Docker image, you will need to make sure you haveDocker installed and running on your system. For installation instructions, see theDocker website.

To run the Twilio CLI Docker image with an interactive bash shell, use:

dockerrun-it --rmtwilio/twilio-cli bash

Once the container has finished downloading, and you have entered the shell, you can issue commands using the CLI. For example:

1
$docker run-it --rmtwilio/twilio-cli bash
2
3
root@1234:/twilio#twilio profiles:list
4
IDAccount SID                         Active
5
youACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXtrue
6
mainACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXfalse

It is also possible to pass commands directly to the Docker image for single, contained operations. For example, you can check the running version of the Twilio CLI with the following:

1
$docker run-it --rmtwilio/twilio-cli twilio--version
2
twilio-cli/3.0.0linux-x64 node-v14.18.1

Since the container is cleaned up between each execution, it is useful to pass credentials and configuration directly to the Docker container instead of needing to usetwilio login on each run.

If you have your profile credentials set as environment variables, you can pass them directly to the Docker container. The environment variables will be picked up by the containerized version of the Twilio CLI:

1
$export TWILIO_ACCOUNT_SID=...
2
$export TWILIO_API_KEY=...
3
$export TWILIO_API_SECRET=...
4
$docker run-it --rm \
5
-eTWILIO_ACCOUNT_SID\
6
-eTWILIO_API_KEY\
7
-eTWILIO_API_SECRET\
8
twilio/twilio-cli twilio phone-numbers:list
9
10
SIDPhone Number  Friendly Name
11
PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX+15558675310(555) 867-5310

See theDocker run reference guide for more information about setting container environment variables.

Since the Twilio CLI stores your profile settings on your local file system, it's possible to share those settings with the Docker container by usingVolumes. Your profiles will be inherited by the Docker container, without the need tologin.

To share your local configuration with the Docker container, mount your system's~/.twilio-cli directory to the container at/root/.twilio-cli using the-v flag. See theDocker run reference guide for more information about the-v flag.

1
$docker run-it --rm \
2
-v~/.twilio-cli:/root/.twilio-cli\
3
twilio/twilio-cli twilio phone-numbers:list
4
5
SIDPhone Number  Friendly Name
6
PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX+15558675310(555) 867-5310

1
C:\>docker run-it --rm`
2
-v$env:userprofile\.twilio-cli:/root/.twilio-cli `
3
twilio/twilio-clitwilio phone-numbers:list
4
5
SIDPhone Number  Friendly Name
6
PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX+15558675310(555) 867-5310
7

There are multiple versions of the Twilio CLI Docker image that you can use. To run a specific version, append the desired tag to yourdocker run command.

There are two types of tags:

• latest - Sets the latest version of the Docker image, which we recommend. This is the default behavior of docker run, but you can choose to append it explicitly.

  Copy code block

  dockerrun-it --rmtwilio/twilio-cli:latest bash

• <major.minor.patch> - Sets the container to run using a specific version of the Docker image.

  Copy code block

  dockerrun-it --rmtwilio/twilio-cli:2.36.1 bash

The latest Docker image is only downloaded to your machine on the first execution ofdocker run. You need to manually pull the latest version of subsequent runs if you wish to use an updated image.

To download the latest Docker image and make it available locally, use:

dockerpull twilio/twilio-cli

Now that you have the Twilio CLI Docker image installed and understand its use:

• Experiment with issuing other commands
• Learn about more special features to enhance your developer experience