You are viewing the Japanese site, but your language preference is set to English. Switch to English site →

Menu

Expand
Rate this page:

Twilio CLI Quickstart

BETA

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の利点のひとつは、ターミナルやコマンドプロンプトから、Twilioのリソースを管理できる点です。インストールが完了したら、クイックツアーを始めましょう。お持ちのプラットフォームに応じ、以下の手順に従いインストールしてください。

Twilio CLIをインストールする

One of the easiest ways to install the CLI on macOS is to use Homebrew. If you don't already have it installed, visit the Homebrew site for installation instructions and then return here.

Once Homebrew is installed, simply run the following command to install the CLI:

brew tap twilio/brew && brew install twilio

Updating

If you already installed the CLI with brew and want to upgrade to the latest version, run:

brew upgrade twilio

Warning for Node.js developers

If you have installed Node.js version 10.12 or higher on your Mac, you can avoid potential Node.js version conflicts by installing the CLI using npm:

npm install twilio-cli -g

Before You Begin

Before we can install, we need to make sure you have Node.js installed (version 12.21 or above). To see if you have node installed, try running this command:

node -v

If your system reports v12.21 or above, you can skip the next step.

Installing Node.js on Windows

Using the Windows Installer (.msi) is the recommended way to install Node.js on Windows. You can download the installer from the Node.js download page.

Run PowerShell as an administrator, and type the following command:

Set-ExecutionPolicy Bypass -Scope Process

You should see the following output:

Execution Policy Change
The execution policy helps protect you from scripts that you do not trust. Changing the execution policy might expose
you to the security risks described in the about_Execution_Policies help topic at
https:/go.microsoft.com/fwlink/?LinkID=135170. Do you want to change the execution policy?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

Enter Y to confirm the change.

Note you will have to set this execution policy every time you run PowerShell. See notes on Set-ExecutionPolicy to learn more.

Tested Windows Versions

These instructions have been tested on the following Windows versions:

  • Windows 10 Pro
  • Windows Server 2016

Installing Twilio CLI

The CLI is installed with npm (Node Package Manager), which comes with Node.js. To install the CLI run the following command:

npm install twilio-cli -g

Note the -g option is what installs the command globally so you can run it from anywhere in your system.

Updating

If you already installed the CLI with npm and want to upgrade to the latest version, run:

npm install twilio-cli@latest -g

Before we can install, we need to make sure you have Node.js installed (version 10.12 or above). Even if you already installed Node yourself, the CLI works best when you install it using nvm. Here's how to get nvm installed on most Linux systems:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

Please visit the nvm installation instructions for additional options and troubleshooting steps. Once you have nvm installed, run the following to install and use the most recent LTS release of Node.js:

nvm install --lts
nvm use <insert version reported from above>

Installing other Twilio CLI prerequisites for Linux

Depending on your distribution, you will need to run one of the following commands:

  • Debian/Ubuntu: sudo apt-get install libsecret-1-dev
  • Red Hat-based: sudo yum install libsecret-devel
  • Arch Linux: sudo pacman -S libsecret

Installing Twilio CLI

The CLI is installed with npm (Node Package Manager), which comes with Node.js. To install the CLI run the following command:

npm install twilio-cli -g

Note the -g option is what installs the command globally so you can run it from anywhere in your system.

Updating

If you already installed the CLI with npm and want to upgrade to the latest version, run:

npm install twilio-cli@latest -g

Twilioアカウントへのログイン

Twilioアカウントにアクセスするには、CLIにTwilioの資格情報を送信する必要があります。以下のコマンドを実行してください。

twilio login

コマンド実行後、Account SIDとAuth Tokenの入力が要求されますが、いずれもTwilioコンソールのダッシュボードで確認できます。作成されたAPI Keyは、今後の利用に備えて他人に知られないよう大切に保管してください。プロファイルを複数利用する場合は、Twilio CLI利用ガイドを参照してください。

CLIオートコンプリートのインストール(bash、zshのみ)

bashやzshをmacOS、Linux上で実行している場合、以下のコマンドのいずれかを実行できます(お使いのシェルをご確認ください)。

twilio autocomplete bash

または

twilio autocomplete zsh

インストラクションに従い、ご使用のシェルにCLI用のコマンドオートコンプリートをインストールしてください。

オートコンプリートのインストール手順を完了した後は、必ず再起動するか、新規シェルを開始してください。

Twilio CLIの詳細

以下のコマンドを実行すると、CLIを使用して何ができるかがすぐに分かります。

twilio

このコマンドを実行すると、各種トピックや実行可能なコマンドのリストが表示されます。トピックでは、配下のトピックやコマンドがグループ化され、ファイルシステムのフォルダーのように構成されています。

> 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

気になるものがあれば実行してみましょう。

twilio api

「api」というトピックでは、その中に含まれている別のトピックやコマンドを実際に表示できます。CLIを試す過程で、このコマンドを偶然見つけたとしましょう。

twilio api:core:messages:list

コマンドを実行すると、すべてのSMSメッセージが表示されます。大量のメッセージが表示されるかもしれません。フィルタリングの方法は?そもそも、どのようなオプションがあるのか?答えは、以下のように、コマンドに「--help」を付けることです。

twilio api:core:messages:list --help

コマンドを入力する際、必要なオプションをすべて入力しないとエラーが表示されることがあります。このような場合にも、コマンドに「--help」を付けることで、詳しい情報を表示できます。

電話番号の一覧表示

twilio phone-numbers:list

テキストメッセージの送信

twilio api:core:messages:create \
  --from "+15017122661" \
  --to "+15558675310" \
  --body "I love you 3000"

その他の例

Twilioのページには、さまざまな例があります。

次の手順

以上がCLIについての紹介です。それでは、次の手順をご紹介します。

プラグインを確認する

Twilio CLIの機能拡張には、プラグインを利用します。自作のCLIをコミュニティに公開することや、自社(または自社のクライアント)専用のビジネスワークフローとして非公開にすることもできます。CLIの拡張にご利用いただけるプラグインを多数ご用意しています

Twilio CLI利用ガイド

Twilio CLIをWindowsで実行している場合は、Twilio CLI利用ガイドやトラブルシューティングのヒントでWindows固有のナレッジ記事をご覧ください。

その他の例

Twilio CLI実例集に、その他の利用例をまとめました。ぜひご活用ください。

フィードバックを送る

Twilioではお客様のご意見をお待ちしています。お気付きのことがありましたら、いつでもフィードバックをお送りください。以下のコマンドを実行するだけです。

twilio feedback
Rate this page:

Need 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 Community Forums or browsing the Twilio tag on Stack Overflow.

        
        
        

        Thank you for your feedback!

        We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more